Add documentation for to-do list card (#31985)

* Add documentation for to-do list card

* Fix spelling of Todoist

* Update shopping list screenshot

* Update source/_integrations/caldav.markdown

Co-authored-by: Allen Porter <allen.porter@gmail.com>

* Add link to shopping list integration

* Add info that entity has to be added

* Apply suggestions from code review

Co-authored-by: Franck Nijhof <git@frenck.dev>

---------

Co-authored-by: Allen Porter <allen.porter@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7 2024-03-25 11:50:14 +01:00 committed by GitHub
parent 2a85d3eaf6
commit dbb18a192d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 127 additions and 7 deletions

View File

@ -0,0 +1,73 @@
---
type: card
title: "To-do list card"
sidebar_label: To-do list
description: "The to-do list card allows you to add, edit, check-off, and clear items from your to-do list."
---
The to-do list card allows you to add, edit, check-off, and clear items from your to-do list.
<p class='img'>
<img src='/images/dashboards/todo-list_card_shopping-list.png' alt='Screenshot of the to-do list card'>
Screenshot of the to-do list card.
</p>
## Adding a to-do list card
1. [Add the card using the Add card button](/dashboards/cards/#adding-cards-to-your-dashboard).
- In the **By card** dialog, select the **To-do list** card.
2. In the **Entity** dropdown menu, select your list type.
- If it is your first time working with to-do lists, there is only **Shopping list** in the menu.
- This comes from the [shopping list integration](/integrations/shopping_list/), which is installed by default.
- This is the same **Shopping list** as the one on the **To-do list** dashboard (accessible via sidebar).
![To-do card, list entities](/images/dashboards/cards-todo.png).
3. The to-do list card can display lists from different [to-do list](/integrations/#to-do-list) integrations, such as **Bring!** or **Todoist**.
- If you don't see your desired to-do list entity, you need to add its integration first.
- Once you've added a to-do list integration, the lists are also available on the to-do list dashboard.
## YAML configuration
All options for this card can be configured via the user interface.
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
required: true
description: "`todo-list`"
type: string
entity:
required: true
description: The to-do entity to show
type: string
title:
required: false
description: Title of to-do list.
type: string
theme:
required: false
description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/).
type: string
{% endconfiguration %}
### Examples
Title example:
```yaml
type: todo-list
entity: todo-list
title: todo list
```
## Related topics
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [Local to-do integration](/integrations/local_todo/)
### Dashboards, cards, and themes
- [Dashboards](/dashboards/dashboards/)
- [Dashboard cards](/dashboards/cards/)
- [Themes](/integrations/frontend/)

View File

@ -15,8 +15,15 @@ ha_platforms:
- todo
---
The **Bring** integration allows you to interact with your [Bring!](https://www.getbring.com/) shopping lists within Home Assistant.
The **Bring!** integration allows you to interact with your [Bring!](https://www.getbring.com/) shopping lists within Home Assistant.
For authentication, the integration requires the `email` and `password` you used for your Bring! account. If you want to automatically receive notifications via the Bring! app when Home Assistant adds or removes an item from the list, you should use a dedicated account (such as `email: your.name+ha@gmail.com`) to connect Home Assistant with [Bring!](https://www.getbring.com/).
{% include integrations/config_flow.md %}
## Related topics
- [Bring!](https://www.getbring.com/)
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

View File

@ -14,7 +14,7 @@ ha_integration_type: integration
ha_config_flow: true
---
The CalDAV integration allows you to connect your WebDAV calendar to Home Assistant
The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant
as one of these entity types:
- A [calendar](/integrations/calendar) entity which can be used to trigger automations based on the start or end of an event using criteria such as the event name or description.
@ -203,3 +203,13 @@ to generate a new password for use by Home Assistant to avoid sharing your iClou
password.
{% enddetails %}
## Related topics
- [Calendar](/integrations/calendar)
### To-do list
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

View File

@ -19,7 +19,7 @@ each task list, allowing you to create, update, or delete items on the list from
<div class='note'>
The Google Tasks public API does not support viewing or setting the due time of tasks, only the due date.
The Google Tasks public API does not support viewing or setting the due time of tasks, only the due date.
</div>
@ -78,3 +78,14 @@ The integration setup will next give you instructions to enter the [Application
## Troubleshooting
If you have an error with your credentials, you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
## Related topics
- [Google Tasks](https://support.google.com/tasks/answer/7675772)
- [Google Developers Console](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
### To-do list
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

View File

@ -26,4 +26,4 @@ about to-do list entities.
## Related topics
- [**To-do list** integration](/integrations/todo)
- [Shopping list card](/dashboards/shopping-list/)
- [To-do list card](/dashboards/todo-list/)

View File

@ -18,3 +18,10 @@ This integration connects with an [OurGroceries](https://www.ourgroceries.com/)
It adds a [to-do list entity](/integrations/todo) for each shopping list, allowing you to create, update, or delete items on the list from the **To-do list** dashboard.
{% include integrations/config_flow.md %}
## Related topics
- [OurGroceries](https://www.ourgroceries.com/)
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

View File

@ -16,7 +16,7 @@ ha_platforms:
The `shopping_list` integration allows you to keep track of shopping list items.
Your shopping list will be accessible from the sidebar, and you can optionally add the [shopping list card](/dashboards/shopping-list/) to your dashboard. With the [conversation integration](/integrations/conversation/) you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
Your shopping list will be accessible from the sidebar, and you can optionally add the [To-do list card](/dashboards/todo-list/) to your dashboard. With the [conversation integration](/integrations/conversation/), you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
{% include integrations/config_flow.md %}

View File

@ -144,4 +144,4 @@ target:
## Related topics
- [Local to-do integration](/integrations/local_todo/)
- [Shopping list card](/dashboards/shopping-list/)
- [To-do list card](/dashboards/todo-list/)

View File

@ -19,7 +19,7 @@ ha_config_flow: true
This platform allows you to connect to your [Todoist projects](https://todoist.com) as [todo](/integrations/todo/) or [calendar](/integrations/calendar/) entities. All tasks get updated roughly every 15 minutes.
A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
## Prerequisites
@ -194,3 +194,15 @@ Here are two example JSON payloads resulting in the same task:
Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl`
- **reminder_date** (*Optional*): When should the user be reminded of this task, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format (in UTC timezone). Mutually exclusive with `reminder_date_string`.
## Related topics
- [Todoist projects](https://todoist.com)
- [Calendar](/integrations/calendar/)
## To-do list
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)-
- [Dashboards](/dashboards/dashboards/)

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB