Skip to content

Battery Module

Sam edited this page Aug 9, 2024 · 6 revisions

The battery module displays your current batteries and their percentages. It creates a new line per battery.

Using

Insert into the modules array.

Configuration

  • title -> (String) The module title. Contains a singular {index} placeholder.
  • format -> (String) The format used to display the module. Check below to see available placeholders.
  • title_color -> (Optional/String) Override the title color to be used.
  • title_bold -> (Optional/Bool) Make the title bold.
  • title_italic -> (Optional/Bool) Make the title italic.
  • separator -> (Optional/Char) Override the separator to be used.
  • progress_left_border -> (Optional/Char) The left border character of the progress bar.
  • progress_right_border -> (Optional/Char) The right border character of the progress bar.
  • progress_progress -> (Optional/Char) The character used to fill in the progress bar.
  • progress_empty -> (Optional/Char) The character used to fill in empty space in the progress bar.
  • progress_target_length -> (Optional/Number) The target length of the progress bar.
  • decimal_places -> (Optional/Number) Override the decimal places to be displayed.
format placeholders;
  • {index} -> The index of the battery.
  • {percentage} -> The percentage the battery is at.
  • {bar} -> A progress bar representing the battery level.
Default Configuration
[battery]
title = "Battery {index}"
format = "{percentage}%"

Example

modules = [
    "battery"
]

[battery]
title = "Battery"
format = "{percentage}%"