home-assistant.io/source/_dashboards/todo-list.markdown

type, title, sidebar_label, description, related

type	title	sidebar_label	description	related
card	To-do list card	To-do list	The to-do list card allows you to add, edit, check-off, and clear items from your to-do list.	docs title /dashboards/dashboards/ Dashboards docs title /integrations/frontend/ Themes docs title /dashboards/cards/ Dashboard cards docs title /integrations/todo To-do list integration documentation docs title /integrations/#to-do-list List of to-do list integrations docs title /integrations/local_todo/ Local to-do integration

The to-do list card allows you to add, edit, check-off, and clear items from your to-do list.

Screenshot of the to-do list card.

Adding a to-do list card

1. Add the card using the Add card button.
   • 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, which is installed by default.
   • This is the same Shopping list as the one on the To-do list dashboard (accessible via sidebar). .
3. The to-do list card can display lists from different 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. type: string {% endconfiguration %}

Examples

Title example:

type: todo-list
entity: todo-list
title: todo list