2025.2.4
Home ▸ Dashboards ▸

To-do list card

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 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). To-do card, list entities.
  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 Variables

Looking for your configuration file?
type string Required

todo-list

entity string Required

The to-do entity to show

title string (Optional)

Title of to-do list.

theme string (Optional)

Override the used theme for this card with any loaded theme. For more information about themes, see the frontend documentation.

hide_completed boolean (Optional, default: false)

Hide the completed items section in the card.

hide_create boolean (Optional, default: false)

Hide the textbox for creating new tasks at the top of the card.

display_order string (Optional, default: none)

Optionally sorts the items in the to-do list for display. Options are: none: Show the list in its original order. alpha_asc: Sort the list in alphabetical order. alpha_desc: Sort the list in reverse alphabetical order. duedate_asc: Sort the list by due date (soonest first). duedate_desc: Sort the list by reverse due date (soonest last).

Examples

Title example:

type: todo-list
entity: todo.todo_list
title: Todo List

Related topics