l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[doc] add how to create icon-only widgets

Browse source 
fixes #669
This commit is contained in:
tobi-wan-kenobi 2020-06-29 07:51:35 +02:00
parent 9136ebd321
commit e006344dcc
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/development/theme.rst
View file

@ -52,6 +52,21 @@ JSON file located in ``$(THEME_DIRECTORY)/icons/``. The format of the
icon file is identical to the theme itself (as the two are essentially icon file is identical to the theme itself (as the two are essentially
just merged into a single JSON. just merged into a single JSON.
To create an "icon-only" widget (e.g. the play/pause/forward/rewind buttons
of a media player), you need to do the following:
1. In the module, create a widget, and set its state to a descriptive value
(for example `widget.set("state", "next")`
2. In the theme's icon definition JSON, define a `prefix` for that state:
.. code:: json
{
"spotify": {
"next": { "prefix": "<next icon>" }
},
}
Color definitions and pyWAL support Color definitions and pyWAL support
----------------------------------- -----------------------------------