Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.34 KB

no-untranslated-text.md

File metadata and controls

50 lines (32 loc) · 1.34 KB
Raw
slug
/api/misc/@docusaurus/eslint-plugin/no-untranslated-text

no-untranslated-text

import APITable from '@site/src/components/APITable';

Enforce text labels in JSX to be wrapped by translate calls.

When the i18n feature is used, this rule ensures that all labels appearing on the website are translatable, so no string accidentally slips through untranslated.

Rule Details {#details}

Examples of incorrect code for this rule:

// Hello World is not translated
<Component>Hello World</Component>

Examples of correct code for this rule:

// Hello World is translated
<Component>
  <Translate>Hello World</Translate>
</Component>

Rule Configuration {#configuration}

Accepted fields:

Option Type Default Description
ignoredStrings string[] [] Text labels that only contain strings in this list will not be reported.

When Not To Use It {#when-not-to-use}

If you're not using the i18n feature, you can disable this rule. You can also disable this rule where the text is not supposed to be translated.

Further Reading {#further-reading}