jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 16:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve config flow translation documentation (#2612)

Browse Source 
* Improve config flow translation documentation

* Update core.md
This commit is contained in:
Erik Montnemery 2025-03-20 23:11:40 +01:00 committed by GitHub
parent 6422ed2923
commit 725b911282
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/internationalization/core.md
View File

@ -56,7 +56,11 @@ Strings which are used more than once should be not be duplicated, instead refer
### Config / Options / Subentry flows ### Config / Options / Subentry flows
The translation strings for the configuration flow handler, the option flow handler and config subentry handlers are defined under the `config`, `options` and `config_subentries` keys respectively. An example strings file below describes the different supported keys. Although the example shows translations for a configuration flow, the translations for an option flow is exactly the same. The translation strings for the configuration flow handler, the option flow handler and config subentry handlers are defined under the `config`, `options` and `config_subentries` keys respectively.
Note that `config_subentries` is a map of maps, where the keys are the subentry types supported by the integration.
The example strings file below describes the different supported keys. Although the example shows translations for a configuration flow, the options and subentry flow translations follow the same format.
```json ```json
{ {
@ -96,6 +100,17 @@ The translation strings for the configuration flow handler, the option flow hand
"progress": { "progress": {
"slow_task": "This message will be displayed if `slow_task` is returned as `progress_action` for `async_show_progress`." "slow_task": "This message will be displayed if `slow_task` is returned as `progress_action` for `async_show_progress`."
} }
},
"options": {
// Same format as for config flow
},
"config_subentries": {
"subentry_type_1": {
// Same format as for config flow
},
"subentry_type_2": {
// Same format as for config flow
}
} }
} }
``` ```