Skip to main content
Coming Soon

The Localization feature is under active development and not yet available. The information below describes planned functionality.

Localization Overview

BreakGround supports delivering digital adoption content in multiple languages. Translations are stored per content item per locale and served to users based on their language preference.

How Localization Works

The localization system follows this workflow:

  1. Create content in your default language using the dashboard.
  2. Add translations for each target locale using the Translation Editor.
  3. The SDK fetches the appropriate translation bundle at runtime based on locale resolution.

Each translation record maps a specific field (title, body, button text, step content) of a content item to its translated value for a given locale. Translations are versioned, so updates to the original content can be tracked against existing translations.

Locale Configuration

Manage locales from Settings > Localization in the dashboard. Each locale has the following properties:

PropertyDescription
codeA 2-10 character identifier (e.g., en, es, fr, ar).
nameA human-readable label (e.g., "English", "Spanish").
isDefaultWhether this is the company's default locale. Exactly one locale must be default.
isRtlWhether the locale uses right-to-left text direction. See RTL Support.

Locale Resolution Priority

When the SDK determines which locale to use for a user, it checks the following sources in order:

  1. Explicit SDK configuration -- a locale set programmatically via the SDK init() or setLocale() call takes highest priority.
  2. Company default locale -- if no explicit locale is configured, the company's default locale is used.
  3. Browser detection -- as a fallback, the SDK reads the browser's navigator.language and matches it against available locales.

If no matching locale is found, content is served in the default language.

Translation Coverage

The dashboard displays translation coverage per locale, showing how many content fields have been translated out of the total. This helps you identify locales that need attention before launch.

Coverage is reported as:

  • Complete -- all translatable fields have values for this locale.
  • Partial -- some fields are translated, others are missing.
  • Missing -- no translations exist for this locale.

Supported Workflow

For teams with professional translators or localization vendors:

  1. Export translations from the dashboard as a structured bundle.
  2. Send the bundle to your translation team or service.
  3. Import the completed translations back using the bulk import feature.

This workflow integrates with your existing localization pipeline without requiring translators to access the BreakGround dashboard directly.