Skip to content

Commit

Permalink
(chore) Clerk Components --> Clerk components (#1622)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech authored Oct 10, 2024
1 parent 6c5cbab commit 6913d6b
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/components/authentication/sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/authentication/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
6 changes: 3 additions & 3 deletions docs/components/clerk-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The `<ClerkProvider>` component must be added to your React entrypoint.
- `appearance?`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional object to style your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

Expand Down Expand Up @@ -148,7 +148,7 @@ The `<ClerkProvider>` component must be added to your React entrypoint.
- `localization`
- <code>[Localization](/docs/customization/localization) | undefined</code>

Optional object to localize your components. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional object to localize your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

Expand Down Expand Up @@ -218,7 +218,7 @@ The `<ClerkProvider>` component must be added to your React entrypoint.
- `supportEmail?`
- `string`

Optional support email for display in authentication screens. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional support email for display in authentication screens. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/create-organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-switcher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ All props below are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/user/user-button.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/user/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All props are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.
Optional object to style your components. Will only affect [Clerk components](/docs/components/overview) and not [Account Portal](/docs/customization/account-portal/overview) pages.

---

Expand Down
8 changes: 4 additions & 4 deletions docs/customization/localization.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Localization prop (experimental)
description: Use the Clerk localizations package to override and provide predefined or custom localizations for your Clerk Components, enabling you to offer localized content or tailor the wording to match your brand.
description: Use the Clerk localizations package to override and provide predefined or custom localizations for your Clerk components, enabling you to offer localized content or tailor the wording to match your brand.
---

> [!WARNING]
> This feature is currently experimental and may not behave as expected. If you encounter any issues, please reach out to [support](/contact/support){{ target: '_blank' }} with as much detail as possible.
Clerk offers the ability to override the strings for all of the elements in each of the Clerk Components. This allows you to provide localization for your users or change the wording to suit your brand.
Clerk offers the ability to override the strings for all of the elements in each of the Clerk components. This allows you to provide localization for your users or change the wording to suit your brand.

## `@clerk/localizations`

The `@clerk/localizations` package contains predefined localizations for the Clerk Components.
The `@clerk/localizations` package contains predefined localizations for the Clerk components.

### Languages

Expand Down Expand Up @@ -256,7 +256,7 @@ Our localizations are customer-sourced and we encourage customers to add or upda

## Custom localizations

You can also provide your own localizations for the Clerk Components. This is useful if you want to provide limited or quick localization for a language that Clerk doesn't currently support or if you want to change the wording to suit your brand.
You can also provide your own localizations for the Clerk components. This is useful if you want to provide limited or quick localization for a language that Clerk doesn't currently support or if you want to change the wording to suit your brand.

### Usage

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 @@ -47,7 +47,7 @@ Permissions grant users privileged access to resources and operations, like crea

### System Permissions

Clerk has a set of System Permissions that power [Clerk’s Frontend API](/docs/reference/frontend-api){{ target: '_blank' }} and [organization-related Clerk Components](/docs/components/overview#organization-components). They are a baseline set of permissions that Clerk needs to operate functionally.
Clerk has a set of System Permissions that power [Clerk’s Frontend API](/docs/reference/frontend-api){{ target: '_blank' }} and [organization-related Clerk components](/docs/components/overview#organization-components). They are a baseline set of permissions that Clerk needs to operate functionally.

Clerk’s System Permissions consist of the following:

Expand Down
4 changes: 2 additions & 2 deletions docs/references/javascript/clerk/clerk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -303,14 +303,14 @@ All props below are optional.
- `appearance`
- <code>[Appearance](/docs/customization/overview) | undefined</code>

Optional object to style your components. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional object to style your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

- `localization`
- <code>[Localization](/docs/customization/localization) | undefined</code>

Optional object to localize your components. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional object to localize your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/references/nextjs/custom-signup-signin-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,6 @@ If Clerk's prebuilt components don't meet your specific needs or if you require

---

- [Clerk Components](/docs/components/overview)
- [Clerk components](/docs/components/overview)
- Learn more about Clerk's prebuilt components that make authentication and user management easy.
</Cards>
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, 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 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
4 changes: 2 additions & 2 deletions docs/references/remix/clerk-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ export default ClerkApp(App)
- `supportEmail?`
- `string`

Optional support email for display in authentication screens. Will only affect Clerk Components and not Account Portal pages.
Optional support email for display in authentication screens. Will only affect Clerk components and not Account Portal pages.

---

- `localization`
- <code>[Localization](/docs/customization/localization) | undefined</code>

Optional object to localize your components. Will only affect [Clerk Components][components-ref] and not [Account Portal][ap-ref] pages.
Optional object to localize your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.

---

Expand Down

0 comments on commit 6913d6b

Please sign in to comment.