From 5e0bf517f010a10a46bea871e7da2f7601f06842 Mon Sep 17 00:00:00 2001 From: Joonatan Date: Mon, 18 Sep 2023 17:18:01 +0300 Subject: [PATCH] chore: update readme --- .../UserConfigs/BatteryComponentConfig.cs | 18 ++++++------ README.md | 28 +++++++++++++------ 2 files changed, 29 insertions(+), 17 deletions(-) diff --git a/GlazeWM.Domain/UserConfigs/BatteryComponentConfig.cs b/GlazeWM.Domain/UserConfigs/BatteryComponentConfig.cs index b27024af5..8866e4d45 100644 --- a/GlazeWM.Domain/UserConfigs/BatteryComponentConfig.cs +++ b/GlazeWM.Domain/UserConfigs/BatteryComponentConfig.cs @@ -19,38 +19,38 @@ public class BatteryComponentConfig : BarComponentConfig /// /// Formatted text to display when the device is draining battery power and battery level is low. /// - public string LabelDrainingLow { get; set; } = "Low {battery_level}%"; + public string LabelDrainingLow { get; set; } = "{battery_level}% (low)"; /// /// Formatted text to display when the device is draining battery power and battery level is medium. /// - public string LabelDrainingMedium { get; set; } = "Medium {battery_level}%"; + public string LabelDrainingMedium { get; set; } = "{battery_level}% (medium)"; /// /// Formatted text to display when the device is draining battery power and battery level is high. /// - public string LabelDrainingHigh { get; set; } = "High {battery_level}%"; + public string LabelDrainingHigh { get; set; } = "{battery_level}% (high)"; /// /// Formatted text to display when the device is in power saving mode and battery level is low. /// - public string LabelPowerSaverLow { get; set; } = "Low {battery_level}% (power saver)"; + public string LabelPowerSaverLow { get; set; } = "{battery_level}% (power saver) (low)"; /// /// Formatted text to display when the device is in power saving mode and battery level is medium. /// - public string LabelPowerSaverMedium { get; set; } = "Medium {battery_level}% (power saver)"; + public string LabelPowerSaverMedium { get; set; } = "{battery_level}% (power saver) (medium)"; /// /// Formatted text to display when the device is in power saving mode and battery level is high. /// - public string LabelPowerSaverHigh { get; set; } = "High {battery_level}% (power saver)"; + public string LabelPowerSaverHigh { get; set; } = "{battery_level}% (power saver) (high)"; /// /// Formatted text to display when the device is connected to power and battery level is low. /// - public string LabelChargingLow { get; set; } = "Low {battery_level}% (charging)"; + public string LabelChargingLow { get; set; } = "{battery_level}% (charging) (low)"; /// /// Formatted text to display when the device is connected to power and battery level is medium. /// - public string LabelChargingMedium { get; set; } = "Medium {battery_level}% (charging)"; + public string LabelChargingMedium { get; set; } = "{battery_level}% (charging) (medium)"; /// /// Formatted text to display when the device is connected to power and battery level is high. /// - public string LabelChargingHigh { get; set; } = "High {battery_level}% (charging)"; + public string LabelChargingHigh { get; set; } = "{battery_level}% (charging) (high)"; } } diff --git a/README.md b/README.md index d1f939e74..30e76fa1e 100644 --- a/README.md +++ b/README.md @@ -297,11 +297,17 @@ Additionally supported format specifiers: ### Bar Component: Battery The battery component displays the system's battery level in percent. -There are three labels available that can be customized: - -- `label_draining`: used when the system is draining battery power(i.e. not charging). -- `label_power_saver`: used when the system is on power saving mode. -- `label_charging`: used when the system is connected to power. +There are nine labels available that can be customized: + +- `label_draining_low`: used when the system is draining battery power(i.e. not charging) and the battery level is low. +- `label_draining_medium`: used when the system is draining battery power(i.e. not charging) and the battery level is medium. +- `label_draining_high`: used when the system is draining battery power(i.e. not charging) andthe battery level is high. +- `label_power_saver_low`: used when the system is on power saving mode and the battery level is low. +- `label_power_saver_medium`: used when the system is on power saving mode and the battery level is medium. +- `label_power_saver_high`: used when the system is on power saving mode and the battery level is high. +- `label_charging_low`: used when the system is connected to power and the battery level is low. +- `label_charging_medium`: used when the system is connected to power and the battery level is medium. +- `label_charging_high`: used when the system is connected to power and the battery level is high. `{battery_level}` is a variable which is replaced by the actual battery level when the label is displayed. @@ -309,9 +315,15 @@ There are three labels available that can be customized: ```yaml - type: "battery" - label_draining: "{battery_level}% remaining" - label_power_saver: "{battery_level}% (power saver)" - label_charging: "{battery_level}% (charging)" + label_draining_low: "{battery_level}% remaining (low)" + label_draining_medium: "{battery_level}% remaining (medium)" + label_draining_high: "{battery_level}% remaining (high)" + label_power_saver_low: "{battery_level}% (power saver) (low)" + label_power_saver_medium: "{battery_level}% (power saver) (medium)" + label_power_saver_high: "{battery_level}% (power saver) (high)" + label_charging_low: "{battery_level}% (charging) (low)" + label_charging_medium: "{battery_level}% (charging) (medium)" + label_charging_high: "{battery_level}% (charging) (high)" ``` ### Bar Component: CPU Usage