Configuration Reference

Configuration Reference

Every option, in one place.

---

Dashboard root

Keys that go at the top level of a dashboard's configuration, alongside views:.

Key	Type	Description
decluttering_templates	mapping	Template definitions, keyed by name. See Defining Templates.
decluttering_templates_from	list of strings, or a single string	URL paths of dashboards to borrow templates from. See Sharing Templates Between Dashboards.
decluttering_defaults (v1.1.0+)	mapping, or a list	Values every template on this dashboard falls back on, reached last of all

decluttering_templates:
  room_light:
    card:
      type: tile
      entity: '[[light]]'

decluttering_templates_from:
  - shared-templates

decluttering_defaults:
  colour: amber

views: []

The same keys in the raw configuration editor, which is where a dashboard in storage mode is edited: ⋮ → Raw configuration editor.

---

Template definition

Whether written under decluttering_templates or as a decluttering-template-plus card.

Key	Type	Required	Description
card	mapping	one of these four	A card
badge	mapping	one of these four	A badge
row	mapping	one of these four	An Entities card row
element	mapping	one of these four	A Picture Elements element
description	string	—	What the template is for. Shown to whoever uses it.
variables	list	—	Descriptions of the variables it takes. See Describing Variables.
default	list, or a mapping	—	Fallback variable values. See Variables.
style	string	—	CSS to inject. See Styling.

Exactly one of card, badge, row, element. Any other combination is an error:

You must define one card, badge, element, or row in the template

---

custom:decluttering-template-plus

Defines a template as a card. Visible only in edit mode.

Key	Type	Required	Description
type	string	✅	custom:decluttering-template-plus
template	string	✅	The template's name
card / badge / row / element	mapping	✅ (one)	The content
description	string	—	What the template is for
variables	list	—	Variable declarations
default	list, or a mapping	—	Fallback variable values
style	string	—	CSS to inject

type: custom:decluttering-template-plus
template: room_light
card:
  type: tile
  entity: '[[light]]'
  name: '[[room]]'
default:
  - light: light.living_room
  - room: Living Room

---

custom:decluttering-card-plus

Uses a template.

Key	Type	Required	Description
type	string	✅	custom:decluttering-card-plus
template	string	✅	Name of the template to use
variables	list, or a mapping	—	Values to substitute
for_each	list	—	Render the template once per item. Card templates only. See Repeating a Template.
for_each_from (v1.1.0+)	mapping	—	What to repeat over, read from Home Assistant rather than written out
columns	number	—	How many copies sit side by side. Defaults to 1
min_column_width (v1.1.0+)	number	—	Pixels. Drops a column rather than going narrower
fit (v1.1.0+)	string	—	box (default) keeps a box of its own; contents gives it up. See Styling
style	string	—	Extra CSS, appended after the template's
style	mapping	—	In a Picture Elements card only, this is the element's position. See Elements.
visibility	list	—	Standard Home Assistant conditions, applied to this card

type: custom:decluttering-card-plus
template: room_light
variables:
  - light: light.kitchen
  - room: Kitchen

---

Variable declaration

One entry of a template's variables: list.

Key	Type	Required	Description
name	string	✅	The variable's name, as written in [[name]]
label	string	—	What the editor calls it. Defaults to the name
description	string	—	Helper text under the control
selector	mapping	—	Any Home Assistant selector. Defaults to a text box
default	any	—	The value to use when a card does not set one

---

Variable syntax

Form	Behaviour
'[[name]]' as an entire value	Substituted with the value, type preserved (number, boolean, mapping, list, null)
[[name]] inside a longer string	Substituted as text
`[[name	slug]]`
`[[name	upper]]/[[name
`[[name	title]]`
Any other word after the bar	Not a transform; left in place
No matching variable or default	Left in place as literal [[name]]

A transformed placeholder is always text, whatever the value's own type.

Precedence	Winner
variables on the card vs any default	variables
default inside a declaration vs the default: list	the declaration
Same key listed twice	the first

Substitution repeats until nothing changes, to a maximum of 10 passes. A self-referencing variable stops there with a console warning.

Full detail: Variables.

---

Host classes

Applied to the wrapper element, for use in style.

Class	Applied to
decluttering-container	Card, row and element templates
decluttering-badge	Badge templates
decluttering-card	Card templates only
decluttering-fit-contents (v1.1.0+)	A card set to fit: contents
child-card-hidden	A card hidden by its own visibility conditions

---

Registered card types

Type	Purpose
custom:decluttering-card-plus	Use a template
custom:decluttering-template-plus	Define a template
custom:decluttering-card	Compatibility alias, when the original card is not installed
custom:decluttering-template	Compatibility alias, when the original card is not installed

See Migrating from decluttering-card.

---

Error messages

Message	Meaning
Missing template object in your config	No template: on the card
Missing template property	No template: on the template card
You must define one card, badge, element, or row in the template	Zero, or more than one, content key
for_each needs a template that defines a card	for_each used with a row, badge or element template
The template "…" doesn't exist in decluttering_templates or in a custom:decluttering-template card	Name not found, and no borrowing configured
The template "…" doesn't exist in decluttering_templates, in a custom:decluttering-template card, or on any dashboard listed in decluttering_templates_from	Name not found anywhere, including borrowed dashboards
Could not retrieve the lovelace configuration.	The card could not find the dashboard config — see Troubleshooting
Could not resolve the template "…": …	A borrowed dashboard could not be read

Console warnings:

Warning	Meaning
gave up substituting variables after 10 passes	A variable refers to itself
could not read the dashboard "…"	A dashboard in decluttering_templates_from is missing or unreadable
<…> is already registered by something else, skipping it	Another card owns that type — usually the original decluttering-card