jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct spelling of to-do list (#29773)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Franck Nijhof 2023-11-10 10:21:31 +01:00 committed by GitHub
parent e2859a94a6
commit a319e8d1a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_integrations/todo.markdown
View File

@ -1,6 +1,6 @@
--- ---
title: To-do title: To-do list
description: Instructions on how to use To-do Lists within Home Assistant. description: Instructions on how to use to-do lists within Home Assistant.
ha_domain: todo ha_domain: todo
ha_release: 2023.11 ha_release: 2023.11
ha_category: ha_category:
@ -11,32 +11,32 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
The To-do List integration provides todo list entities, allowing other integrations The to-do list integration provides to-do list entities, allowing other integrations
to integrate To-do Lists into Home Assistant. To-do lists are shown on the To-do list to integrate to-do lists into Home Assistant. To-do lists are shown on the to-do list
dashboard for tracking items and whether or not they have been completed. dashboard for tracking items and whether or not they have been completed.
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
## Viewing and managing To-do lists ## Viewing and managing to-do lists
Each To-do list is represented as its own entity in Home Assistant and can be Each to-do list is represented as its own entity in Home Assistant and can be
viewed and managed on a to-do list dashboard. You can find the to-do list dashboard viewed and managed on a to-do list dashboard. You can find the to-do list dashboard
in the main sidebar of your Home Assistant instance. in the main sidebar of your Home Assistant instance.
## The state of a To-do List entity ## The state of a to-do list entity
The state of a To-do List entity is a number, which represents the number of The state of a to-do list entity is a number, which represents the number of
incomplete items in the list. incomplete items in the list.
## Services ## Services
Some To-do List integrations allow Home Assistant to manage the To-do Items in the list. The Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The
services provided by some To-do List entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/). services provided by some to-do list entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
### Service `todo.add_item` ### Service `todo.add_item`
Add a new To-do Item. A To-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
| Service data attribute | Optional | Description | Example | | Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------| | ---------------------- | -------- | ----------- | --------|
@ -49,21 +49,21 @@ service: todo.add_item
target: target:
entity_id: todo.personal_tasks entity_id: todo.personal_tasks
data: data:
item: "Submit Income Tax Return" item: "Submit income tax return"
``` ```
### Service `todo.update_item` ### Service `todo.update_item`
Update a To-do Item. A To-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: Update a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
| Service data attribute | Optional | Description | Example | | Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------| | ---------------------- | -------- | ----------- | --------|
| `item` | no | The name of the to-do Item to update. | Submit income tax return | `item` | no | The name of the to-do item to update. | Submit income tax return
| `rename` | yes | The new name of the to-do Item. | Something else | `rename` | yes | The new name of the to-do item. | Something else
| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` | `status` | yes | The overall status of the to-do item. | `needs_action` or `completed`
At least one of `rename` or `status` is required. This is a full example of At least one of `rename` or `status` is required. This is a full example of
a service call that updates the status and the name of a to-do Item. a service call that updates the status and the name of a to-do item.
```yaml ```yaml
service: todo.update_item service: todo.update_item
@ -77,7 +77,7 @@ data:
### Service `todo.remove_item` ### Service `todo.remove_item`
Removing a To-do Item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields: Removing a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields:
| Service data attribute | Optional | Description | Example | | Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------| | ---------------------- | -------- | ----------- | --------|