Navigation :

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	Description	Value
`border`	Optional Whether or not to draw this widget with a border. Default: `true`.	true, false
`colors.checked`	The foreground color for checked rows.	Any X11 color name.
`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.
`enabled`	Optional Whether or not this module is executed and if its data displayed onscreen. Default: `false`.	true, false
`filename`	The name for the todo file.	Any valid filename, ideally ending in `yml`.
`focusChar`	Optional Define one of the number keys as a short cut key to access the widget.	0..9
`position`	Defines where in the grid this module’s widget will be displayed.
`refreshInterval`	Optional How often, in seconds, this module will update its data. Default: `300`.	Any positive integer.

Keyboard Controls

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

`↓`	Select the next item in the list
`↑`	Select the previous item in the list

`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

wtf/modules/todo/