To-do: add links between integrations and shopping list card (#31948)

This commit is contained in:
c0ffeeca7 2024-03-19 18:14:20 +01:00 committed by GitHub
parent a454d7371c
commit b97dcb438a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 36 additions and 8 deletions

View File

@ -39,9 +39,14 @@ theme:
### Examples ### Examples
Title Example: Title example:
```yaml ```yaml
type: shopping-list type: shopping-list
title: shopping list title: shopping list
``` ```
## Related topics
- [To-do list integration](/integrations/todo)
- [Local to-do integration](/integrations/local_todo/)

View File

@ -1,5 +1,5 @@
--- ---
title: Local To-do title: Local to-do
description: Instructions on how to use local to-do lists in Home Assistant. description: Instructions on how to use local to-do lists in Home Assistant.
ha_category: ha_category:
- To-do list - To-do list
@ -22,3 +22,8 @@ See the [**To-do list** integration](/integrations/todo) for additional details
about to-do list entities. about to-do list entities.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Related topics
- [**To-do list** integration](/integrations/todo)
- [Shopping list card](/dashboards/shopping-list/)

View File

@ -11,13 +11,13 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
The to-do list integration provides to-do list entities, allowing other integrations The **To-do list** {% term integration %} provides to-do list {% term 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 lists**
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 %}
For example, [Local To-do](/integrations/local_todo/) is a fully local integration to create to-do lists and tasks within your Home Assistant instance, [Shopping list](/integrations/shopping_list) specifically for shopping that can be added to with Assist, or other integrations work with online services providing to-do list data. For example, [Local to-do](/integrations/local_todo/) is a fully local integration to create to-do lists and tasks within your Home Assistant instance, [Shopping list](/integrations/shopping_list) specifically for shopping that can be added to with Assist, or other integrations work with online services providing to-do list data.
## Viewing and managing to-do lists ## Viewing and managing to-do lists
@ -30,12 +30,18 @@ in the main sidebar of your Home Assistant instance.
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.
## Blueprint to add an item to a dedicated list
This blueprint allows you to create a script to add an
item to a pre-configured to-do list.
{% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/add-to-do-item/699193" %}
## 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.get_items` ### Service `todo.get_items`
Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields: Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields:
@ -134,3 +140,8 @@ service: todo.remove_completed_items
target: target:
entity_id: todo.personal_tasks entity_id: todo.personal_tasks
``` ```
## Related topics
- [Local to-do integration](/integrations/local_todo/)
- [Shopping list card](/dashboards/shopping-list/)

View File

@ -14,13 +14,14 @@ Screenshot of the Dashboard list.
## Home Assistant default dashboards ## Home Assistant default dashboards
Home Assistant ships with 5 predefined dashboards: Home Assistant ships with some dashboards out of the box:
- Overview - Overview
- Energy - Energy
- Map - Map
- Logbook - Logbook
- History - History
- To-do lists
Not all of the predefined dashboards are listed under {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}. **Map**, **Logbook**, and **History**, are powered by their respective integrations. Not all of the predefined dashboards are listed under {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}. **Map**, **Logbook**, and **History**, are powered by their respective integrations.
@ -36,6 +37,10 @@ The predefined **Logbook** dashboard is powered by the [Logbook integration](/in
The predefined **History** dashboard is powered by the [History integration](/integrations/history/). To learn about the data sources used and how to export data, refer to the documentation of the History integration. The predefined **History** dashboard is powered by the [History integration](/integrations/history/). To learn about the data sources used and how to export data, refer to the documentation of the History integration.
### To-do lists dashboard
The predefined **To-do lists** dashboard is powered by the [To-do integration](/integrations/todo/). To learn how to use to-do and shopping lists, refer to the documentation of the to-do list integration.
## Creating a new dashboard ## Creating a new dashboard
The default **Overview** dashboard updates itself when you add new devices, as long as you do not edit the default dashboard. If you want a customized dashboard, it is recommended not to change the **Overview** dashboard, but to create a new dashboard instead. The default **Overview** dashboard updates itself when you add new devices, as long as you do not edit the default dashboard. If you want a customized dashboard, it is recommended not to change the **Overview** dashboard, but to create a new dashboard instead.
@ -251,4 +256,5 @@ views:
- [Logbook integration](/integrations/logbook/) - [Logbook integration](/integrations/logbook/)
- [Map integration](/integrations/map/) - [Map integration](/integrations/map/)
- [History integration](/integrations/history/) - [History integration](/integrations/history/)
- [To-do list integration](/integrations/todo/)

View File

@ -27,6 +27,7 @@ In the sidebar on the left, you see the names of different dashboards. Home Assi
- Map - Map
- Logbook - Logbook
- History - History
- To-do lists
## First contact with the Overview dashboard ## First contact with the Overview dashboard