Customizing to-do task states

Trilium features customizable to-do list task states. To customize them, go to "Options" → "Text Notes" → "Related Settings" → "Custom checkbox states for to-do lists". Alternatively, right-click a checkbox in an editable text note and click the pencil icon.

Creating a new task state#

Click the plus icon next to Task States in the left-side pane, then define the task details as described in the next section.

Editing a task state#

Selecting any state other than "None" and "Done" (which cannot be modified) from the side pane reveals the following editable fields:

• Icon (required): The symbol shown inside the checkbox. You can pick an icon just as you would for any regular note, including from custom icon packs.
• Title (required): The name of the task state shown in the UI. For example: "Doing", "Postponed".
• Identifier (required): A short name for the state, using only letters, digits, "-" and "_". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.
  Prefix the identifiers of your custom task states with an underscore "_" or a hyphen "-" to avoid clashes with task states that may be introduced in future versions of Trilium.
• Markdown symbol: A single character used to represent the state in Markdown syntax. For example, "#" creates a task state that can be applied in Markdown using " - [#] ". Make sure no other task state uses the same symbol.
• Counts as completed: If checked, the task is treated as completed.
• Color: The color of the checkbox. Its lightness and saturation are adjusted automatically to match the current color scheme or theme.
• Hidden from toolbar: The state is not listed in the UI. This is useful when you want existing notes to keep rendering the state correctly but no longer need to apply it yourself.

Reordering task states#

To change the order in which task states appear in the UI and when cycling through them with the keyboard, simply reorder the states in the side pane (or tree panel, if it's the case).

Deleting task states#

Any task state other than "None" and "Done" can be deleted.

Once deleted, to-do items using that state will no longer display the custom checkbox. They fall back to either a "None" or "Done" state, depending on the state's "Counts as completed" setting. The identifier and title remain stored in the note until you set the checkbox to a new state.

Transferring notes with custom task states between Trilium database instances#

Exporting notes to another Trilium database instance preserves the task states of to-do items, but does not include the custom task definitions. As a result, the destination instance won't know how to render the checkbox unless you recreate the task state there with the same identifier and Markdown symbol.