Skip to content

Commit

Permalink
pre-built -> prebuilt
Browse files Browse the repository at this point in the history
  • Loading branch information
victoriaxyz committed Oct 29, 2024
1 parent 01dd427 commit 47922cf
Show file tree
Hide file tree
Showing 17 changed files with 23 additions and 23 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ The `<Cards>` 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.

</Cards>
```
Expand All @@ -602,7 +602,7 @@ The `<Cards>` 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.
- {<svg viewBox="0 0 32 32">{/* */}</svg>}

</Cards>
Expand All @@ -625,7 +625,7 @@ The `<Cards>` 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.
- {<svg viewBox="0 0 32 32">{/* */}</svg>}

</Cards>
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/configuration/session-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 [`<UserButton />`](/docs/components/user/user-button) component if you want to use Clerk's pre-built UI.
- Use the [`<UserButton />`](/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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/customization/elements/examples/sign-in.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/customization/elements/examples/sign-up.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/customization/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Properties>

## 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

Expand Down Expand Up @@ -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.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/customization/themes.mdx
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/authjs-migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 [`<SignIn />`](/docs/components/authentication/sign-in) and [`<SignUp />`](/docs/components/authentication/sign-up) components
- use Clerk's [prebuilt components](/docs/references/nextjs/custom-signup-signin-pages), such as the [`<SignIn />`](/docs/components/authentication/sign-in) and [`<SignUp />`](/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
Expand Down
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- {<svg viewBox="0 0 32 32" fill="none"><path fill="currentColor" fillOpacity=".15" d="M16 31.25 1.962 25.234A2 2 0 0 1 .75 23.395V7.285l14.462-6.197a2 2 0 0 1 1.576 0L31.25 7.286 16 13.896V31.25Z"/><path fill="currentColor" d="m16 31.25-.295.69a.75.75 0 0 0 1.045-.69H16ZM1.962 25.234l-.295.69.295-.69ZM.75 7.286l-.295-.69a.75.75 0 0 0-.455.69h.75Zm30.5 0 .298.688a.75.75 0 0 0-.003-1.378l-.295.69ZM16.788 1.088l-.296.689.296-.69Zm-1.576 0 .296.689-.296-.69Zm1.083 29.473L2.258 24.544l-.591 1.38 14.038 6.015.59-1.378ZM1.5 23.395V7.285H0v16.11h1.5ZM31.545 6.596 17.083.398l-.59 1.379 14.462 6.198.59-1.379ZM14.917.398.455 6.596l.59 1.38 14.463-6.199-.591-1.379ZM.452 7.974l15.25 6.61.596-1.376-15.25-6.61-.596 1.376Zm15.846 6.61 15.25-6.61-.596-1.376-15.25 6.61.596 1.377Zm-1.048-.688V31.25h1.5V13.896h-1.5ZM17.083.399a2.75 2.75 0 0 0-2.166 0l.59 1.379a1.25 1.25 0 0 1 .985 0l.591-1.379ZM2.258 24.544a1.25 1.25 0 0 1-.758-1.149H0c0 1.1.656 2.095 1.667 2.528l.59-1.379Z"/><path stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" strokeWidth="1.5" d="M31.25 7.281v16.11a2 2 0 0 1-1.212 1.838L16 31.246"/></svg>}

---
Expand Down
2 changes: 1 addition & 1 deletion docs/organizations/roles-permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<Protect>` component](/docs/components/protect)
- [Learn how to use roles and permissions to limit the content a user can see with Clerk's prebuilt `<Protect>` 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)
2 changes: 1 addition & 1 deletion docs/references/astro/sign-in-store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/references/astro/sign-up-store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/references/react/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/references/react/use-sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/references/react/use-sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/references/sdk/philosophy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/progressive-sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 47922cf

Please sign in to comment.