lain/Widgets.md

1.9 KiB

General usage

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 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.

Here follows an example:

mycpu = lain.widgets.cpu({
    timeout = 4,
    settings = function()
        widget:set_markup("Cpu " .. cpu_now.usage)
    end
})

If you want to see more complex applications, check awesome-copycats.

Index

User contributed widgets