Skip to content

Todo

An interactive todo list.

Configuration

todo:
  checkedIcon: "X"
  colors:
    checked: gray
    highlight:
      fore: "black"
      back: "orange"
  enabled: true
  filename: "todo.yml"
  position:
    top: 2
    left: 2
    height: 2
    width: 1
  refreshInterval: 3600

Screenshots

todo screenshot

Attributes

Name Value
checked
The foreground color for checked rows.
Any X11 color name or long-form hex value (i.e.: #ff0000).
colors.highlight.fore
The foreground color for the currently-selected row.
Any X11 color name.
colors.highlight.back
The background color for the currently-selected row.
Any X11 color name.
checkedIcon
Optional The icon used to denote a 'checked' todo item.
Any displayable unicode character.
filename
The name for the todo file.
Any valid filename, ideally ending in yml.

## Keyboard

Key Action
/ Open/close the widget's help modal
[esc] Remove focus from the selected item
[esc] Close the modal item dialog without saving changes
[return] Edit the selected item
[return] Close the modal item dialog and save changes
[space] Check/uncheck the selected item
j Select the next item in the list
k Select the previous item in the list
n Create a new list item
o Opens the todo list file in whichever text editor is associated with that file type
r Refresh the data
Ctrl-d Delete the selected item
Ctrl-j Move the selected item down the list
Ctrl-k Move the selected item up the list

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/todo