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.
-I'll give an example just to take a grasp, see the sections for all the details:
+`widget` is a textbox, so you can also threat it like any other `wibox.widget.textbox`.
+
+Here follows an example:
mycpu = lain.widgets.cpu({
timeout = 4,
settings = function()
- widgets:set_markup("Cpu " .. usage)
+ widget: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)