Widgets.md

   1 Every widget is output by a `function`.
   2
   3 Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
   4
   5 This is said because, for some widgets, `function` returns a table to be used for notification and update purposes.
   6
   7 Every widget may take either a table or a list of variables as argument.
   8
   9 If it takes a table, you have to define a function variable called `settings` in it, in order to make your customizations.
  10
  11 To markup the textbox, call `widget:set_markup(...)` within `settings`.
  12
  13 You can feed `set_markup` with predefined arguments, see the sections for all the details.
  14
  15 `widget` is a textbox, so you can also threat it like any other `wibox.widget.textbox`.
  16
  17 Here follows an example:
  18
  19     mycpu = lain.widgets.cpu({
  20         timeout = 4,
  21         settings = function()
  22             widget:set_markup("Cpu " .. usage)
  23         end
  24     })
  25
  26 ---
  27
  28 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
  29 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
  30 - [bat](https://github.com/copycat-killer/lain/wiki/bat)
  31 - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox)
  32 - [calendar](https://github.com/copycat-killer/lain/wiki/calendar)
  33 - [cpu](https://github.com/copycat-killer/lain/wiki/cpu)
  34 - [fs](https://github.com/copycat-killer/lain/wiki/fs)
  35 - [imap](https://github.com/copycat-killer/lain/wiki/imap)
  36 - [maildir](https://github.com/copycat-killer/lain/wiki/maildir)
  37 - [mem](https://github.com/copycat-killer/lain/wiki/mem)
  38 - [mpd](https://github.com/copycat-killer/lain/wiki/mpd)
  39 - [net](https://github.com/copycat-killer/lain/wiki/net)
  40 - [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
  41 - [temp](https://github.com/copycat-killer/lain/wiki/temp)
  42 - [yawn](https://github.com/copycat-killer/lain/wiki/yawn)