From 8bc29ccaa72dc1d05b3d42d714182a5dd4bebde8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:56:10 -0700 Subject: [PATCH] Updated Widgets (markdown) --- Widgets.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index 0772360..2138b27 100644 --- a/Widgets.md +++ b/Widgets.md @@ -2,9 +2,22 @@ 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` returns 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. -Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. +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. + +I'll give an example: + + mycpu = lain.widgets.cpu({ + timeout = 4, + settings = function() + widgets: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) -- 2.39.2