X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/d614f25b59239cf3688d9d5ef02424a2e289971b..ff3a614d7b45905e0cf969936cb8547ef1f90033:/Widgets.md diff --git a/Widgets.md b/Widgets.md index 8accde9..a798c67 100644 --- a/Widgets.md +++ b/Widgets.md @@ -2,9 +2,20 @@ Every widget is output by a `function`. Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. -We say this because, for some widget, `function` return a table to be used for notification and update purposes. +This is said because, for some widgets, `function` returns a table to be used for notification and update purposes. -Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. +Every widget may take either a table or a list of variables as argument. + +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. + +Here follows a simple example, see the sections for all the details: + + mycpu = lain.widgets.cpu({ + timeout = 4, + settings = function() + widgets:set_markup("Cpu " .. usage) + end + }) - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)