feat(clerk-js,react,types): Add option to enable combined flow at com…

…ponent level
clerk · Dec 17, 2024 · 9ae0630 · 9ae0630
1 parent 79cadb9
commit 9ae0630
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/packages/clerk-js/src/ui/contexts/components/SignIn.ts b/packages/clerk-js/src/ui/contexts/components/SignIn.ts
@@ -34,12 +34,14 @@ export const useSignInContext = (): SignInContextType => {
   const { queryParams, queryString } = useRouter();
   const options = useOptions();
   const clerk = useClerk();
-  const isCombinedFlow = Boolean(!options.signUpUrl && options.signInUrl && !isAbsoluteUrl(options.signInUrl));
 
   if (context === null || context.componentName !== 'SignIn') {
     throw new Error(`Clerk: useSignInContext called outside of the mounted SignIn component.`);
   }
 
+  const isCombinedFlow =
+    Boolean(!options.signUpUrl && options.signInUrl && !isAbsoluteUrl(options.signInUrl)) || context.combinedFlow;
+
   const { componentName, mode, ..._ctx } = context;
   const ctx = _ctx.__experimental?.combinedProps || _ctx;
 
@@ -76,7 +78,7 @@ export const useSignInContext = (): SignInContextType => {
   signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
   waitlistUrl = buildURL({ base: waitlistUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 
-  if (options.experimental?.combinedFlow) {
+  if (isCombinedFlow) {
     signUpUrl = buildURL(
       { base: signInUrl, hashPath: '/create', hashSearchParams: [queryParams, preservedParams] },
       { stringify: true },

diff --git a/packages/react/src/components/SignInButton.tsx b/packages/react/src/components/SignInButton.tsx
@@ -13,6 +13,7 @@ export const SignInButton = withClerk(({ clerk, children, ...props }: WithClerkP
     signUpForceRedirectUrl,
     mode,
     initialValues,
+    combinedFlow,
     ...rest
   } = props;
   children = normalizeWithDefaultValue(children, 'Sign in');
@@ -25,6 +26,7 @@ export const SignInButton = withClerk(({ clerk, children, ...props }: WithClerkP
       signUpFallbackRedirectUrl,
       signUpForceRedirectUrl,
       initialValues,
+      combinedFlow,
     };
 
     if (mode === 'modal') {

diff --git a/packages/react/src/types.ts b/packages/react/src/types.ts
@@ -122,6 +122,7 @@ export type SignInButtonProps = ButtonProps &
     | 'signUpForceRedirectUrl'
     | 'signUpFallbackRedirectUrl'
     | 'initialValues'
+    | 'combinedFlow'
   >;
 
 export type SignUpButtonProps = {

diff --git a/packages/types/src/clerk.ts b/packages/types/src/clerk.ts
@@ -941,6 +941,10 @@ export type SignInProps = RoutingOptions & {
    * Additional arbitrary metadata to be stored alongside the User object
    */
   unsafeMetadata?: SignUpUnsafeMetadata;
+  /**
+   * Enable the combined sign-in-or-up flow for `<SignIn />` component instance.
+   */
+  combinedFlow?: boolean;
 } & TransferableOption &
   SignUpForceRedirectUrl &
   SignUpFallbackRedirectUrl &