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: with this you can markup textboxes using predefined variables and do whatever customization you want.
  10
  11 I'll give an example:
  12
  13     mycpu = lain.widgets.cpu({
  14         timeout = 4,
  15         settings = function()
  16             widgets:set_markup("Cpu " .. usage)
  17         end
  18     })
  19
  20 check the sections for all the details.
  21
  22 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
  23 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
  24 - [bat](https://github.com/copycat-killer/lain/wiki/bat)
  25 - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox)
  26 - [calendar](https://github.com/copycat-killer/lain/wiki/calendar)
  27 - [cpu](https://github.com/copycat-killer/lain/wiki/cpu)
  28 - [fs](https://github.com/copycat-killer/lain/wiki/fs)
  29 - [imap](https://github.com/copycat-killer/lain/wiki/imap)
  30 - [maildir](https://github.com/copycat-killer/lain/wiki/maildir)
  31 - [mem](https://github.com/copycat-killer/lain/wiki/mem)
  32 - [mpd](https://github.com/copycat-killer/lain/wiki/mpd)
  33 - [net](https://github.com/copycat-killer/lain/wiki/net)
  34 - [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
  35 - [temp](https://github.com/copycat-killer/lain/wiki/temp)
  36 - [yawn](https://github.com/copycat-killer/lain/wiki/yawn)