mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-01 11:18:24 +02:00
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
---
|
|
slug: '/api/misc/@docusaurus/eslint-plugin/no-untranslated-text'
|
|
---
|
|
|
|
# no-untranslated-text
|
|
|
|
Enforce text labels in JSX to be wrapped by translate calls.
|
|
|
|
When the [i18n feature](../../../i18n/i18n-introduction.md) 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:
|
|
|
|
```js
|
|
// Hello World is not translated
|
|
<Component>Hello World</Component>
|
|
```
|
|
|
|
Examples of **correct** code for this rule:
|
|
|
|
```js
|
|
// Hello World is translated
|
|
<Component>
|
|
<Translate>Hello World</Translate>
|
|
</Component>
|
|
```
|
|
|
|
## Rule Configuration {#configuration}
|
|
|
|
Accepted fields:
|
|
|
|
<APITable>
|
|
|
|
| Option | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `ignoredStrings` | `string[]` | `[]` | Text labels that only contain strings in this list will not be reported. |
|
|
|
|
</APITable>
|
|
|
|
## When Not To Use It {#when-not-to-use}
|
|
|
|
If you're not using the [i18n feature](../../../i18n/i18n-introduction.md), you can disable this rule. You can also disable this rule where the text is not supposed to be translated.
|
|
|
|
## Further Reading {#further-reading}
|
|
|
|
- https://docusaurus.io/docs/docusaurus-core#translate
|
|
- https://docusaurus.io/docs/docusaurus-core#translate-imperative
|