Skip to content

Commit 19a8060

Browse files
Explain menu options description in config flows (#2772)
Co-authored-by: Martin Hjelmare <[email protected]>
1 parent 1e4b4ef commit 19a8060

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/data_entry_flow_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ class TestFlow(config_entries.ConfigFlow, domain=DOMAIN):
549549

550550
### Show menu
551551

552-
This will show a navigation menu to the user to easily pick the next step. The menu labels can be hardcoded by specifying a dictionary of `{step_id: label}` or translated via `strings.json` when specifying a list.
552+
This will show a navigation menu to the user to easily pick the next step. The menu labels can be hardcoded by specifying a dictionary of `{step_id: label}` or translated via `strings.json` under "menu_options" when specifying a list. Additionally menu descriptions can be provided via `strings.json` under "menu_option_descriptions".
553553

554554
```python
555555
class ExampleConfigFlow(data_entry_flow.FlowHandler):
@@ -579,6 +579,10 @@ class ExampleConfigFlow(data_entry_flow.FlowHandler):
579579
"menu_options": {
580580
"discovery": "Discovery",
581581
"manual": "Manual ({model})",
582+
},
583+
"menu_option_descriptions": {
584+
"discovery": "Description of discovery",
585+
"manual": "Description of manual",
582586
}
583587
}
584588
}

0 commit comments

Comments
 (0)