X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/e187c6d9853fe09d023066daa1a03ec85cc5be5c..ff3a614d7b45905e0cf969936cb8547ef1f90033:/Widgets.md diff --git a/Widgets.md b/Widgets.md index f6fde73..a798c67 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. + +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) - [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) @@ -19,4 +30,5 @@ We say this because, for some widget, `function` return a table to be used for n - [mpd](https://github.com/copycat-killer/lain/wiki/mpd) - [net](https://github.com/copycat-killer/lain/wiki/net) - [sysload](https://github.com/copycat-killer/lain/wiki/sysload) -- [temp](https://github.com/copycat-killer/lain/wiki/temp) \ No newline at end of file +- [temp](https://github.com/copycat-killer/lain/wiki/temp) +- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) \ No newline at end of file