JSS Dictionary API

Current version: 22.0

Often, multilingual apps need a dictionary of static phrases that require translation. Commonly, these are items such as form labels, global navigation items, footers, and so on.

Sitecore JavaScript Rendering SDK (JSS) provides an API to help you fetch application-specific translation dictionaries using the Sitecore Dictionary Service.

When using JSS, you can get dictionary data from several endpoints, without worrying about data fetching implementation details. The JSS Dictionary API abstracts data fetching implementation details into services, clients, and data fetchers for REST and GraphQL endpoints. See some usage examples.

After the dictionary data is available in the front-end application, you can choose how to utilize it and what internationalization libraries you prefer. For example, the React JSS application utilizes the i18next module with a custom plugin.

Sitecore endpoints for dictionary data

There are several options for fetching dictionary phrases from Sitecore:

You can choose whether to use REST or GraphQL endpoints when creating your JSS application with the --fetchWith REST parameter or the --fetchWith GraphQL parameter.

Do you have some feedback for us?

If you have suggestions for improving this article,