SDK localization

Overview

Monite’s React SDK supports a localization mechanism. The React SDK defaults to the browser’s locale for handling localization within SDK components. However, you can explicitly define localization using the code prop on the MoniteProvider wrapper.

Use Monite’s custom localization mechanism for any of purposes:

• To define number formatting and usage of delimiters and decimal separators using the code property.
• To define date formats by country or region using the code property.
• To further customize the display format for currencies on the SDK using the currencyNumberFormat property.
• To customize any text labels in the widgets (for example, rename “Counterpart Name” to “Supplier Name”).
• To translate the labels into one or more other languages.

The following snippet shows how to use the locale prop on the MoniteProvider wrapper:

1
<MoniteProvider
2
  monite={monite}
3
  locale={{
4
    code: "en-US",
5
    currencyNumberFormat: {
6
      display: "symbol",
7
      localeCode: "en-US",
8
    },
9
    messages: {
10
      "Counterpart Name": "Supplier Name",
11
      Counterpart: "Supplier",
12
      Sales: "Incoming transactions",
13
    },
14
  }}
15
>
16
  ...
17
</MoniteProvider>

The code prop is an optional property that handles the usage of delimiters and decimal separators for different countries, regions, or locales. It also handles the date formatting across various UI components. The accepted format for the code property must adhere to the BCP-47 language tag standard.

Currency formatting

The currencyNumberFormat format on the locale prop allows entities to define the configuration that handles the display of currencies on the SDK. This includes using either currency code or symbol and using delimiters on numbers.

1
<MoniteProvider
2
  locale={{
3
    code: "en-US",
4
    currencyNumberFormat: {
5
      display: "code", // formats currencies as USD 100.00
6
    },
7
  }}
8
>
9
  ...
10
</MoniteProvider>

The currencyNumberFormat object contains two properties—display, and localeCode.

• The display property handles using currency codes or symbols on currency displays in the SDK. This property has two values: code and symbol. If this property is not provided, the SDK will use currency symbols on all currency displays within the SDK.
• The localeCode property handles the number formatting and use of delimiters for currencies on the SDK. This property accepts the BCP-language standard for currencies, regions, and locales. This property extends the code prop on the MoniteProvider wrapper, allowing entities to provide a differrent number and currency display formatting for currencies in the SDK. If not provided, currencies will inherit the format defined in the code prop.

1
<MoniteProvider
2
  locale={{
3
    code: "en-US",
4
    currencyNumberFormat: {
5
      display: "code",
6
      localeCode: "en-150", // formats currencies as 100.00 USD
7
    },
8
  }}
9
>
10
  ...
11
</MoniteProvider>

Text customization

Monite allows entities to customize texts on the React SDK. This includes changing certain SDK text labels to other English texts. This feature also allows entities to translate text to other languages according to their user-specific or locale requirements.

There are two implementation approaches you can use to handle text customization. The approach chosen depends on your requirements.

Approach 1: Pass custom labels directly to the MoniteProvider component

If you need to change just a few text labels, you can specify them in the locale property of MoniteProvider component as shown below. In this example, we replace the “Counterpart Name” and “Counterpart” labels with “Supplier Name”:

1
<MoniteProvider
2
  monite={monite}
3
  locale={{
4
    messages: {
5
      "Counterpart Name": "Supplier Name",
6
      Counterpart: "Supplier",
7
      Sales: "Incoming transactions",
8
    },
9
  }}
10
>
11
  ...
12
</MoniteProvider>

The messages prop is an object used to define text translations and customizations. In the messages object:

• The keys represent the text labels in the React SDK UI that you wish to replace. You can find all available keys on Monite’s Portable Object template - look for the msgid strings. The keys match the exact text labels that you see in the UI.
• The values are the new text to use in place of the object’s keys. Values can be of any language, and you can customize these values as required.

Any other labels not specified in the messages object will keep their original text.

Approach 2: Use portable object files

Portable Object (PO) is the standard file format for localization. A PO file is a text file that includes the original texts and the translations.

Monite SDK includes a template PO file here that you can use or pass to your translators. This can be useful if you want to add multiple translations to your project.

The typical procedure is:

1. Copy the template file somewhere and open it in a translators’ tool (such as СrowdIn or similar).

2. Create a new locale and translate the messages.

3. Save the translations to a new messages.po file. Put this file into the src/locales/{locale} directory of your project, where {locale} is your locale name. For example, if you use the en locale, the file path would be src/locales/en/messages.po.

4. Create the lingui.config.js file in the root directory of your project (next to the package.json file), with the following contents:

   1
   module.exports = {
   2
     locales: ["en"], // your locale code, could be 'de', 'fr', etc.
   3
     catalogs: [
   4
       {
   5
         path: "src/locales/{locale}/messages", // DO NOT replace "{locale}" with anything
   6
       },
   7
     ],
   8
     compileNamespace: "es", // also available to build 'ts' or 'cjs' modules  format: "po"
   9
   };

5. Run npx @lingui/cli compile.

6. Use the generated messages.mjs file to pass the translated messages to the <MoniteProvider>:

   1
   import { messages } from './locales/en/messages.mjs'
   2
   ...
   3
   4
   <MoniteProvider monite={monite} locale={messages}>
   5
     ...
   6
   </MoniteProvider>