Option map¶
Which of the 7 variants accept each YAML option, and whether the visual editor has a field for it. Older spellings, which the migration rewrites, are in Deprecated Options.
The gaps and the last columns of the matrix are coverage data for maintainers: a gap is a missing test, example or demo card, not an option that misbehaves.
Gaps¶
| Gap | Options |
|---|---|
| Editor field missing (0) | None |
| No section in configuration.md (0) | None |
| Named in no test (8) | bar_scale, double_tap_action, fast_refresh, force_circular_background, hold_action, icon_double_tap_action, icon_hold_action, min_width |
| Not on the demo dashboard (3) | disable_unit, rows, text_shadow |
| No YAML example in the docs (5) | double_tap_action, hold_action, icon_double_tap_action, icon_hold_action, text_shadow |
Matrix¶
- โ an editor field writes it
- ๐ YAML only
- โ a single value, nothing to edit
- โ not accepted
Readers (files in src/card and src/utils) and Tests (files in
test/) count the files naming the option, not uses. Status is โ
when
all four counts are above zero, else โ ๏ธ and the zeros: a coverage gap, not
an option that misbehaves.
| Option | Card | Template | Badge | Badge Template | Feature | Multi-Card | Multi-Feature | Default | Readers | Examples | Demo | Tests | Status |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alert_when |
โ | โ | โ | โ | โ | โ | โ | โ | 18 | 13 | 26 | 7 | โ |
attribute |
โ | โ | โ | โ | โ | โ | โ | โ | 22 | 2 | 2 | 13 | โ |
badge_color |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 3 | 4 | 3 | โ |
badge_icon |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 3 | 4 | 4 | โ |
bar_aligned ยน |
๐ | ๐ | โ | โ | โ | โ | โ | false |
6 | 2 | 1 | 3 | โ |
bar_color |
โ | โ | โ | โ | โ | โ | โ | โ | 7 | 19 | 54 | 5 | โ |
bar_color_mode |
โ | โ | โ | โ | โ | โ | โ | auto |
8 | 11 | 80 | 2 | โ |
bar_effect |
โ | โ | โ | โ | โ | โ | โ | โ | 8 | 4 | 24 | 3 | โ |
bar_max_width |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 1 | 1 | 3 | โ |
bar_orientation |
โ | โ | โ | โ | โ | โ | โ | ltr |
6 | 4 | 14 | 4 | โ |
bar_position |
โ | โ | โ | โ | โ | โ | โ | default |
18 | 8 | 86 | 12 | โ |
bar_ring |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 3 | 6 | 1 | โ |
bar_scale |
โ | โ | โ | โ | โ | โ | โ | linear |
2 | 1 | 1 | 0 | โ ๏ธ Tests |
bar_segments |
โ | โ | โ | โ | โ | โ | โ | โ | 12 | 2 | 6 | 3 | โ |
bar_single_line |
โ | โ | โ | โ | โ | โ | โ | false |
4 | 1 | 2 | 3 | โ |
bar_size |
โ | โ | โ | โ | โ | โ | โ | small |
14 | 15 | 103 | 9 | โ |
bar_stack |
โ | โ | โ | โ | โ | โ | โ | โ | 14 | 10 | 14 | 4 | โ |
center_zero |
โ | โ | โ | โ | โ | โ | โ | false |
22 | 11 | 53 | 10 | โ |
color |
โ | โ | โ | โ | โ | โ | โ | โ | 45 | 8 | 21 | 16 | โ |
content_order |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 3 | 7 | 3 | โ |
custom_info |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 2 | 17 | 4 | โ |
custom_theme |
โ | โ | โ | โ | โ | โ | โ | โ | 6 | 8 | 12 | 3 | โ |
decimal |
โ | โ | โ | โ | โ | โ | โ | โ | 11 | 9 | 33 | 8 | โ |
density |
โ | โ | โ | โ | โ | โ | โ | default |
11 | 6 | 26 | 7 | โ |
disable_unit ยน |
๐ | โ | ๐ | โ | โ | ๐ | ๐ | false |
5 | 1 | 0 | 9 | โ ๏ธ Demo |
double_tap_action |
โ | โ | โ | โ | โ | โ | โ | {action: none} |
3 | 0 | 4 | 0 | โ ๏ธ Examples, Tests |
entities |
โ | โ | โ | โ | โ | โ | โ | โ | 24 | 13 | 16 | 28 | โ |
entity |
โ | โ | โ | โ | โ | โ | โ | โ | 52 | 135 | 545 | 59 | โ |
fast_refresh |
โ | โ | โ | โ | โ | โ | โ | false |
2 | 3 | 5 | 0 | โ ๏ธ Tests |
force_circular_background |
โ | โ | โ | โ | โ | โ | โ | false |
4 | 2 | 7 | 0 | โ ๏ธ Tests |
frameless |
โ | โ | โ | โ | โ | โ | โ | false |
7 | 4 | 23 | 3 | โ |
height |
โ | โ | โ | โ | โ | โ | โ | โ | 24 | 3 | 31 | 3 | โ |
hide |
โ | โ | โ | โ | โ | โ | โ | [icon, name] |
18 | 9 | 59 | 16 | โ |
hold_action |
โ | โ | โ | โ | โ | โ | โ | {action: none} |
3 | 0 | 4 | 0 | โ ๏ธ Examples, Tests |
icon |
โ | โ | โ | โ | โ | โ | โ | โ | 42 | 18 | 45 | 19 | โ |
icon_animation |
โ | โ | โ | โ | โ | โ | โ | โ | 11 | 10 | 28 | 2 | โ |
icon_double_tap_action |
โ | โ | โ | โ | โ | โ | โ | {action: none} |
2 | 0 | 1 | 0 | โ ๏ธ Examples, Tests |
icon_hold_action |
โ | โ | โ | โ | โ | โ | โ | {action: none} |
2 | 0 | 1 | 0 | โ ๏ธ Examples, Tests |
icon_tap_action |
โ | โ | โ | โ | โ | โ | โ | {action: none} |
3 | 5 | 8 | 1 | โ |
interpolate |
โ | โ | โ | โ | โ | โ | โ | false |
6 | 2 | 1 | 2 | โ |
layout ยน |
โ | โ | โ | โ | โ | โ | โ | horizontal |
24 | 9 | 120 | 13 | โ |
marginless |
โ | โ | โ | โ | โ | โ | โ | false |
8 | 3 | 18 | 1 | โ |
max_value |
โ | โ | โ | โ | โ | โ | โ | 100 |
20 | 29 | 89 | 11 | โ |
min_value |
โ | โ | โ | โ | โ | โ | โ | โ | 19 | 15 | 50 | 11 | โ |
min_width |
โ | โ | โ | โ | โ | โ | โ | โ | 4 | 1 | 1 | 0 | โ ๏ธ Tests |
multiline |
โ | โ | โ | โ | โ | โ | โ | false |
10 | 1 | 3 | 4 | โ |
name |
โ | โ | โ | โ | โ | โ | โ | โ | 45 | 24 | 465 | 36 | โ |
name_info |
โ | โ | โ | โ | โ | โ | โ | โ | 8 | 4 | 4 | 7 | โ |
peak_marker |
โ | โ | โ | โ | โ | โ | โ | {window: 7200, type: line, opacity: 0.8, line_size: 1px} |
22 | 4 | 13 | 13 | โ |
percent |
โ | โ | โ | โ | โ | โ | โ | โ | 25 | 5 | 17 | 13 | โ |
reverse |
โ | โ | โ | โ | โ | โ | โ | false |
9 | 2 | 3 | 2 | โ |
reverse_secondary_info_row |
โ | โ | โ | โ | โ | โ | โ | false |
4 | 2 | 2 | 4 | โ |
rows |
โ | โ | โ | โ | โ | โ | โ | โ | 21 | 1 | 0 | 17 | โ ๏ธ Demo |
secondary |
โ | โ | โ | โ | โ | โ | โ | โ | 13 | 7 | 13 | 7 | โ |
state_content |
โ | โ | โ | โ | โ | โ | โ | โ | 9 | 2 | 8 | 6 | โ |
status_label |
โ | โ | โ | โ | โ | โ | โ | {position: right, color_source: bar} |
11 | 3 | 29 | 4 | โ |
tap_action |
โ | โ | โ | โ | โ | โ | โ | {action: more-info} |
5 | 5 | 15 | 2 | โ |
text_effect |
โ | โ | โ | โ | โ | โ | โ | none |
8 | 1 | 9 | 6 | โ |
text_shadow ยน |
๐ | ๐ | โ | โ | โ | ๐ | ๐ | false |
3 | 0 | 0 | 4 | โ ๏ธ Examples, Demo |
theme |
โ | โ | โ | โ | โ | โ | โ | โ | 39 | 20 | 137 | 14 | โ |
trend_indicator |
โ | โ | โ | โ | โ | โ | โ | {basis: average, threshold: 0, colored: false} |
17 | 3 | 6 | 6 | โ |
unit |
โ | โ | โ | โ | โ | โ | โ | โ | 27 | 8 | 22 | 19 | โ |
unit_position |
โ | โ | โ | โ | โ | โ | โ | after |
3 | 2 | 2 | 2 | โ |
unit_spacing |
โ | โ | โ | โ | โ | โ | โ | auto |
3 | 3 | 5 | 2 | โ |
value_compact |
โ | โ | โ | โ | โ | โ | โ | false |
3 | 2 | 3 | 1 | โ |
value_sign |
โ | โ | โ | โ | โ | โ | โ | false |
3 | 2 | 2 | 1 | โ |
watermark |
โ | โ | โ | โ | โ | โ | โ | {low: 20, high: 80, line_size: 1px, as: auto} |
27 | 7 | 26 | 11 | โ |
Notes¶
ยน Accepted where no editor field writes it, on purpose:
disable_unit: Deprecated: migrates tohide: [unit]. Kept in the schema only for a Jinjahide, which the migration can't edit.text_shadow: Deprecated: migrates totext_effect: shadow; no editor field writes it.layout: Badge, Badge Template and Feature accept a single value: nothing to choose.bar_aligned: Card and Template take a group name, written in YAML. The Multi variants get a toggle.