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-08 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update data_entry_flow_index.md (#2040)

Browse Source
This commit is contained in:
Erik Montnemery 2024-01-13 02:41:46 +01:00 committed by GitHub
parent 42c8f92d4f
commit 5311ee458d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/data_entry_flow_index.md
View File

@ -395,7 +395,7 @@ async def handle_result(hass, flow_id, data):
### Show Progress & Show Progress Done ### Show Progress & Show Progress Done
It is possible that we need the user to wait for a task that takes several minutes. If a data entry flow step needs a considerable amount of time to finish, we should inform the user about this.
_The example is about config entries, but works with other parts that use data entry flows too._ _The example is about config entries, but works with other parts that use data entry flows too._
@ -410,7 +410,7 @@ The flow works as follows:
5. The frontend will update each time we call show progress or show progress done. 5. The frontend will update each time we call show progress or show progress done.
6. The config flow will automatically advance to the next step when the progress was marked as done. The user is prompted with the next step. 6. The config flow will automatically advance to the next step when the progress was marked as done. The user is prompted with the next step.
Example configuration flow that includes two show progress tasks. Example configuration flow that includes two show sequential progress tasks.
```python ```python
import asyncio import asyncio
@ -441,7 +441,6 @@ class TestFlow(config_entries.ConfigFlow, domain=DOMAIN):
uncompleted_task = self.task_two uncompleted_task = self.task_two
if uncompleted_task: if uncompleted_task:
return self.async_show_progress( return self.async_show_progress(
step_id="user",
progress_action=progress_action, progress_action=progress_action,
progress_task=uncompleted_task, progress_task=uncompleted_task,
) )