1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-04-19 11:24:24 +02:00
ironbar/docs/modules/Upower.md
Jake Stanger dea66415c2
feat: module-level name and class options
BREAKING CHANGE: To allow for the `name` property, any widgets that were previously targeted by name should be targeted by class instead. This affects **all modules and all popups**, as well as several widgets inside modules. **This will break a lot of rules in your stylesheet**. To attempt to mitigate the damage, a migration script can be found [here](https://raw.githubusercontent.com/JakeStanger/ironbar/master/scripts/migrate-styles.sh) that should get you most of the way.

Resolves #75.
2023-05-06 13:22:35 +01:00

1.7 KiB

Displays system power information such as the battery percentage, and estimated time to empty.

TODO: ADD SCREENSHOT

Configuration

Type: upower

Name Type Default Description
format string {percentage}% Format string to use for the widget button label.
JSON
{
  "end": [
    {
      "type": "upower",
      "format": "{percentage}%"
    }
  ]
}

TOML
[[end]]
type = "upower"
format = "{percentage}%"
YAML
end:
  - type: "upower"
    format: "{percentage}%"
Corn
{
  end = [
    {
      type = "upower"
      format = "{percentage}%"
    }
  ]
}

Styling

Selector Description
.upower Upower widget container.
.upower .icon Upower widget battery icon.
.upower .button Upower widget button.
.upower .button .label Upower widget button label.
.popup-upower Upower popup box.
.popup-upower .upower-details Label inside the popup.

For more information on styling, please see the styling guide.