Modules: Textfile

Displays the contents of the specified text file in the widget.

Source Code

wtf/textfile/

Required ENV Variables

None.

Keyboard Commands

Key: /
Action: Open/close the widget’s help window.

Key: o
Action: Opens the text file in whichever text editor is associated with that file type.

Configuration

textfile:
  enabled: true
  filePath: "~/Desktop/notes.md"
  position:
    top: 5
    left: 4
    height: 2
    width: 1
  refreshInterval: 15

Attributes

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

filePath
The path to the file to be displayed in the widget.

position
Defines 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.