]> git.madduck.net Git - etc/awesome.git/blobdiff - Widgets.md

madduck's git repository

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated sysload (markdown)
[etc/awesome.git] / Widgets.md
index 7c1349e067e08d68dc76f079cc1230d42975a285..e812db21a39db4c60cea9f6906ac50be4e6be059 100644 (file)
@@ -1,19 +1,33 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
+Every widget is output by a `function`.
 
+For some widgets, `function` returns a `wibox.widget.textbox`, for others a table to be used for notification and update purposes.
 
-Every widget is output by a `function`.
+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, 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`.
 
-Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
+Here follows an example: 
 
-We say this because, for some widget, `function` return a table to be used for notification and update purposes.
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            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)
 - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox)
-- [calendar](https://github.com/copycat-killer/lain/wiki/caldendar)
+- [calendar](https://github.com/copycat-killer/lain/wiki/calendar)
 - [cpu](https://github.com/copycat-killer/lain/wiki/cpu)
 - [fs](https://github.com/copycat-killer/lain/wiki/fs)
 - [imap](https://github.com/copycat-killer/lain/wiki/imap)
@@ -22,4 +36,5 @@ We say this because, for some widget, `function` return a table to be used for n
 - [mpd](https://github.com/copycat-killer/lain/wiki/mpd)
 - [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)
\ No newline at end of file
+- [temp](https://github.com/copycat-killer/lain/wiki/temp)
+- [yawn](https://github.com/copycat-killer/lain/wiki/yawn)
\ No newline at end of file