Every one of the projects in this repository is available at the canonical
URL git://git.madduck.net/madduck/pub/<projectpath> — see
each project's metadata for the exact URL.
All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
-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.
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 just to take a grasp, see the sections for all the details:
+Here follows an example:
mycpu = lain.widgets.cpu({
timeout = 4,
settings = function()
mycpu = lain.widgets.cpu({
timeout = 4,
settings = function()
- widgets:set_markup("Cpu " .. usage)
+ widget:set_markup("Cpu " .. cpu_now.usage)
end
})
end
})
+If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats).