Skip to content

Commit

Permalink
Adds fallback prop to component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BRKalow committed Dec 20, 2024
1 parent 27ac5ce commit 8ed514e
Show file tree
Hide file tree
Showing 9 changed files with 64 additions and 0 deletions.
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
8 changes: 8 additions & 0 deletions docs/components/user/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The `<UserProfile />` component is used to render a beautiful, full-featured acc

All props are optional.


<Properties>
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>
Expand Down Expand Up @@ -44,6 +45,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

0 comments on commit 8ed514e

Please sign in to comment.