X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/8bc29ccaa72dc1d05b3d42d714182a5dd4bebde8..dc7eb86389b2d9ebd515029328c61313af73af66:/Widgets.md diff --git a/Widgets.md b/Widgets.md index 2138b27..e812db2 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,23 +1,27 @@ Every widget is output by a `function`. -Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. - -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`. -I'll give an example: +Here follows an example: mycpu = lain.widgets.cpu({ timeout = 4, settings = function() - widgets:set_markup("Cpu " .. usage) + widget:set_markup("Cpu " .. usage) end }) -check the sections for all the details. +--- - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)