{t('key')}
; // more details below ``` ### Class Component ```js import { withTranslation } from 'react-i18next'; // withTranslation adds the "t" function to props: const { t } = this.props; // call the "t" function with a key from the JSON file:{t('p1')}
// in the JSON file: { "p1": "My paragraph" } // output:My paragraph
``` ### With Dynamic Data ```js // in the component: const username = 'moT';{t('welcome', { username: username })}
// in the JSON file: { "welcome": "Welcome {{username}}" } // output:Welcome moT
``` The above example passes an object to the `t` function with a `username` variable. The variable will be used in the JSON value where `{{username}}` is. ## Translate with the `Trans` Component The general rule is to use the "t" function when you can. But there's a `Trans` component for when that isn't enough, usually when you have elements embedded in the text. You can use the `Trans` component with any type of react component. ### Basic Elements Nested ```js // in the component: import { Trans } from 'react-i18next'
Welcome to freeCodeCamp
``` You can place the key inside the component tags like the above example if the text contains "simple" tags with no attributes. `br`, `strong`, `i`, and `p` are the default, but that list can be expanded in the i18n config. ### Complex Elements Nested Other times, you will want to have certain text inside another element, an anchor tag is a good example: ```js // in the component: // in the JSON file: { "check-forum": "Check out <0>our forum." } // output:Check out our forum
``` In the above example, the key is set in the attributes of the `Trans` component. The `<0>` and `` in the JSON represent the first child of the component, in this case, the anchor element. If there were more children, they would just count up from there using the same syntax. You can find the children of a component in the react dev tools by inspecting it. `placeholder` is simply there because the linter complains about empty `` elements. ### With a Variable ```js // in the component: const email = 'team@freecodecamp.org'; // in the JSON file: { "fcc": { "email": "Send us an email at: <0>{{email}}" } } // output:Send us an email at: team@freecodecamp.org
``` In the above example, the key and a variable are set in the attributes of the `Trans` component. `{{ email }}` needs to be somewhere in the `Trans` component as well, it doesn't matter where. ## Changing Text To change text on the client side of things, go to the relevant `.json` file, find the key that is being used in the React component, and change the value to the new text you want. You should search the codebase for that key to make sure it isn't being used elsewhere. Or, if it is, that the changes make sense in all places. ## Adding Text If the text you want to add to the client exists in the relevant `.json` file, use the existing key. Otherwise, create a new key. The English file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files. > [!NOTE] Use English text for all languages if the file is translated through Crowdin. The tests will fail if you don't. It would be nice to keep the keys in the same order across all the files as well. Also, try to put all punctuation, spacing, quotes, etc in the JSON files and not in the components or server files. > [!NOTE] The underscore (`_`) is a reserved character for keys in the client side files. See [the documentation](https://www.i18next.com/translation-function/plurals) for how they are used. ## Helpful Documentation - [react-i18next docs](https://react.i18next.com/latest/usetranslation-hook) - [i18next docs](https://www.i18next.com/translation-function/essentials)