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.

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

feat: Adds fallback prop to component docs #1835

Merged
merged 3 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/components/authentication/sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ All props are optional.
- `string`

Full URL or path to the waitlist page. Use this property to provide the target of the 'Waitlist' link that's rendered. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/customization/account-portal/overview#waitlist). If you've passed the `waitlistUrl` prop to the [`<ClerkProvider>`](/docs/components/clerk-provider) component, it will infer from that, and you can omit this prop.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/authentication/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ All props are optional.
- [`SignUpUnsafeMetadata`](/docs/references/javascript/types/metadata#sign-up-unsafe-metadata)

Metadata that can be read and set from the frontend and the backend. Once the sign-up is complete, the value of this field will be automatically copied to the created user's unsafe metadata (`User.unsafeMetadata`). One common use case is to collect custom information about the user during the sign-up process and store it in this property. Read more about [unsafe metadata](/docs/users/metadata#unsafe-metadata).

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/organization/create-organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ All props are optional.
- `boolean`

Hides the optional slug field in the organization creation screen.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/organization/organization-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ All props are optional.
- `boolean`

Hides the optional slug field in the organization creation screen.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/organization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ All props are optional.
- `CustomPages[]`

An array of custom pages to add to the organization profile. Only available for the [JavaScript SDK](/docs/references/javascript/overview). To add custom pages with React-based SDK's, see the [dedicated guide](/docs/customization/organization-profile).

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/organization/organization-switcher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ All props below are optional.
- `boolean`

Hides the optional slug field in the organization creation screen.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/user/user-button.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,13 @@ All props are optional.
- `string`

The full URL or path leading to the user management interface.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/user/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ All props are optional.
- <code>[CustomPage](/docs/references/javascript/types/custom-page)\[]</code>

An array of custom pages to add to the user profile. Only available for the [JavaScript SDK](/docs/references/javascript/overview). To add custom pages with React-based SDK's, see the [dedicated guide](/docs/customization/user-profile).

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
7 changes: 7 additions & 0 deletions docs/components/waitlist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ All props are optional.
- `string`

Full URL or path to the sign in page. Use this property to provide the target of the 'Sign In' link that's rendered. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.

---

- `fallback?`
- `ReactNode`

An optional element to be rendered while the component is mounting.
</Properties>

## Usage with frameworks
Expand Down
Loading