X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/89f9a0d9f6a1c2a05762bf1547b65ffdec005e09..c90ee42b5d0e01775e8c4d46f62dc4e7cf9ce9d2:/Widgets.md?ds=inline diff --git a/Widgets.md b/Widgets.md index 53c6f04..42021bd 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,16 +1,27 @@ -[<- home](https://github.com/copycat-killer/lain/wiki) - 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. + +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. + +I'll give an example just to take a grasp, 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) - [bat](https://github.com/copycat-killer/lain/wiki/bat) - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox) -- [calendar](https://github.com/copycat-killer/lain/wiki/caldendar) +- [calendar](https://github.com/copycat-killer/lain/wiki/calendar) - [cpu](https://github.com/copycat-killer/lain/wiki/cpu) - [fs](https://github.com/copycat-killer/lain/wiki/fs) - [imap](https://github.com/copycat-killer/lain/wiki/imap)