Decluttering Card

📝 Reuse multiple times the same card configuration with variables to declutter your config.

This card is for Lovelace on Home Assistant.

We all use multiple times the same block of configuration across our lovelace configuration and we don't want to change the same things in a hundred places across our configuration each time we want to modify something.

decluttering-card to the rescue!! This card allows you to reuse multiple times the same configuration in your lovelace configuration to avoid repetition and supports variables and default values.

Configuration

Defining your templates

There are two ways to define your templates. You can use both methods together.

Option 1. Create a template as a card with the visual editor or with YAML.

Add a Custom: Decluttering template card in any view of your dashboard to define your template, set variables with their default values, and preview the results with those defaults with the visual editor. The card type is custom:decluttering-template in YAML.

You can place the template card anywhere and it will only visible when the dashboard is in edit mode. Each template must have a unique name.

Example:

type: custom:decluttering-template
template: follow_the_sun
card:
  type: entity
  entity_id: sun.sun

Option 2. Create a template at the root of your lovelace configuration.

Open your dashboard's YAML configuration file or click on the Raw configuration editor menu item in the dashboard.

The templates are defined in an object at the root of your lovelace configuration. This object is named decluttering_templates and it contains your template declarations. Each template must have a unique name.

Example:

title: Example Dashboard
decluttering_templates:
  follow_the_sun:
    card:
      type: entity
      entity_id: sun.sun
  touch_the_sun:
    row:
      type: button
      entity: sun.sun
      action_name: Boop
  hello_sunshine:
    element:
      type: icon
      icon: mdi:weather-sunny
      title: Hello!
      style:
        color: yellow
views:

Syntax:

decluttering_templates:
  <template name>:
    <template content>
  [...]

Adding content to your templates

You can make decluttering templates for cards, entity rows, and picture elements. Each content type has a different syntax and can be used in different places.

Card

A decluttering template can hold a standard dashboard card, custom card, or another decluttering card. It is particularly useful for complex cards such as stacks, grids, and tiles.

Example:

type: custom:decluttering-template
template: follow_the_sun
card:
  type: entity
    entity_id: sun.sun

Syntax:

type: custom:decluttering-template
template: <template_name>
card:
  # This is where you put your [Card](https://www.home-assistant.io/dashboards/cards/) configuration (it can be a card embedding other cards)
  type: <card_type>
    [...]
default:
  # An optional list of variables and their default values to substitute into the template
  - <variable_name>: <variable_value>
  - <variable_name>: <variable_value>
  [...]

Entities card row

A decluttering template can hold an Entities card row such as a Button row or a Conditional row.

Example:

type: custom:decluttering-template
template: touch_the_sun
row:
  type: button
  entity: sun.sun
  action_name: Boop

Syntax:

type: custom:decluttering-template
template: <template_name>
row:
  # This is where you put your [Entities card](https://www.home-assistant.io/dashboards/entities/) row
  type: <element_type>
    [...]
default:
  # An optional list of variables and their default values to substitute into the template
  - <variable_name>: <variable_value>
  - <variable_name>: <variable_value>
  [...]

Picture elements card element

A decluttering template can hold a Picture elements card element such as an Icon or an Image.

Example:

type: custom:decluttering-template
template: hello_sunshine
element:
  type: icon
  icon: mdi:weather-sunny
  title: Hello!
  style:
    color: yellow

Syntax:

type: custom:decluttering-template
template: <template_name>
element:
  # This is where you put your [Picture elements card](https://www.home-assistant.io/dashboards/picture-elements/) element configuration
  type: <element_type>
    [...]
default:
  # An optional list of variables and their default values to substitute into the template
  - <variable_name>: <variable_value>
  - <variable_name>: <variable_value>
  [...]

Variables

Templates can contain variables. Each variable will later be replaced by a real value when you instantiate a card which uses this template.

A variable needs to be enclosed in double square brackets [[variable_name]]. If a variable is alone on its line, enclose it in single quotes: '[[variable_name]]'.

You can also define default values for your variables in the default object. The visual editor uses the provided default values to render the preview.

Example:

type: custom:decluttering-template
template: touch_anything
row:
  type: button
  entity: '[[what]]'
  action_name: '[[how]]'
default:
  what: sun.sun
  how: 'Boop'

Using the card

If your template content is a card, add a Custom: Decluttering card to your dashboard to instantiate your template, set variables, and preview the results with the visual editor. The card type is custom:decluttering-template in YAML.

If your template content is an Entities card row, first add a Entities card to your dashboard or open an existing one. Then switch to the code editor and add a new item to the entities list in YAML as shown below.

If your template content is an Picture elements card element, first add a Picture elements to your dashboard or open an existing one. Then switch to the code editor and add a new item to the elements list in YAML as shown below.

You can also use templates in different places than they were intended. For example, an Entities card row or Picture elements card element can be displayed as a card in the dashboard but it might not look right.

Example which references the previous templates:

type: vertical-stack
cards:
  # A card
  - type: custom:decluttering-card
    template: follow_the_sun
  # An Entities card
  - type: entities
    entities:
      # An entity row
      - type: custom:decluttering-card
        template: touch_the_sun
      # An entity row with variables using default values
      - type: custom:decluttering-card
        template: touch_anything
      # An entity row with variables using specified values
      - type: custom:decluttering-card
        template: touch_anything
        variables:
          - what: sensor.moon_phase
          - how: 'Kiss'
  # A Picture elements card
  - type: picture-elements
    elements:
      - type: custom:decluttering-card
        template: hello_sunshine
        style:
          top: 50%
          left: 33%
      - type: custom:decluttering-card
        template: hello_sunshine
        style:
          top: 50%
          left: 66%

Syntax:

Name	Type	Requirement	Description
type	string	Required	custom:decluttering-card
template	object	Required	Name of your template
variables	list	Optional	List of variables and their values to replace in the template content

Installation

Using HACS

Manually

Step 1

Save decluttering-card to <config directory>/www/decluttering-card.js on your Home Assistant instanse.

Example:

wget https://github.com/raw/custom-cards/decluttering-card/master/dist/decluttering-card.js
mv decluttering-card.js /config/www/

Step 2

Link decluttering-card inside your ui-lovelace.yaml or Raw Editor in the UI Editor

resources:
  - url: /local/decluttering-card.js
    type: module

Troubleshooting

See this guide: Troubleshooting

Developers

Fork and then clone the repo to your local machine. From the cloned directory run

npm install && npm run build