Integrating Builder Localization with Your Code

Pro plans

To use localization with Builder, you must integrate with your codebase so that your app and Builder localization coordinate with one another. This entails:

Passing the locale to the BuilderComponent or Content. depending on your SDK. For details on the SDKs, read SDK Comparison.
Passing the locale value in the options object when fetching content from the API to get JSON with resolved, localized values.

Though the syntax varies depending on the framework, the concept is the same. Select your framework below for examples.

Tip: Passing the locale to the BuilderComponent or Content emits the locale while previewing or editing so the Visual Editor displays localized values.

Content entry localization

For whole-content entry localization, specify your locale as a targeting attribute when fetching your Builder content from the Content API.

Integrating localization with Builder Data models is the same as with Page or Section models except that you don't render anything in your code for a Data model. This means that for integrating a Data model, you don't need BuilderComponent for Gen 1 or Content for Gen 2 SDKs.

For more detail on setting up localization in the Builder Data model UI, visit Localizing Data Models.

How Builder transforms objects with locale values

For example, given a greeting object, with localized values for en-US and fr-Fr, Builder would transform it to Hello or Bonjour depending on the locale:

// orginal object with values for each locale
"greeting": {
  "en-US": "Hello",
  "fr-Fr": "Bonjour"
}

Builder transforms the object to use the value that corresponds to the locale, as follows:

// locale=en-US
"greeting":"Hello"

// locale=fr-Fr
"greeting": "Bonjour"

Deriving the locale

Ideally, you want your app to dynamically adjust to the user's locale.

You can automatically determine the user’s locale based on their system settings by using the Intl.DateTimeFormat() locale and passing it into the locale option:

const res = await fetchOneEntry({
  model: 'page',
  apiKey,
  options: {
    ...getBuilderSearchParams(new URL(location.href).searchParams),
    locale: new Intl.DateTimeFormat().resolvedOptions().locale
  },
  userAttributes: {
    urlPath: window.location.pathname,
  },
});