Textfile

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

Source Code

wtf/textfile/

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"
  format: true
  formatStyle: "dracula"
  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.

format
Whether or not to try and format and syntax highlight the displayedtext.
Values: true, false.
Default: false.

formatStyle
The style of syntax highlighting to format the text with.
Values: See Chroma styles for all valid options.
Default: vim.

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.