Skip to main content

Users View Page

Introduction​

This guide explains how to use the Users page in My Home Plan to search, add, edit, and delete users, and to filter by access level.

Accessing the Page​

  1. From the left sidebar, click Users.
  2. You will be directed to the Users list.

Navigating the Page​

  • Breadcrumbs: Shows the current location as Users.
  • Add user: Button at the top-left to create a new user (opens a modal).
  • Filters:
    • Role (Select): Filter by Admin, Finance, or Sales (or show All roles).
    • Search (Text): Filter by user name or email (debounced ~500ms).
    • Clear filters: Resets both role and search query.
  • Loading Indicator: A spinner appears while results are being fetched.
  • Error Banner: A red alert box displays API errors when they occur.
  • Users Table:
    • Name — Clickable link to the user details page (/users/{id}).
    • Email — User’s email address.
    • Access Level — Role of the user (e.g., admin, finance, sales).
    • Actions — Edit and Delete buttons.
  • Modals:
    • Add/Edit User — Form for creating or updating a user.
    • Delete User — Confirmation dialog before deletion.

Key Features​

  • Role-Based Filtering: Narrow the list by access level using the role selector.
  • Live Search: Type to filter by name or email (debounced to reduce requests).
  • Create & Edit: Add new users or edit existing users via a modal form.
  • Safe Deletion: Deleting a user requires confirmation in a modal.
  • Deep Links: Click a user’s Name to open their details page.
  • User Feedback: Inline error banner appears for API errors; a spinner indicates loading.
  • Dark Mode Friendly: The page supports dark theme styling.

Common Tasks​

  1. Add a User
    • Click Add user.
    • Fill in the required fields in the modal and click Save.
  2. Edit a User
    • Click Edit in the Actions column for the corresponding row.
    • Update fields and click Save.
  3. Delete a User
    • Click Delete in the Actions column.
    • Confirm in the Delete user modal.
  4. Filter by Role
    • Choose Admin, Finance, or Sales from the Role dropdown.
  5. Search by Name or Email
    • Enter a term in the search box. Results update after a short delay.
  6. Clear Filters
    • Click Clear filters to reset both role and search text.

Troubleshooting​

  • No Results?
    • Clear the search query and set Role to All roles.
  • Error Banner Appears (red box)
    • The message comes from the API. Try again or contact support if it persists.
  • Spinner Keeps Spinning
    • Check your internet connection and retry.
  • Cannot Open User Details?
    • Ensure you have permission and that the user record still exists.

Contact Support​

Reach out via: