From 6913d6bf2beae645b2bd49cf5239bc57317584db Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Thu, 10 Oct 2024 17:19:45 -0400 Subject: [PATCH] (chore) Clerk Components --> Clerk components (#1622) --- docs/components/authentication/sign-in.mdx | 2 +- docs/components/authentication/sign-up.mdx | 2 +- docs/components/clerk-provider.mdx | 6 +++--- 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 | 2 +- docs/customization/localization.mdx | 8 ++++---- docs/organizations/roles-permissions.mdx | 2 +- docs/references/javascript/clerk/clerk.mdx | 4 ++-- docs/references/nextjs/custom-signup-signin-pages.mdx | 2 +- docs/references/react/overview.mdx | 2 +- docs/references/remix/clerk-app.mdx | 4 ++-- 15 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/components/authentication/sign-in.mdx b/docs/components/authentication/sign-in.mdx index aec18bd4a8..b81eef4f27 100644 --- a/docs/components/authentication/sign-in.mdx +++ b/docs/components/authentication/sign-in.mdx @@ -18,7 +18,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/authentication/sign-up.mdx b/docs/components/authentication/sign-up.mdx index 92ebff93f5..f06ac49296 100644 --- a/docs/components/authentication/sign-up.mdx +++ b/docs/components/authentication/sign-up.mdx @@ -18,7 +18,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/clerk-provider.mdx b/docs/components/clerk-provider.mdx index 76da3b1228..e7d7104c09 100644 --- a/docs/components/clerk-provider.mdx +++ b/docs/components/clerk-provider.mdx @@ -106,7 +106,7 @@ The `` component must be added to your React entrypoint. - `appearance?` - [Appearance](/docs/customization/overview) | undefined - 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. --- @@ -148,7 +148,7 @@ The `` component must be added to your React entrypoint. - `localization` - [Localization](/docs/customization/localization) | undefined - 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. --- @@ -218,7 +218,7 @@ The `` 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. --- diff --git a/docs/components/organization/create-organization.mdx b/docs/components/organization/create-organization.mdx index 08d2795a37..59d140f994 100644 --- a/docs/components/organization/create-organization.mdx +++ b/docs/components/organization/create-organization.mdx @@ -15,7 +15,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/organization/organization-list.mdx b/docs/components/organization/organization-list.mdx index d97d133011..1b14765ec9 100644 --- a/docs/components/organization/organization-list.mdx +++ b/docs/components/organization/organization-list.mdx @@ -29,7 +29,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/organization/organization-profile.mdx b/docs/components/organization/organization-profile.mdx index 93e0731b7d..615d0a635d 100644 --- a/docs/components/organization/organization-profile.mdx +++ b/docs/components/organization/organization-profile.mdx @@ -19,7 +19,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/organization/organization-switcher.mdx b/docs/components/organization/organization-switcher.mdx index f7e6a378ee..60c3a5e494 100644 --- a/docs/components/organization/organization-switcher.mdx +++ b/docs/components/organization/organization-switcher.mdx @@ -26,7 +26,7 @@ All props below are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/user/user-button.mdx b/docs/components/user/user-button.mdx index 76029970cb..b9730e6479 100644 --- a/docs/components/user/user-button.mdx +++ b/docs/components/user/user-button.mdx @@ -38,7 +38,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/components/user/user-profile.mdx b/docs/components/user/user-profile.mdx index 4c72998229..2465d2c3e0 100644 --- a/docs/components/user/user-profile.mdx +++ b/docs/components/user/user-profile.mdx @@ -15,7 +15,7 @@ All props are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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. --- diff --git a/docs/customization/localization.mdx b/docs/customization/localization.mdx index ceae51cc36..690a6e85a2 100644 --- a/docs/customization/localization.mdx +++ b/docs/customization/localization.mdx @@ -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 @@ -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 diff --git a/docs/organizations/roles-permissions.mdx b/docs/organizations/roles-permissions.mdx index 5725b02a3d..bd840396ef 100644 --- a/docs/organizations/roles-permissions.mdx +++ b/docs/organizations/roles-permissions.mdx @@ -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: diff --git a/docs/references/javascript/clerk/clerk.mdx b/docs/references/javascript/clerk/clerk.mdx index 4f727ba3dc..9dceaa0102 100644 --- a/docs/references/javascript/clerk/clerk.mdx +++ b/docs/references/javascript/clerk/clerk.mdx @@ -303,14 +303,14 @@ All props below are optional. - `appearance` - [Appearance](/docs/customization/overview) | undefined - 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` - [Localization](/docs/customization/localization) | undefined - 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. --- diff --git a/docs/references/nextjs/custom-signup-signin-pages.mdx b/docs/references/nextjs/custom-signup-signin-pages.mdx index 64c4536e71..59931b767b 100644 --- a/docs/references/nextjs/custom-signup-signin-pages.mdx +++ b/docs/references/nextjs/custom-signup-signin-pages.mdx @@ -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. diff --git a/docs/references/react/overview.mdx b/docs/references/react/overview.mdx index 2b35b3f1b6..3c89e9ecb4 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, 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. diff --git a/docs/references/remix/clerk-app.mdx b/docs/references/remix/clerk-app.mdx index a08c64d165..640f879ada 100644 --- a/docs/references/remix/clerk-app.mdx +++ b/docs/references/remix/clerk-app.mdx @@ -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` - [Localization](/docs/customization/localization) | undefined - 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. ---