@auth0/auth0-acul-js - v1.0.0
    Preparing search index...

    Function changeLanguage

    • Common Feature

      Changes the language/locale for the current authentication flow.

      This function triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.

      Parameters

      • options: Screens.LanguageChangeOptions

        Language change options including the target language code

        Options for changing the language/locale during the authentication flow

        • [key: string]: string | number | boolean | undefined

          Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.

        • language: string

          Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').

        • Optionalpersist?: "session"

          Defines persistence scope for the language preference. Currently only 'session' is supported.

          'session'

      Returns Promise<void>

      A promise that resolves when the form submission is complete

      import { changeLanguage } from "@auth0/auth0-acul-js";

      // Change language to French
      await changeLanguage({
        language: 'fr',
        persist: 'session'
      });

      import { changeLanguage } from "@auth0/auth0-acul-js";

      // Change language to Spanish with additional custom data
      await changeLanguage({
        language: 'es',
        persist: 'session',
        'ulp-custom-field': 'custom-value'
      });
      • The language must be one of the enabled locales configured in your Auth0 tenant
      • The screen will automatically re-render with the new language after submission
      • Custom fields can be included and will be accessible in the Post Login Trigger

    Settings

    Member Visibility