Files
bottom/docs/content/usage/widgets/battery.md
T
Clement Tsang 06071d5abf docs: migrate documentation over to mkdocs (#506)
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs.

Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 01:40:58 -04:00

1.3 KiB

Battery Widget

The battery widget provides information about batteries on the system.

A picture of an expanded battery widget.

The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

Features

The following data is displayed for batteries:

  • Charge percent
  • Consumption
  • Time to empty/charge, based on the current state
  • Battery health percent

The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

Key bindings

Note that key bindings are generally case-sensitive.

Binding Action
++left++
++h++
++alt+h++
Moves to the battery entry to the left of the current one
++right++
++l++
++alt+l++
Moves to the battery entry to the right of the current one

Mouse bindings

Binding Action
++lbutton++ Selects a battery entry