Skip to content

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 to hide: [unit]. Kept in the schema only for a Jinja hide, which the migration can't edit.
  • text_shadow: Deprecated: migrates to text_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.