Documentation for format-time

This commit is contained in:
Benjamin Cheng 2019-09-06 14:53:43 -04:00
parent a63bc84918
commit dc93fa8218
No known key found for this signature in database
GPG Key ID: 4FE22E7528E97BD8

View File

@ -32,6 +32,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
default: {capacity}% ++
The format, how the time should be displayed.
*format-time* ++
typeof: string ++
default: {H} h {M} min ++
The format, how the time should be displayed.
*format-icons*
typeof: array/object
Based on the current capacity, the corresponding icon gets selected. ++
@ -78,6 +83,14 @@ The *battery* module displays the current capacity and state (eg. charging) of y
*{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average.
# TIME FORMAT
The *battery* module allows you to define how time should be formatted via *format-time*.
The two arguments are:
*{H}*: Hours
*{M}*: Minutes
# CUSTOM FORMATS
The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected.