Skip to content

Common Settings

The following settings are common to all modules. Common settings have logical defaults and are all optional. An explicitly-defined common setting will over-ride a module's internal default setting value.

An example with all common settings explicitly configured.

feedreader:
  border: true
  enabled: true
  feeds:
  - https://news.ycombinator.com/rss
  feedLimit: 10
  focusable: false
  focusChar: 2
  position:
    top: 2
    left: 2
    width: 1
    height: 1
  title: "Hacker News"
  refreshInterval: 14400

Attributes

Name 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
focusable
Optional Whether or not this module accepts keyboard focus. Default: false
true, false
focusChar
Optional Define one of the number keys as a shortcut 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.
title
Optional The title to display in the widget's onscreen box.