Skip to content

Commit db91a00

Browse files
committed
Edit
1 parent c768a3a commit db91a00

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties/design-properties-10.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -744,15 +744,15 @@ In that situation, you can combine **Dropdown**, **Colorpicker**, **ToggleButton
744744
745745
When the **Small** option is selected, the `borderRadiusSmall` class will be applied to the widget. On the other hand, when **Large** is selected, the `--radius-large` variable will be assigned to the `border-radius` property of the widget.
746746
747-
## Translating design properties
747+
## Translating Design Properties
748748
749-
Design properties can be translated to match the users preferred user interface language. This includes the name of the design property, its description and any of its options, if it has any, as shown in the styling properties panel. The provided translations do not affect the behavior of the design property.
749+
Design properties can be translated to match the end-user's preferred user interface language. This includes the name of the design property, its description, and any of its options (if it has any) as shown in the **Properties** tab. The provided translations do not affect the behavior of the design property.
750750
751-
To provide translations for your design properties, create a file *locales/{language-code}/translation.json* in the Styling folder of your module. The language code can be any of the user interface languages supported by Studio Pro, such as *en-US*, *ja-JP*, *ko-KR* or *zh-CN*. Other files in the *locales/{language-code}* folders will be ignored. As a result, custom namespaces can't be used. The resulting structure could look like this:
751+
To provide translations for your design properties, create a file *locales/{language-code}/translation.json* in the **Styling** folder of your module. The language code can be any of the user interface languages supported by Studio Pro, such as *en-US*, *ja-JP*, *ko-KR*, or *zh-CN*. Other files in the **locales/{language-code}** folders will be ignored. As a result, custom namespaces cannot be used. As an example, a resulting structure could look like this:
752752
753753
{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/translations.png" alt="A translation.json file in the Styling/locales/de-DE folder" class="no-border" >}}
754754
755-
These json files follow the format used by the I18next library, specifically v3. See [their documentation on the format](https://www.i18next.com/misc/json-format) for more information. For example to translate a design property with the name *Text align* with the options *left*, *center* and *right*, the contents of *locales/ko-KR/translation.json* might look something like this:
755+
These JSON files follow the format used by the i18next library, specifically v3. See the [the i18next JSON format documentation](https://www.i18next.com/misc/json-format) for more information. For example to translate a design property with the name **Text align** with the options **left**, **center** and **right**, the contents of *locales/ko-KR/translation.json* might look something like this:
756756
757757
758758
```json
@@ -764,12 +764,12 @@ These json files follow the format used by the I18next library, specifically v3.
764764
}
765765
```
766766
767-
All design properties and options with the same name will be translated the same way, even if they are defined in different modules. When two or more modules define a translation for the same design property or design property option, the one used is not guaranteed to be the same as the one outlined in [Extending or Overriding Design Properties of Other Modules](#extend-existing-design-properties). As a result, it is recommended to only translate design properties and design property options in the same module in which they are defined.
767+
All design properties and options with the same name will be translated the same way, even if they are defined in different modules. When two or more modules define a translation for the same design property or design property option, the one used is not guaranteed to be the same as the one outlined in [Extending or Overriding Design Properties of Other Modules](#extend-existing-design-properties). As a result, we recommend to only translate design properties and design property options in the same module in which they are defined.
768768
769-
If a translation is not available, the names and descriptions as defined in the *design-properties.json* are used as a fallback instead. For example, the user changes their settings to work with Studio Pro in Korean, but the module does not have a *locales/ko-KR/translation.json* file. This can also happen if the name of a design property, any of its options or descriptions are missing from the corresponding *translation.json* file.
769+
If a translation is not available, the names and descriptions as defined in *design-properties.json* are used as a fallback instead. For example, the user changes their settings to work with Studio Pro in Korean, but the module does not have a *locales/ko-KR/translation.json* file. This can also happen if the name of a design property, any of its options or descriptions are missing from the corresponding *translation.json* file.
770770
771771
{{% alert color="warning" %}}
772-
When adding translations for existing design properties, do not change the name of existing design properties or their options as defined in *design-properties.json*. Those names cannot be changed easily when there are apps already using them. See the [Renaming Design Properties](#old-names) section.
772+
When adding translations for existing design properties, do not change the name of existing design properties or their options as defined in *design-properties.json*. Those names cannot be changed easily when there are apps already using them. For more information, see the [Renaming Design Properties](#old-names) section above.
773773
{{% /alert %}}
774774
775775
## Read More

0 commit comments

Comments
 (0)