Skip to main content

Companies

Introduction​

This guide explains how to use the Companies page in My Home Plan to search, add, edit, and delete company records.

Accessing the Page​

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

Navigating the Page​

  • Breadcrumbs: Shows the current location as Companies.
  • Add Company: Button at the top-left to create a new company (opens a modal).
  • Search Bar: Filter companies by name or email (debounced ~500ms).
  • Clear Filters: Resets the search query to show all results.
  • Loading Indicator: A spinner appears while results are being fetched.
  • Table Columns:
    • Name — company name.
    • Status — Active or Inactive.
    • Created At — relative time since creation (e.g., “3 hours ago”).
    • Actions — Edit and Delete.
  • Modals:
    • Add/Edit Company — modal with a form for name and active status.
    • Delete Company — confirmation dialog before deletion.

Key Features​

  • Live Search: Type a query to filter companies by name or email.
  • Create & Edit: Add new companies or edit existing ones via a modal form.
  • Validation: Company Name must be at least 4 characters.
  • Activation Toggle: Mark a company as Active/Inactive.
  • Safe Deletion: Deleting a company requires confirmation in a modal.
  • User Feedback: Inline error banners display API errors; a spinner shows loading.
  • Dark Mode Friendly: The page supports dark theme styling.

Common Tasks​

  1. Add a Company
    • Click Add Company.
    • Enter Name and set Active if needed.
    • Click Save to create the record.
  2. Edit a Company
    • Click Edit in the Actions column for a row.
    • Update fields and click Save.
  3. Delete a Company
    • Click Delete in the Actions column.
    • Confirm in the Delete Company modal.
  4. Search Companies
    • Enter a term (name or email) in the search bar.
    • Click Clear filters to reset the search.

Troubleshooting​

  • No Results?
    • Clear the search query and try again.
  • Error Banner Appears (red box)
    • The message comes from the API. Try again or contact support if it persists.
  • Cannot Save Company?
    • Ensure the Name has at least 4 characters.
  • Spinner Keeps Spinning
    • Check your internet connection and retry.

Contact Support​

Reach out via: