feat(clerk-js, types): Add optional locale from browser to signup flow (#6915)

Author: guilherme6191

.changeset/funny-memes-crash.md

@@ -0,0 +1,7 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/clerk-react': minor
+'@clerk/types': minor
+---
+
+Add support for sign up `locale`

packages/clerk-js/src/core/resources/SignUp.ts

@@ -46,6 +46,7 @@ import {
   generateSignatureWithMetamask,
   generateSignatureWithOKXWallet,
   getBaseIdentifier,
+  getBrowserLocale,
   getClerkQueryParam,
   getCoinbaseWalletIdentifier,
   getMetamaskIdentifier,
@@ -95,6 +96,7 @@ export class SignUp extends BaseResource implements SignUpResource {
   createdUserId: string | null = null;
   abandonAt: number | null = null;
   legalAcceptedAt: number | null = null;
+  locale: string | null = null;
 
   /**
    * The current status of the sign-up process.
@@ -154,6 +156,14 @@ export class SignUp extends BaseResource implements SignUpResource {
 
     let finalParams = { ...params };
 
+    // Inject browser locale if not already provided
+    if (!finalParams.locale) {
+      const browserLocale = getBrowserLocale();
+      if (browserLocale) {
+        finalParams.locale = browserLocale;
+      }
+    }
+
     if (!__BUILD_DISABLE_RHC__ && !this.clientBypass() && !this.shouldBypassCaptchaForAttempt(params)) {
       const captchaChallenge = new CaptchaChallenge(SignUp.clerk);
       const captchaParams = await captchaChallenge.managedOrInvisible({ action: 'signup' });
@@ -477,6 +487,7 @@ export class SignUp extends BaseResource implements SignUpResource {
       this.abandonAt = data.abandon_at;
       this.web3wallet = data.web3_wallet;
       this.legalAcceptedAt = data.legal_accepted_at;
+      this.locale = data.locale;
     }
 
     eventBus.emit('resource:update', { resource: this });
@@ -505,6 +516,7 @@ export class SignUp extends BaseResource implements SignUpResource {
       abandon_at: this.abandonAt,
       web3_wallet: this.web3wallet,
       legal_accepted_at: this.legalAcceptedAt,
+      locale: this.locale,
       external_account: this.externalAccount,
       external_account_strategy: this.externalAccount?.strategy,
     };
@@ -620,6 +632,10 @@ class SignUpFuture implements SignUpFutureResource {
     return this.resource.legalAcceptedAt;
   }
 
+  get locale() {
+    return this.resource.locale;
+  }
+
   get unverifiedFields() {
     return this.resource.unverifiedFields;
   }
@@ -670,6 +686,7 @@ class SignUpFuture implements SignUpFutureResource {
       captchaError,
       ...params,
       unsafeMetadata: params.unsafeMetadata ? normalizeUnsafeMetadata(params.unsafeMetadata) : undefined,
+      locale: params.locale ?? getBrowserLocale(),
     };
 
     await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });

packages/clerk-js/src/test/core-fixtures.ts

@@ -231,6 +231,8 @@ export const createSignUp = (signUpParams: Partial<SignUpJSON> = {}) => {
     first_name: signUpParams.first_name,
     has_password: signUpParams.has_password,
     last_name: signUpParams.last_name,
+    legal_accepted_at: signUpParams.legal_accepted_at,
+    locale: signUpParams.locale,
     missing_fields: signUpParams.missing_fields,
     object: 'sign_up',
     optional_fields: signUpParams.optional_fields,

packages/clerk-js/src/utils/__tests__/locale.test.ts

@@ -0,0 +1,33 @@
+import { afterEach, describe, expect, it, vi } from 'vitest';
+
+import { getBrowserLocale } from '../locale';
+
+describe('getBrowserLocale()', () => {
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+
+  it('returns the browser locale when available', () => {
+    vi.stubGlobal('navigator', { language: 'es-ES' });
+
+    expect(getBrowserLocale()).toBe('es-ES');
+  });
+
+  it('returns null as default when navigator.language is not available', () => {
+    vi.stubGlobal('navigator', { language: undefined });
+
+    expect(getBrowserLocale()).toBeNull();
+  });
+
+  it('returns null as default when navigator.language is empty string', () => {
+    vi.stubGlobal('navigator', { language: '' });
+
+    expect(getBrowserLocale()).toBeNull();
+  });
+
+  it('returns null as default when navigator object is not defined', () => {
+    vi.stubGlobal('navigator', undefined);
+
+    expect(getBrowserLocale()).toBeNull();
+  });
+});

packages/clerk-js/src/utils/index.ts

@@ -15,6 +15,7 @@ export * from './ignoreEventValue';
 export * from './image';
 export * from './instance';
 export * from './jwt';
+export * from './locale';
 export * from './normalizeRoutingOptions';
 export * from './organization';
 export * from './pageLifecycle';

packages/clerk-js/src/utils/locale.ts

@@ -0,0 +1,28 @@
+import { inBrowser } from '@clerk/shared/browser';
+
+const DEFAULT_LOCALE = null;
+
+/**
+ * Detects the user's preferred locale from the browser.
+ * Falls back to null if locale cannot be determined.
+ *
+ * @returns The browser's reported locale string (typically BCP 47 format like 'en-US', 'es-ES') or null if locale cannot be determined.
+ */
+export function getBrowserLocale(): string | null {
+  if (!inBrowser()) {
+    return DEFAULT_LOCALE;
+  }
+
+  try {
+    // Get locale from the browser
+    const locale = navigator?.language;
+
+    // Validate that we got a non-empty string
+    if (!locale || typeof locale !== 'string' || locale.trim() === '') {
+      return DEFAULT_LOCALE;
+    }
+    return locale;
+  } catch {
+    return DEFAULT_LOCALE;
+  }
+}

packages/react/src/stateProxy.ts

@@ -194,6 +194,9 @@ export class StateProxy implements State {
         get legalAcceptedAt() {
           return gateProperty(target, 'legalAcceptedAt', null);
         },
+        get locale() {
+          return gateProperty(target, 'locale', null);
+        },
         get status() {
           return gateProperty(target, 'status', 'missing_requirements');
         },

packages/types/src/json.ts

@@ -136,6 +136,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
   created_user_id: string | null;
   abandon_at: number | null;
   legal_accepted_at: number | null;
+  locale: string | null;
   verifications: SignUpVerificationsJSON | null;
 }
 

packages/types/src/signUp.ts

@@ -60,6 +60,7 @@ export interface SignUpResource extends ClerkResource {
   createdUserId: string | null;
   abandonAt: number | null;
   legalAcceptedAt: number | null;
+  locale: string | null;
 
   create: (params: SignUpCreateParams) => Promise<SignUpResource>;
 

packages/types/src/signUpCommon.ts

@@ -100,6 +100,7 @@ export type SignUpCreateParams = Partial<
     oidcPrompt: string;
     oidcLoginHint: string;
     channel: PhoneCodeChannel;
+    locale?: string;
   } & Omit<SnakeToCamel<Record<SignUpAttributeField | SignUpVerifiableField, string>>, 'legalAccepted'>
 >;