feat(ui): Reverification flow block #9605
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| --- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import * as FlowStories from './flow.component.stories'; | ||
|
|
||
| # Flow | ||
|
|
||
| `Flow` is a controlled Mosaic screen compositor. It treats `state` as opaque, renders the `Flow.Step` whose `ids` contain its `value`, and keeps the outgoing and incoming steps mounted for transitions. | ||
|
|
||
| ## Example | ||
|
|
||
| <Story | ||
| name='Default' | ||
| storyModule={FlowStories} | ||
| /> | ||
|
|
||
| ## Usage | ||
|
Comment on lines
+7
to
+14
Contributor
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Restore the required story sections and order. This page uses 🤖 Prompt for AI AgentsSource: Path instructions |
||
|
|
||
| ```tsx | ||
| import { Card } from '@clerk/ui/mosaic/components/card'; | ||
| import { Flow } from '@clerk/ui/mosaic/components/flow'; | ||
|
|
||
| <Flow.Root | ||
| render={<Card.Root />} | ||
| value={model.status} | ||
| direction={model.direction} | ||
| state={model} | ||
| > | ||
| {current => ( | ||
| <> | ||
| <Flow.Step ids={['details', 'details-pending']}> | ||
| <DetailsView {...current.details} /> | ||
| </Flow.Step> | ||
| <Flow.Step ids={['confirm']}> | ||
| <ConfirmationView {...current.confirmation} /> | ||
| </Flow.Step> | ||
| </> | ||
| )} | ||
| </Flow.Root> | ||
| ``` | ||
|
|
||
| ## Parts | ||
|
|
||
| | Part | Class | Description | | ||
| | ----------- | --------------- | ------------------------------------------------------------- | | ||
| | `Flow.Root` | `.cl-flow-root` | Receives the controlled value and opaque state. | | ||
| | `Flow.Step` | `.cl-flow-step` | Renders when its `ids` include the root's controlled `value`. | | ||
|
|
||
| ## Styling | ||
|
|
||
| `Flow.Root` reflects its controlled value through `data-value`. The active `Flow.Step` carries `data-open` and reflects the first grouped id through `data-step`; an outgoing step carries `data-closed` until its transition finishes. Both parts accept `className`, `style`, and the Mosaic `render` prop. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { Button } from '@clerk/ui/mosaic/components/button'; | ||
| import { Card } from '@clerk/ui/mosaic/components/card'; | ||
| import { Flow, type FlowDirection } from '@clerk/ui/mosaic/components/flow'; | ||
| import { useState } from 'react'; | ||
|
|
||
| import type { StoryMeta } from '@/lib/types'; | ||
|
|
||
| export { default as __source } from './flow.component.stories?raw'; | ||
|
|
||
| export const meta: StoryMeta = { | ||
| group: 'Components', | ||
| title: 'Flow', | ||
| source: 'packages/ui/src/mosaic/components/flow/flow.tsx', | ||
| }; | ||
|
|
||
| export function Default(): JSX.Element { | ||
| const [step, setStep] = useState('details'); | ||
| const [direction, setDirection] = useState<FlowDirection>(1); | ||
|
|
||
| const navigate = (nextStep: string, nextDirection: FlowDirection) => { | ||
| setDirection(nextDirection); | ||
| setStep(nextStep); | ||
| }; | ||
|
|
||
| return ( | ||
| <Flow.Root | ||
| render={<Card.Root />} | ||
| value={step} | ||
| direction={direction} | ||
| state={{ step }} | ||
| > | ||
| {state => ( | ||
| <> | ||
| <Flow.Step ids={['details', 'details-pending']}> | ||
| <Card.Header> | ||
| <Card.Title>Account details</Card.Title> | ||
| <Card.Description>Current controller state: {state.step}</Card.Description> | ||
| </Card.Header> | ||
| <Card.Footer> | ||
| <Button | ||
| fullWidth | ||
| onClick={() => navigate('confirm', 1)} | ||
| > | ||
| Continue | ||
| </Button> | ||
| </Card.Footer> | ||
| </Flow.Step> | ||
| <Flow.Step ids={['confirm']}> | ||
| <Card.Header> | ||
| <Card.Title>Confirm changes</Card.Title> | ||
| <Card.Description>Review the final step before submitting.</Card.Description> | ||
| </Card.Header> | ||
| <Card.Footer> | ||
| <Button | ||
| fullWidth | ||
| variant='outline' | ||
| color='neutral' | ||
| onClick={() => navigate('details', -1)} | ||
| > | ||
| Back | ||
| </Button> | ||
| <Button fullWidth>Submit</Button> | ||
| </Card.Footer> | ||
| </Flow.Step> | ||
| </> | ||
| )} | ||
| </Flow.Root> | ||
| ); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Add a package release entry.
Lines 1-2 define an empty Changeset. It produces no version bump or changelog entry. The new public Flow and Reverification APIs will not ship to package consumers. Add the affected package, its intended semver bump, and a concise release summary.
As per coding guidelines, “Use Changesets for version management and changelogs.”
🤖 Prompt for AI Agents
Source: Coding guidelines