Migration from v1

This guide explains the changes you need to make when upgrading from version 1. It covers breaking changes, new features, bug fixes, and provides example configurations.


Breaking Changes

Change Impacts What to Do
Removed battery-view-strategy battery-view-strategy Use grid-view-strategy instead. See the Battery View Replacement example below
Removed update-view-strategy update-view-strategy Use grid-view-strategy instead. See the Update View Replacement example below
Renamed rows key to grids grid-view-strategy, area-dashboard-strategy Update your configuration by replacing rows with grids
New required fields for grids grid-view-strategy, area-dashboard-strategy Make sure your grids configuration includes all required fields - see area-dashboard-strategy/grid-view-strategy
Removed domain key area-dashboard-strategy Use include-filter with type: domain - see filter
Removed reference tabs/rows using ~ area-dashboard-strategy Use grid overrides for grids instead - see area-dashboard-strategy/grid-view-strategy
Removed tabs area-dashboard-strategy Replace with the new main and grids keys – see main/grids
Removed areaColors, areaCardConfig, and areaBlacklist area-dashboard-strategy These settings can now be handled using the navigation key – see navigation
Renamed & moved minColumnWidth (now minCardWith) and replaceCards (now replace) grid-view-strategy, area-dashboard-strategy Use the new global configuration and override in individual grids if needed - see area-dashboard-strategy/grid-view-strategy

New Features


Bug Fixes

  • card_mod Fix: The card_mod functionality should work properly in grids.
  • Multiple $entity Replacement Issue: Fixed issues with multiple uses of $entity.
  • Several minor enhancements have been made.

Example Configurations

Battery View Replacement

This example shows how to replace the old battery view configuration using grid-view-strategy:

strategy:
    type: custom:grid-view-strategy
    config:
        global:
            card:
                type: custom:mini-graph-card
                entities:
                    - $entity
                filter:
                    include:
                        - type: domain
                          value: sensor
                        - type: attribute
                          config:
                              key: device_class
                          value: battery
        grids:
            - id: other
              title: Others
              filter:
                  exclude:
                      - type: integration
                        comparator: in
                        value:
                            - mqtt
                            - switchbot
                            - xiaomi_ble
            - id: zigbee
              title: Zigbee
              filter:
                  include:
                      - type: integration
                        value: mqtt
            - id: switchbot
              title: Switchbot
              filter:
                  include:
                      - type: integration
                        value: switchbot
            - id: plant
              title: Plant Sensor
              filter:
                  include:
                      - type: integration
                        value: xiaomi_ble

Update View Replacement

This example shows how to replace the old update view configuration using grid-view-strategy:

strategy:
    type: custom:grid-view-strategy
    config:
        global:
            card:
                type: tile
                entity: $entity
                hide_state: true
                features:
                    - type: update-actions
                      backup: ask
        grids:
            - id: other
              title: Others
              filter:
                  exclude:
                      - type: integration
                        comparator: in
                        value:
                            - unifi
                            - hacs
                            - esphome
                            - mqtt
            - id: unifi
              title: Unifi
              filter:
                  include:
                      - type: integration
                        value: unifi
            - id: hacs
              title: HACS
              filter:
                  include:
                      - type: integration
                        value: hacs
            - id: esphome
              title: ESPHome
              filter:
                  include:
                      - type: integration
                        value: esphome
            - id: zigbee
              title: Zigbee
              filter:
                  include:
                      - type: integration
                        value: mqtt