Add code examples for components (and some hooks) to support all SDKs #2481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

NWylynko merged 110 commits into main from nick/sdk-scoping-components-and-hooks

Oct 2, 2025

docs/_partials/expo/web-only-callout.mdx

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,2 +1,2 @@
  
    > [!NOTE]

    > This component can be used in Expo Web projects, but won't work in native environments (iOS or Android). For native apps, use the supported native components instead.

    > This component can be used in Expo Web projects, but it isn't available in native environments (iOS or Android). For native apps, build a custom UI using Clerk hooks. See [custom flows guides](/docs/guides/development/custom-flows/overview) for details.

docs/_partials/javascript/clerk-options.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,141 @@
+    The `load()` method accepts an optional object that accepts the following props. All props are optional.
+    <Properties>
+      - `appearance`
+      - <code>[Appearance](/docs/guides/customizing-clerk/appearance-prop/overview) | undefined</code>
+      Optional object to style your components. Will only affect \[Clerk components]\[components-ref] and not \[Account Portal]\[ap-ref] pages.
+      ---
+      - `localization`
+      - <code>[Localization](/docs/guides/customizing-clerk/localization) | undefined</code>
+      Optional object to localize your components. Will only affect \[Clerk components]\[components-ref] and not \[Account Portal]\[ap-ref] pages.
+      ---
+      - `routerPush?`
+      - `(to: string) => Promise<unknown> | void`
+      A function which takes the destination path as an argument and performs a "push" navigation.
+      ---
+      - `routerReplace?`
+      - `(to: string) => Promise<unknown> | void`
+      A function which takes the destination path as an argument and performs a "replace" navigation.
+      ---
+      - `polling`
+      - `boolean | undefined`
+      Dictates if we should poll against Clerk's backend every 5 minutes. Defaults to `true`.
+      ---
+      - `selectInitialSession`
+      - <code>((client: \[Client]\[client-ref]) => Session | null) | undefined</code>
+      An optional function which allows you to control which active session is the initial session to base a user's state off of. Defaults to the first session in the client's sessions array.
+      ---
+      - `standardBrowser`
+      - `boolean | undefined`
+      Controls if ClerkJS will load with the standard browser set up using Clerk cookies. Defaults to `true`.
+      ---
+      - `supportEmail`
+      - `string | undefined`
+      Optional support email for display in authentication screens.
+      ---
+      - `touchSession`
+      - `boolean | undefined`
+      Indicates whether the session should be "touched" when user interactions occur, used to record these interactions. Defaults to `true`.
+      ---
+      - `signInUrl`
+      - `string | undefined`
+      The default URL to use to direct to when the user signs in. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `signUpUrl`
+      - `string | undefined`
+      The default URL to use to direct to when the user signs up. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `signInForceRedirectUrl?`
+      - `string`
+      If provided, this URL will always be redirected to after the user signs in. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `signUpForceRedirectUrl?`
+      - `string`
+      If provided, this URL will always be redirected to after the user signs up. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `signInFallbackRedirectUrl?`
+      - `string`
+      The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `signUpFallbackRedirectUrl?`
+      - `string`
+      The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+      ---
+      - `afterSignOutUrl?`
+      - `string`
+      The full URL or path to navigate to after a successful sign-out.
+      ---
+      - `allowedRedirectOrigins?`
+      - `Array<string | RegExp>`
+      An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
+      ---
+      - `allowedRedirectProtocols?`
+      - `Array<string>`
+      An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
+      ---
+      - `isSatellite`
+      - `boolean | ((url: URL) => boolean) | undefined`
+      Clerk flag for satellite apps. Experimental.
+      ---
+      - `telemetry?`
+      - `false | { disabled?: boolean; debug?: boolean } | undefined`
+      Controls whether or not Clerk will collect [telemetry data](/docs/guides/how-clerk-works/security/clerk-telemetry).
+    </Properties>

docs/guides/configure/auth-strategies/web3/metamask.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
     Enabling [MetaMask](https://metamask.io/) as a Web3 provider allows your users to sign in and  up to your Clerk application with their MetaMask wallet.
+    > [!IMPORTANT]
+    > MetaMask authentication is not supported when using the **Clerk Chrome Extension SDK**, as it cannot load third-party code per Chrome Web Store policies.
     ## Enable MetaMask as a Web3 provider
 . In the Clerk Dashboard, navigate to the [**Web3**](https://dashboard.clerk.com/last-active?path=user-authentication/web3) page.
@@ Expand Down @@

docs/guides/development/upgrading/upgrade-guides/core-2/react.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
       </AccordionPanel>
       <AccordionPanel>
-        The `membershipList` param from the `useOrganization` hook has been removed. Instead, [use the `memberships` param](/docs/reference/hooks/use-organization#parameters). Examples of each can be seen here:
+        The `membershipList` param from the `useOrganization` hook has been removed. Instead, [use the `memberships` param](/docs/reference/hooks/use-organization#properties). Examples of each can be seen here:
         ```js
         // before
@@ Expand Down @@

docs/guides/secure/reverification.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
       <Tab>
         ```tsx {{ filename: '/src/components/TransferButton.js' }}
-        import { useReverification } from '@clerk/react'
+        import { useReverification } from '@clerk/clerk-react'
         export function TransferButton({ amount_in_cents }: { amount_in_cents: number }) {
           const transferMoney = useReverification(() =>
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add code examples for components (and some hooks) to support all SDKs #2481

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!