Textfile

textfile screenshot

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

Configuration

textfile:
  enabled: true
  filePaths:
  - "~/Desktop/notes.md"
  - "~/.config/wtf/config.yml"
  format: true
  formatStyle: "dracula"
  position:
    top: 5
    left: 4
    height: 2
    width: 1
  refreshInterval: 15
  wrapText: true

Name Description Value
border Optional Whether or not to draw this widget with a border. Default: true. true, false
enabled Optional Whether or not this module is executed and if its data displayed onscreen. Default: false. true, false
filePaths An array of paths to the files to be displayed in the widget.
focusChar Optional Define one of the number keys as a short cut key to access the widget. 0..9
format Optional Whether or not to try and format and syntax highlight the displayedtext. Default: false. true, false
formatStyle Optional The style of syntax highlighting to format the text with. Default: vim. See Chroma styles for all valid options.
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.
wrapText Optional Whether or not to wrap the text when it hits the widget boundary. Default: true. true, false

Keyboard Controls

Key Action
/ Open/close the widget’s help window
[return] Open current file
h Select previous file
l Select next file
o Opens the text file in whichever text editor is associated with that file type
r Refresh the data
Select previous file
Select next file

Source Code

wtf/modules/textfile/