taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity
wtf/_site/content/posts/modules/todo.md
Chris Cummer 641cd21e9c Add the Todo module to the documentation
2018-05-14 21:04:37 -07:00

1.6 KiB
Raw Blame History

title, date, draft
title date draft
Todo 2018-05-10T12:41:50-07:00 false

Description

todo screenshot

Source Code

wtf/todo/

Required ENV Variables

None.

Keyboard Commands

A basic, 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

Attributes

checkedIcon
The icon used to denote a "checked" todo item.
Values: Any displayable unicode character.

colors.checked
Values: Any X11 color name.

colors.highlight.fore
Values: Any X11 color name.

colors.highlight.back
Values: Any X11 color name.

enabled
Whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

filename
The name for the todo file.
Note: Currently this file must reside in the ~/.wtf/ directory. This is a known bug.
Values: Any valid filename, ideally ending in yml.

position
Where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.