Localization of user interface elements

Certain content that the Carousel Viewer displays is subject to localization. This content includes slide navigation buttons.

Every textual content in the viewer that can be localized is represented by the special Viewer SDK identifier called SYMBOL. Any SYMBOL has a default associated text value for an English locale ( "en") supplied with the out-of-the-box viewer, and may also have user-defined values set for as many locales as needed.

When the viewer starts, it checks the current locale to see if there is a user-defined value for each supported SYMBOL for such locale. If there is, it uses the user-defined value; otherwise, it falls back to the out-of-the-box default text.

User-defined localization data can be passed to the viewer as a localization JSON object. Such object contains the list of supported locales, SYMBOL text values for each locale, and the default locale.

An example of such a localization object is the following:

"PanRightButton .TOOLTIP":"Droit"

In the example above, the localization object defines two locales ( "en" and "fr") and provides localization for two user interface elements in each locale.

The web page code should pass the localization object to the viewer constructor, as a value of localizedTexts field of the configuration object. An alternative option is to pass the localization object by calling setLocalizedTexts(localizationInfo) method.

The following SYMBOLs are supported:


Tool tip for...


Selected play pause button state.


Unselected play pause button state.


Tool tip and ARIA label for previous and next slide buttons.

Accepts two replacement tokens: $CURRENT_FRAME$ for the current slide index and $TOTAL_FRAMES$ for the total number of slides.


ARIA label for top-level viewer element.


ARIA role description for main view component.


ARIA usage hints for keyboard users.

On this page