File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ---
2+ title : ForgotPassword
3+ ---
4+
5+ # ForgotPassword
6+
7+ A component for handling the forgot password flow. It displays different views based on the user's state and form submission.
8+
9+ ## Parameters
10+
11+ - ` fullPage ` (optional): ` boolean ` - Determines if the component should be displayed full-page. Default is ` false ` .
12+
13+ ## Example
14+
15+ ``` tsx
16+ import { ForgotPassword } from ' @stackframe/stack' ;
17+
18+ // Basic usage
19+ <ForgotPassword />
20+
21+ // Full-page display
22+ <ForgotPassword fullPage = { true } />
23+ ```
24+
25+ ## Component Behavior
26+
27+ - If a user is signed in, it displays a predefined 'signedIn' message.
28+ - After submitting the form, it shows a predefined 'emailSent' message.
29+ - Otherwise, it renders a password reset form with a link to sign in.
30+
31+ The component uses internal state and Stack SDK hooks (` useStackApp ` and ` useUser ` ) to manage its behavior and routing.
You can’t perform that action at this time.
0 commit comments