Settings

Account contacts, payout method, notification preferences, verification status and sign out.

<!-- GENERATED FILE. Do not edit by hand. Source: components/help/content/. Run npm run gen:docs. -->

Purpose & Business Context

Settings is the clinic's account control panel. It gathers the operational essentials in one place: who the platform contacts, where escrow payouts land, which events trigger notifications, the clinic's verification standing, and how to sign out.

Commercially the payout and verification sections matter most. Escrow releases flow to the account configured here after each care milestone, and the verified-partner status is the trust marker that lets the clinic transact on the platform.

Screen Overview

A two-up row pairs an Account card (primary contact, editable email and phone, join date) with a column holding a Payouts card and a Verification status card. Below sits a full-width Notification preferences card of toggle switches, then a Sign out card, and finally a Save changes button.

Values seed from the clinic account (primary contact Ravi Kumar, payout account ending 4821, verified partner, joined Mar 2024). Edits live in local state until Save changes confirms with a toast.

Controls & Components

• Account card: a read-only primary contact, editable Contact email and Phone inputs, and the join date.
• Payouts card: the masked bank account that receives escrow releases, plus an Update payout method button (a mock in this demo).
• Verification status card: a status Badge (Verified partner, Verification pending or Draft) with a note that accreditations and licences are on file.
• Notification preferences card: four toggle switches, New patient inquiries, Payout & escrow events, New reviews and Weekly digest.
• Sign out card: a prominent Sign out button that ends the session and returns to the sign-in screen.
• Save changes: confirms preference and contact edits with a toast.

Field Definitions

• Primary contact: The clinic's named account contact (Ravi Kumar), shown read-only.
• Contact email / Phone: Editable contact details the platform uses to reach the clinic.
• Payout account: The masked bank account (for example ending 4821) where escrow releases are paid after each milestone.
• Verification status: The clinic's standing: Verified partner (green), Verification pending (amber) or Draft (gray).
• Notification preference: A per-event toggle controlling which emails the clinic receives: inquiries, payouts, reviews and a weekly digest.
• Joined: When the clinic joined the platform, for example Mar 2024.

User Actions & Workflows

1. Update the contact email and phone if they have changed.
2. Review the payout account; use Update payout method to change where escrow releases land (a mock in this demo).
3. Check the verification status Badge to confirm the clinic is a verified partner.
4. Toggle notification preferences on or off for inquiries, payouts, reviews and the weekly digest.
5. Press Save changes to confirm, or Sign out to end the session on this device.

Navigation & Relationships

Reached from: the sidebar Settings item and the Settings option in the topbar account menu.

Leads to: the sign-in screen (/signin) via the Sign out button, which clears the session.

Relates to: Payments and escrow (the payout account receives milestone releases shown patient-side), the Profile and Onboarding (which lodge the accreditations behind the verification status), and the topbar notifications bell (whose events these preferences govern).

Business Rules & Constraints

• Clinic-only screen; gated by RequireAuth with role "clinic".
• The primary contact is read-only here; only email and phone are editable.
• Update payout method is a mock in the prototype and confirms with a neutral toast rather than changing banking details.
• Notification toggles and contact edits live in local state; Save changes confirms with a toast but does not persist to a backend.
• Sign out clears the auth session (via the auth provider) and redirects to /signin.

Data Dependencies

Seeds from clinicAccount in lib/data (backed by data/clinicAccount.json) for the contact, payout account, status and join date. Sign out calls signOut from the auth provider (lib/auth).

• clinicAccount: contact, payout account, status and joined date
• useAuth().signOut: clears the session on Sign out
• local prefs state: the notification toggles
• useToast: save and payout-update confirmations

Error Handling & Edge Cases

• Status mapping: the verification Badge tone and label are driven by the account status, covering Verified, Pending and Draft.
• Payout safety: the prototype never exposes full banking details; the account is masked and the update is a mock.
• Sign out is immediate; there is no confirmation step in the prototype before redirecting to sign-in.
• Mobile: the paired cards stack into a single column and toggles remain full width.

User Roles & Permissions

• Clinic admin: Manages account contacts, payout method and notification preferences, and can sign out. Payout and account changes are inherently an admin responsibility.
• Clinic staff: Can view settings and sign out, and may adjust their own notification preferences. Changing the payout method and account contacts is an admin-level action in production.
• Patient / other roles: No access; these settings belong to the clinic account only.

Related Features & Functionalities

The escrow and payments model (the payout account receives milestone releases), the Profile and Onboarding screens (which establish verification), the topbar notifications bell (governed by these preferences) and the sign-in screen reached on sign out.

Flow & Screenshots

flowchart LR
  Settings[Settings] --> Account[Account contacts]
  Settings --> Payouts[Payout method]
  Settings --> Verify[Verification status]
  Settings --> Notif[Notification toggles]
  Settings -->|Save changes| Saved[Preferences saved]
  Settings -->|Sign out| SignIn[Sign-in screen]

Guided Walkthrough Steps

The in-app walkthrough for this screen has 6 steps (auto-advances every 5 seconds; Prev / Pause / Next; click outside to exit):

1. Settings ([data-tour="nav.settings"])

Your account, payouts and preferences in one place. You are on the Settings tab now.

1. Account contacts ([data-tour="settings.account"])

Your primary contact is shown here; update the email and phone the platform uses to reach you.

1. Payout method ([data-tour="settings.payouts"])

Escrow releases land in this masked bank account after each milestone. Update payout method is a mock in this demo.

1. Notification preferences ([data-tour="settings.notifications"])

Choose which events email you: new inquiries, payout and escrow events, new reviews and a weekly digest.

1. Sign out ([data-tour="settings.signout"])

End your session on this device. You will be returned to the sign-in screen.

1. Quick access ([data-tour="topbar.account"])

Your avatar sits in the top-right of every console screen. Open it for a quick menu: Settings, your public profile and Log out.