Documentation for `format-time`
This commit is contained in:
parent
a63bc84918
commit
dc93fa8218
|
@ -32,6 +32,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
|
||||||
default: {capacity}% ++
|
default: {capacity}% ++
|
||||||
The format, how the time should be displayed.
|
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*
|
*format-icons*
|
||||||
typeof: array/object
|
typeof: array/object
|
||||||
Based on the current capacity, the corresponding icon gets selected. ++
|
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}*: 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
|
# CUSTOM FORMATS
|
||||||
|
|
||||||
The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected.
|
The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected.
|
||||||
|
|
Loading…
Reference in New Issue