Settings

Notification channels, security and account actions.

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

Purpose & Business Context

Settings is where the patient controls how the platform reaches them and how their account is secured. In medical travel, timely alerts about visas, documents and payments are essential, so giving the patient explicit control over channels (email, SMS, WhatsApp) builds both usefulness and trust.

It also houses the security and account controls, two-factor authentication, password changes, and sign-out, that let a patient feel safe storing sensitive medical and financial information on the platform.

Screen Overview

A two-column layout. The left column is a Notifications card with toggles per channel and a Save preferences button. The right column stacks a Security card (two-factor toggle, change password, sign out other devices), a Language & region note, and an Account card (sign out, close account).

Controls & Components

• Notifications card: toggles for Email updates, SMS alerts, WhatsApp messages, Visa & document alerts, Payment & escrow alerts, and Marketing & offers, plus Save preferences.
• Security card: a Two-factor authentication toggle, a Change password button and a Sign out other devices button.
• Language & region card: a read-only note that the interface is English and interpreters are arranged via the Care Plan.
• Account card: Sign out and Close account actions (the latter directs the patient to their coordinator).

Field Definitions

• Email updates / SMS alerts / WhatsApp messages: Channel toggles controlling where notifications are delivered.
• Visa & document alerts: Toggle for alerts about visa status and document actions.
• Payment & escrow alerts: Toggle for alerts about charges, releases and escrow.
• Marketing & offers: Optional promotional messages; off by default.
• Two-factor authentication: A security toggle adding a second sign-in factor; on by default.

User Actions & Workflows

1. Toggle the notification channels and categories you want.
2. Press Save preferences to confirm; a toast acknowledges the change.
3. Adjust Two-factor authentication, or use Change password / Sign out other devices in Security.
4. Read the language note to understand interpreter support.
5. Use Sign out, or Close account (which routes you to your coordinator), from the Account card.

Navigation & Relationships

Reached from: the Account header and footer links, and the data-protection notes elsewhere in the portal.

Leads to: the sign-in screen on Sign out.

Complements: Account (profile and contact details) and Notifications (the actual alert feed the channels here govern).

Business Rules & Constraints

• Marketing & offers is off by default; transactional categories (visa, payment) default on.
• All toggles and security actions are prototype-level: they update local state and confirm with toasts.
• Closing the account is not self-service; it directs the patient to their coordinator.
• Interface language is English; interpreters are arranged as a service shown on the Care Plan.
• Patient-only screen within the portal.

Data Dependencies

Holds preference and two-factor state in local component state (no backing data file). Uses useAuth().signOut for sign-out. In production these preferences would persist to a profile service.

• local prefs state: channel and category toggles
• local twoFA state: two-factor toggle
• useAuth(): sign-out handling

Error Handling & Edge Cases

• Saving preferences always succeeds in the prototype and confirms with a toast.
• Security actions (password reset, signing out other devices) confirm via toast rather than performing real operations here.
• Close account does not delete anything; it points the patient to their coordinator.
• Mobile: the two columns stack so Notifications stays at the top.

User Roles & Permissions

• Patient: Can set notification preferences, toggle two-factor, change password, sign out (here and other devices), and request account closure.
• Support / coordinator (out of scope here): Handles account closure and any escalations the patient initiates.

Related Features & Functionalities

Account (profile), Notifications (the feed governed by these channels), the Care Plan (where interpreters appear), and the security messaging echoed across the app. Sign-out ties into the shared auth flow.

Flow & Screenshots

flowchart LR
  Settings[Settings] --> Notif[Notifications preferences]
  Notif -->|Save| Saved[Preferences saved]
  Settings --> Security[Security]
  Security --> TwoFA[Two-factor / password]
  Settings --> Lang[Language & region]
  Settings --> Account[Account actions]
  Account -->|Sign out| SignIn[Sign in]

Guided Walkthrough Steps

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

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

Choose how we reach you: email, SMS, WhatsApp, plus categories like visa, document and payment alerts. Press Save preferences to apply.

1. Security ([data-tour="settings.security"])

Toggle two-factor authentication, change your password, or sign out of other devices, all from here.

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

Sign out, or request to close your account. Closing your account routes you to your coordinator.

1. See your alerts ([data-tour="topbar.notifications"])

The bell at the top shows the notifications these channels govern. Open it any time to review what is new.