From 47922cf5922ddd2540254efa0f905831d230c053 Mon Sep 17 00:00:00 2001 From: vi Date: Tue, 29 Oct 2024 16:54:07 +0100 Subject: [PATCH] pre-built -> prebuilt --- CONTRIBUTING.md | 6 +++--- docs/authentication/configuration/session-options.mdx | 2 +- .../account-portal/disable-account-portal.mdx | 2 +- docs/customization/elements/examples/sign-in.mdx | 2 +- docs/customization/elements/examples/sign-up.mdx | 2 +- docs/customization/overview.mdx | 8 ++++---- docs/customization/themes.mdx | 4 ++-- docs/guides/authjs-migration.mdx | 2 +- docs/index.mdx | 2 +- docs/organizations/roles-permissions.mdx | 2 +- docs/references/astro/sign-in-store.mdx | 2 +- docs/references/astro/sign-up-store.mdx | 2 +- docs/references/react/overview.mdx | 2 +- docs/references/react/use-sign-in.mdx | 2 +- docs/references/react/use-sign-up.mdx | 2 +- docs/references/sdk/philosophy.mdx | 2 +- docs/upgrade-guides/progressive-sign-up.mdx | 2 +- 17 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2532b38834..868c09821d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -580,7 +580,7 @@ The `` component can be used to display a grid of cards in various styles --- - [UI Components](/docs/components/overview) -- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes. +- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes. ``` @@ -602,7 +602,7 @@ The `` component can be used to display a grid of cards in various styles --- - [UI Components](/docs/components/overview) -- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes. +- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes. - {{/* */}} @@ -625,7 +625,7 @@ The `` component can be used to display a grid of cards in various styles --- - [UI Components](/docs/components/overview) -- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes. +- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes. - {{/* */}} diff --git a/docs/authentication/configuration/session-options.mdx b/docs/authentication/configuration/session-options.mdx index 29e468ecdf..08e766d58d 100644 --- a/docs/authentication/configuration/session-options.mdx +++ b/docs/authentication/configuration/session-options.mdx @@ -56,7 +56,7 @@ To enable multi-session in your application, you need to configure it in the Cle There are two main ways to add the multi-session feature to your application: -- Use the [``](/docs/components/user/user-button) component if you want to use Clerk's pre-built UI. +- Use the [``](/docs/components/user/user-button) component if you want to use Clerk's prebuilt UI. - [Build a custom flow](/docs/custom-flows/multi-session-applications) if you want to rebuild the existing Clerk flow using the Clerk API. ## Customize session token diff --git a/docs/customization/account-portal/disable-account-portal.mdx b/docs/customization/account-portal/disable-account-portal.mdx index 1723e0e3f0..9fa62c19e6 100644 --- a/docs/customization/account-portal/disable-account-portal.mdx +++ b/docs/customization/account-portal/disable-account-portal.mdx @@ -15,4 +15,4 @@ To disable the Account Portal: ## Customizing your sign-up/sign-in flow -If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [pre-built components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview). +If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [prebuilt components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview). diff --git a/docs/customization/elements/examples/sign-in.mdx b/docs/customization/elements/examples/sign-in.mdx index ba8560b300..e40e23c83b 100644 --- a/docs/customization/elements/examples/sign-in.mdx +++ b/docs/customization/elements/examples/sign-in.mdx @@ -1,6 +1,6 @@ --- title: Sign-in -description: Examples of pre-built sign-in flows with Clerk Elements. +description: Examples of prebuilt sign-in flows with Clerk Elements. --- ## Username/password diff --git a/docs/customization/elements/examples/sign-up.mdx b/docs/customization/elements/examples/sign-up.mdx index 885049f2e7..071eabfc08 100644 --- a/docs/customization/elements/examples/sign-up.mdx +++ b/docs/customization/elements/examples/sign-up.mdx @@ -1,6 +1,6 @@ --- title: Sign-up -description: Examples of pre-built sign-up flows with Clerk Elements. +description: Examples of prebuilt sign-up flows with Clerk Elements. --- ## Email/password + email verification diff --git a/docs/customization/overview.mdx b/docs/customization/overview.mdx index 5400c898bb..18f8111408 100644 --- a/docs/customization/overview.mdx +++ b/docs/customization/overview.mdx @@ -43,9 +43,9 @@ The `appearance` prop accepts the following properties: Fine-grained theme overrides. Useful when you want to style specific elements or elements that are under a specific state. For more information, see the [Customize elements of a Clerk component](#customize-elements-of-a-clerk-component) section. -## Using a pre-built theme +## Using a prebuilt theme -Clerk offers a set of pre-built themes that can be used to quickly style Clerk components. See the [Themes](/docs/customization/themes) docs for more information. +Clerk offers a set of prebuilt themes that can be used to quickly style Clerk components. See the [Themes](/docs/customization/themes) docs for more information. ## Customize the layout @@ -374,8 +374,8 @@ Here are a few resources you can utilize to customize your Clerk components furt --- - - [Pre-built themes](/docs/customization/themes) - - Explore Clerk's pre-built themes that you can use to quickly style your Clerk components. + - [prebuilt themes](/docs/customization/themes) + - Explore Clerk's prebuilt themes that you can use to quickly style your Clerk components. --- diff --git a/docs/customization/themes.mdx b/docs/customization/themes.mdx index 3e306518c0..c3f349be29 100644 --- a/docs/customization/themes.mdx +++ b/docs/customization/themes.mdx @@ -1,9 +1,9 @@ --- title: Themes -description: Clerk currently offers four pre-built themes for you to customize the overall appearance of your Clerk app. +description: Clerk currently offers four prebuilt themes for you to customize the overall appearance of your Clerk app. --- -Clerk currently offers four pre-built themes: +Clerk currently offers four prebuilt themes: - [The default theme](#default-theme) - [The "Dark" theme](#dark-theme) diff --git a/docs/guides/authjs-migration.mdx b/docs/guides/authjs-migration.mdx index 19d1cdaf51..98caa74756 100644 --- a/docs/guides/authjs-migration.mdx +++ b/docs/guides/authjs-migration.mdx @@ -114,7 +114,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. If Clerk's Account Portal pages aren't a good fit your app, you can build a custom sign-in and sign-up UI in one of two ways: - - use Clerk's [pre-built components](/docs/references/nextjs/custom-signup-signin-pages), such as the [``](/docs/components/authentication/sign-in) and [``](/docs/components/authentication/sign-up) components + - use Clerk's [prebuilt components](/docs/references/nextjs/custom-signup-signin-pages), such as the [``](/docs/components/authentication/sign-in) and [``](/docs/components/authentication/sign-up) components - build a [fully custom UI using Clerk's API](/docs/custom-flows/overview), leveraging Clerk's React hooks such as [`useSignIn()`](/docs/references/react/use-sign-in) and [`useSignUp()`](/docs/references/react/use-sign-up) ### Protect your app diff --git a/docs/index.mdx b/docs/index.mdx index 43677bd668..ab959fb7b0 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -14,7 +14,7 @@ Find all the guides and resources you need to develop with Clerk. --- - [UI Components](/docs/components/overview) - - Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes. + - Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes. - {} --- diff --git a/docs/organizations/roles-permissions.mdx b/docs/organizations/roles-permissions.mdx index bd840396ef..1c7057246c 100644 --- a/docs/organizations/roles-permissions.mdx +++ b/docs/organizations/roles-permissions.mdx @@ -74,6 +74,6 @@ To learn more about creating custom permissions, see the [Create roles and permi ## Next steps - [Learn how to create roles and permissions in the Clerk Dashboard](/docs/organizations/create-roles-permissions) -- [Learn how to use roles and permissions to limit the content a user can see with Clerk's pre-built `` component](/docs/components/protect) +- [Learn how to use roles and permissions to limit the content a user can see with Clerk's prebuilt `` component](/docs/components/protect) - [Learn how to allow and limit access to resources by role and permissions](/docs/organizations/verify-user-permissions) - [Learn how to reassign the **Creator** role](/docs/organizations/creator-role) diff --git a/docs/references/astro/sign-in-store.mdx b/docs/references/astro/sign-in-store.mdx index 66eb0caf18..179d386d94 100644 --- a/docs/references/astro/sign-in-store.mdx +++ b/docs/references/astro/sign-in-store.mdx @@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignIn` resource are liste ### Create a custom sign-in flow -The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview) +The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview) diff --git a/docs/references/astro/sign-up-store.mdx b/docs/references/astro/sign-up-store.mdx index c3c0eb6890..6eb850e8b0 100644 --- a/docs/references/astro/sign-up-store.mdx +++ b/docs/references/astro/sign-up-store.mdx @@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignUp` resource are liste ### Create a custom sign-up flow -The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview) +The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview) diff --git a/docs/references/react/overview.mdx b/docs/references/react/overview.mdx index 3c89e9ecb4..6e14f6f9f6 100644 --- a/docs/references/react/overview.mdx +++ b/docs/references/react/overview.mdx @@ -8,7 +8,7 @@ Clerk React is a wrapper around ClerkJS. It is the recommended way to integrate > [!WARNING] > If you are using Next.js, please make sure to install `@clerk/nextjs` as `@clerk/clerk-react` is incompatible. See the [Next.js](/docs/references/nextjs/overview) documentation for more information. -Clerk React provides React.js implementations of [Clerk components](/docs/components/overview); highly customizable, pre-built components that you can use to build beautiful user management applications. You can find display components for building [sign-in](/docs/components/authentication/sign-in), [sign-up](/docs/components/authentication/sign-up), [account switching](/docs/components/user/user-button), and [user profile management](/docs/components/user/user-profile) pages as well as flow [control components](/docs/components/control/signed-in) that act as helpers for implementing a seamless authentication experience. +Clerk React provides React.js implementations of [Clerk components](/docs/components/overview); highly customizable, prebuilt components that you can use to build beautiful user management applications. You can find display components for building [sign-in](/docs/components/authentication/sign-in), [sign-up](/docs/components/authentication/sign-up), [account switching](/docs/components/user/user-button), and [user profile management](/docs/components/user/user-profile) pages as well as flow [control components](/docs/components/control/signed-in) that act as helpers for implementing a seamless authentication experience. Clerk React comes loaded with [custom hooks](/docs/references/react/use-user). These hooks give you access to the [Clerk object](/docs/references/javascript/clerk/clerk), and a set of useful helper methods for signing in and signing up. diff --git a/docs/references/react/use-sign-in.mdx b/docs/references/react/use-sign-in.mdx index d081d30782..2d8cfe4c4a 100644 --- a/docs/references/react/use-sign-in.mdx +++ b/docs/references/react/use-sign-in.mdx @@ -84,4 +84,4 @@ The `status` property of the `SignIn` object can be one of the following values: ### Create a custom sign-in flow with `useSignIn()` -The `useSignIn()` hook can also be used to build fully custom sign-in flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignIn()` hook to create custom flows, check out the [custom flow guides](/docs/custom-flows/overview). +The `useSignIn()` hook can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignIn()` hook to create custom flows, check out the [custom flow guides](/docs/custom-flows/overview). diff --git a/docs/references/react/use-sign-up.mdx b/docs/references/react/use-sign-up.mdx index e94cb23e09..00a7b85240 100644 --- a/docs/references/react/use-sign-up.mdx +++ b/docs/references/react/use-sign-up.mdx @@ -82,4 +82,4 @@ The `status` property of the `SignUp` object can be one of the following values: ### Create a custom sign-up flow with `useSignUp()` -The `useSignUp()` hook can also be used to build fully custom sign-up flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignUp()` hook to create custom flows, check out the [custom flow guides](/docs/custom-flows/overview). +The `useSignUp()` hook can also be used to build fully custom sign-up flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignUp()` hook to create custom flows, check out the [custom flow guides](/docs/custom-flows/overview). diff --git a/docs/references/sdk/philosophy.mdx b/docs/references/sdk/philosophy.mdx index bc02987f50..50504662bc 100644 --- a/docs/references/sdk/philosophy.mdx +++ b/docs/references/sdk/philosophy.mdx @@ -26,7 +26,7 @@ Spend time writing an exhaustive, yet organized `README` that enables your users ## Convenience -Make using your SDK as convenient as possible for its users. For example, provide pre-built components that users can import into their project. If the SDK can handle something under the hood which otherwise would require an action by the user, do it. Mimic the ease of use of Clerk's own SDKs. +Make using your SDK as convenient as possible for its users. For example, provide prebuilt components that users can import into their project. If the SDK can handle something under the hood which otherwise would require an action by the user, do it. Mimic the ease of use of Clerk's own SDKs. ## Compatibility diff --git a/docs/upgrade-guides/progressive-sign-up.mdx b/docs/upgrade-guides/progressive-sign-up.mdx index d1941eaf40..affcc45234 100644 --- a/docs/upgrade-guides/progressive-sign-up.mdx +++ b/docs/upgrade-guides/progressive-sign-up.mdx @@ -33,7 +33,7 @@ Before you enable Progressive Sign Up, make sure you’re on Clerk.js version 3. The Progressive Sign Up flow can be toggled on via an instance setting, using the [Instance Settings][instance-settings] endpoint in Backend API. In the future, this setting will be exposed as a Dashboard toggle as well. -If you're using the [pre-built UI components](/docs/components/overview), there are no changes required on your behalf. +If you're using the [prebuilt UI components](/docs/components/overview), there are no changes required on your behalf. If you're implementing a custom flow, you should cater for the case in which, after a successful OAuth or Web3 flow, the sign-up might still be in a pending state. This essentially means that you should peek into `sign_up.status`, `sign_up.missing_fields`, and `sign_up.unverified_fields` and act accordingly.