Widgets.md

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