To run the app

1. npm i
2. npm run start

Localization

Localization allows to translate static strings from project in different languages, depending on locale code.

Localization usage

In this project the locale code is in Conext.locale parameter. It can be passed via post message by editor (usually in production), in locale property, or by environment variable: APP_LOCALE

In order to make strings translatable, we need to use the t function.

For rect components we use useTranslation hook.

import { useTranslation } from "~/locale/useTranslation";

function MyComponent() {
  const { t } = useTranslation();
  
  return <div>{t("Hello World!!!")}</div>
}

In case we need t function outside of a React component, we need to pass the t function as parameter. In case that function is called from a react component, sure we will take the t functin from useTranslation hook and pass it. In cas the function is called from an observable middleware or reducer, then usually middlewares and reducers get this function as dependecy. See already implemented observables. Note: We are trying to make all string translable from components. So make sure to avoid translating from reducers or middlewares.

Interpolation

If you want to fill the static string with some dynamic content, then you need to do proper interpolation:

import { useTranslation } from "~/locale/useTranslation";

function MyComponent({ firstName, lastName }) {
  const { t } = useTranslation();
  
  return <div>{t("Hello {{firstName}} {{lastName}}! How are you?", {firstName, lastName})}</div>
}

Generate translatable strings

All translatable strings are saved in src/locales/default.json. In case new strings are added, we need to mae sure that they ar added in this file too. They should not be added in default.json manually, there is a special command for this npm run i18n.

Whenever you add new translatable strings, before you commit your changes run npm run i18n. Make sure the command did run properly and end with code 0. If something goes wrong, it will give an error. Unfortunately the error message is not descriptive at all. So you have to find the error by your self. Scroll in terminal logs generated by npm run i18n

Usually the log line look something like this:

[read]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts

But when something wrong happens it will look like this:

[error]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts
[warning]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts

Open the file and find out wat's wrong with t function usage. The common mistake is to use t string templates that have variables. You need to fix this by using proper interpolation. (Check out Interpolation section).