From 8ed514e8d892e9faad3bfcb425969ffc713b2c4d Mon Sep 17 00:00:00 2001 From: Bryce Kalow Date: Fri, 20 Dec 2024 15:27:59 -0600 Subject: [PATCH 1/2] Adds fallback prop to component docs --- docs/components/authentication/sign-in.mdx | 7 +++++++ docs/components/authentication/sign-up.mdx | 7 +++++++ docs/components/organization/create-organization.mdx | 7 +++++++ docs/components/organization/organization-list.mdx | 7 +++++++ docs/components/organization/organization-profile.mdx | 7 +++++++ docs/components/organization/organization-switcher.mdx | 7 +++++++ docs/components/user/user-button.mdx | 7 +++++++ docs/components/user/user-profile.mdx | 8 ++++++++ docs/components/waitlist.mdx | 7 +++++++ 9 files changed, 64 insertions(+) diff --git a/docs/components/authentication/sign-in.mdx b/docs/components/authentication/sign-in.mdx index 6addc5bd39..dcedd93885 100644 --- a/docs/components/authentication/sign-in.mdx +++ b/docs/components/authentication/sign-in.mdx @@ -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 [``](/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. ## Usage with frameworks diff --git a/docs/components/authentication/sign-up.mdx b/docs/components/authentication/sign-up.mdx index 4f80641e35..e614cc7e5c 100644 --- a/docs/components/authentication/sign-up.mdx +++ b/docs/components/authentication/sign-up.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/organization/create-organization.mdx b/docs/components/organization/create-organization.mdx index c32e40a38f..bacde6cb9f 100644 --- a/docs/components/organization/create-organization.mdx +++ b/docs/components/organization/create-organization.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/organization/organization-list.mdx b/docs/components/organization/organization-list.mdx index d97d8cf159..e17f8488e3 100644 --- a/docs/components/organization/organization-list.mdx +++ b/docs/components/organization/organization-list.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/organization/organization-profile.mdx b/docs/components/organization/organization-profile.mdx index 9dc549275b..93a0bc24a8 100644 --- a/docs/components/organization/organization-profile.mdx +++ b/docs/components/organization/organization-profile.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/organization/organization-switcher.mdx b/docs/components/organization/organization-switcher.mdx index 0edcfc5b1c..073df4e1d5 100644 --- a/docs/components/organization/organization-switcher.mdx +++ b/docs/components/organization/organization-switcher.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/user/user-button.mdx b/docs/components/user/user-button.mdx index 3b7811ee1c..e7804b5e1d 100644 --- a/docs/components/user/user-button.mdx +++ b/docs/components/user/user-button.mdx @@ -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. ## Usage with frameworks diff --git a/docs/components/user/user-profile.mdx b/docs/components/user/user-profile.mdx index 6c9f17b42d..e2ce4b27fb 100644 --- a/docs/components/user/user-profile.mdx +++ b/docs/components/user/user-profile.mdx @@ -11,6 +11,7 @@ The `` component is used to render a beautiful, full-featured acc All props are optional. + - `appearance` - [Appearance](/docs/customization/overview) | undefined @@ -44,6 +45,13 @@ All props are optional. - [CustomPage](/docs/references/javascript/types/custom-page)\[] 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. ## Usage with frameworks diff --git a/docs/components/waitlist.mdx b/docs/components/waitlist.mdx index e558b24b8e..d2785a67c7 100644 --- a/docs/components/waitlist.mdx +++ b/docs/components/waitlist.mdx @@ -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. ## Usage with frameworks From 26e1b1bfaa7f37d9073b2349338efd5817789774 Mon Sep 17 00:00:00 2001 From: Bryce Kalow Date: Fri, 20 Dec 2024 15:59:41 -0600 Subject: [PATCH 2/2] formatting --- docs/components/authentication/sign-in.mdx | 2 +- docs/components/authentication/sign-up.mdx | 2 +- docs/components/organization/create-organization.mdx | 2 +- docs/components/organization/organization-list.mdx | 2 +- docs/components/organization/organization-profile.mdx | 2 +- docs/components/organization/organization-switcher.mdx | 2 +- docs/components/user/user-button.mdx | 2 +- docs/components/user/user-profile.mdx | 3 +-- docs/components/waitlist.mdx | 2 +- 9 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/components/authentication/sign-in.mdx b/docs/components/authentication/sign-in.mdx index dcedd93885..23fd487615 100644 --- a/docs/components/authentication/sign-in.mdx +++ b/docs/components/authentication/sign-in.mdx @@ -92,7 +92,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/authentication/sign-up.mdx b/docs/components/authentication/sign-up.mdx index e614cc7e5c..c4179ac72d 100644 --- a/docs/components/authentication/sign-up.mdx +++ b/docs/components/authentication/sign-up.mdx @@ -85,7 +85,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/organization/create-organization.mdx b/docs/components/organization/create-organization.mdx index bacde6cb9f..59fbc6e006 100644 --- a/docs/components/organization/create-organization.mdx +++ b/docs/components/organization/create-organization.mdx @@ -54,7 +54,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/organization/organization-list.mdx b/docs/components/organization/organization-list.mdx index e17f8488e3..e6488da233 100644 --- a/docs/components/organization/organization-list.mdx +++ b/docs/components/organization/organization-list.mdx @@ -61,7 +61,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/organization/organization-profile.mdx b/docs/components/organization/organization-profile.mdx index 93a0bc24a8..87fc688e18 100644 --- a/docs/components/organization/organization-profile.mdx +++ b/docs/components/organization/organization-profile.mdx @@ -51,7 +51,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/organization/organization-switcher.mdx b/docs/components/organization/organization-switcher.mdx index 073df4e1d5..505ac2446e 100644 --- a/docs/components/organization/organization-switcher.mdx +++ b/docs/components/organization/organization-switcher.mdx @@ -100,7 +100,7 @@ All props below are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/user/user-button.mdx b/docs/components/user/user-button.mdx index e7804b5e1d..6771014ded 100644 --- a/docs/components/user/user-button.mdx +++ b/docs/components/user/user-button.mdx @@ -84,7 +84,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/user/user-profile.mdx b/docs/components/user/user-profile.mdx index e2ce4b27fb..82570040f2 100644 --- a/docs/components/user/user-profile.mdx +++ b/docs/components/user/user-profile.mdx @@ -11,7 +11,6 @@ The `` component is used to render a beautiful, full-featured acc All props are optional. - - `appearance` - [Appearance](/docs/customization/overview) | undefined @@ -48,7 +47,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting. diff --git a/docs/components/waitlist.mdx b/docs/components/waitlist.mdx index d2785a67c7..55caa6d91a 100644 --- a/docs/components/waitlist.mdx +++ b/docs/components/waitlist.mdx @@ -45,7 +45,7 @@ All props are optional. --- - - `fallback?` + - `fallback?` - `ReactNode` An optional element to be rendered while the component is mounting.