Aire-One
/
awesome-battery_widget
mirror of https://github.com/Aire-One/awesome-battery_widget.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add "Battery widget not appearing" section in readme.

This commit is contained in:
Aire-One 2020-01-28 11:21:36 +01:00
parent da266417ba
commit e2cd3a29e4
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -54,6 +54,17 @@ local my_battery_widget = battery_widget{
You can check the API documentation to read more about statics function to help you to identify your devices.
### Battery widget not appearing
When creating a new instance of `battery_widget`, the widget will not be shown. The widget waits an update from UPower to call the "upower::update" signal and use your attached callback to update (and draw) the widget.
You can however use one of the following method to force the widget to be drawn at its creation:
* Use the parameter `instant_update` to explicitly ask the battery_widget to call the "upower::update" signal at the next Awesome WM cycle.
* Use the parameter `create_callback` to use your own code to initialize the widget. (This callback await the same arguments than the "upower::update" signal)
You can read more about these parameters in the API documentation.
## Dependencies
* [Awesome WM][AwesomeWM]