X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/eabc5b4991db5cb4dc85551a5814a10f633f72b1..6e6914aa5b1b9e5de69f0769a64b83202122a7d0:/Widgets.md?ds=inline diff --git a/Widgets.md b/Widgets.md index c0a7dd6..8a8945b 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,22 +1,34 @@ -Every widget is output by a `function`. +General usage +------------- -Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. +Every widget is output by a `function`. -This is said because, for some widgets, `function` returns a table to be used for notification and update purposes. +For some widgets, `function` returns a `wibox.widget.textbox`, for others 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. +If it takes a table, you have to define a function variable called `settings` in it, in order to make your customizations. + +To markup the textbox, call `widget:set_markup(...)` within `settings`. + +You can feed `set_markup` with predefined arguments, see the sections for all the details. + +`widget` is a textbox, so you can threat it like any other `wibox.widget.textbox`. -Here follows a simple example, see the sections for all the details: +Here follows an example: mycpu = lain.widgets.cpu({ timeout = 4, settings = function() - widget:set_markup("Cpu " .. usage) + widget:set_markup("Cpu " .. cpu_now.usage) end }) +If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats). + +Index +----- + - [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) @@ -31,4 +43,10 @@ Here follows a simple example, see the sections for all the details: - [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) -- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) \ No newline at end of file +- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) + +Users contributed +---------------- + +- [task](https://github.com/copycat-killer/lain/wiki/task) +- [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat) \ No newline at end of file