Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(elements): Add docs for FieldState config field #1330

Merged
merged 5 commits into from
Aug 5, 2024
Merged

docs(elements): Add docs for FieldState config field #1330

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e1736d
docs(elements): Add docs for config field
dstaley Jul 25, 2024
88be133
chore(docs): Add example config usage
dstaley Jul 25, 2024
76b414e
docs(elements): Update docs for new error code tuple format
dstaley Aug 5, 2024
048dc3c
fix(elements): Escape pipe character
dstaley Aug 5, 2024
043cd2e
fix(elements): Escape pipe character
dstaley Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/elements/reference/common.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ If you use `<Input type="password" validatePassword>`, additional information in

| Name | Type | Description |
| - | - | - |
| `children` | `(args: { state: 'success' \| 'error' \| 'warning' \| 'info' \| 'idle'; message: string \| undefined; codes: ErrorMessageKey[] \| undefined }) => React.ReactNode` | Use this function to access the field's state. Optionally, information regarding password validation is given. |
| `children` | `(args: { state: 'success' \| 'error' \| 'warning' \| 'info' \| 'idle'; message: string \| undefined; codes: (string \| [string, Record<string, string \| number>])[] \| undefined }) => React.ReactNode` | Use this function to access the field's state. Optionally, information regarding password validation is given. |

### Usage {{ toc: false }}

Expand All @@ -137,8 +137,10 @@ If you use `<Input type="password" validatePassword>`, additional information in

If you're using [`<Input type="password" validatePassword>`](#input-type-password), the `<FieldState>`'s children function receives additional arguments:

- `message` - The standardized English message generated for the current state of the input. This message is generated based on the codes associated with the `<FieldState>`.
- `codes` - The codes associated with the `<FieldState>`. You can use these codes to return custom `message` or localize its contents.
| Name | Type | Description |
| - | - | - |
| `message` | `string` | The standardized English message generated for the current state of the input. This message is generated based on the codes associated with the `<FieldState>`. |
| `codes` | `(string \| [string, Record<string, string \| number>])[]` | The error codes associated with the `<FieldState>`. You can use these codes to return a custom `message` or localize its contents. |

Initially, the `<Input>` will have a `state` of `idle` until the user interacts with the input. Depending on the user's input, the `state` will change to `'success' | 'error' | 'warning' | 'info'`.

Expand All @@ -151,7 +153,7 @@ Initially, the `<Input>` will have a `state` of `idle` until the user interacts
<div>
<pre>Field state: {state}</pre>
<pre>Field msg: {message}</pre>
<pre>Codes: {codes?.join(', ')}</pre>
<pre>Codes: {JSON.stringify(codes, null, 2)}</pre>
</div>
)}
</Clerk.FieldState>
Expand Down
Loading