bottom/docs/content/usage/widgets/battery.md
Clement Tsang ed07fbe1cc
other: Make the battery dependency/features optional (#570)
Allows disabling of the battery dependency through a feature flag. This also aims to disable all related features.
2021-08-19 22:16:44 -04:00

1.4 KiB

Battery Widget

!!! Warning

The battery features are unavailable if the binary is compiled with the `battery` feature disabled!

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