Skip to content

🏠 Home View Options#

The home_view group enables you to specify the configuration of the Home view.

Option type default Description
hidden object {greeting: true} Array of sections to hide from the home view.
stack_count object {_: 2} Cards per row.

Hiding sections#

The following sections can be hidden from the Home view:

  • areas
  • areasTitle
  • badges
  • greeting
  • persons

Example#

strategy:
  type: custom:mushroom-strategy
  options:
    home_view:
      hidden:
        greeting: false
        areasTitle: true

Stack Count#

The stack_count option is a map of sections to define the number of cards per row.
The key of the map is the section, while the value is the number of cards per row.

The areas section is a special case, where the value is an array of two numbers.
The first number is the number of default cards per row, while the second number is the number of Home Assistant cards per row.

example#

home_view:
  stack_count:
    _: 2         # Two cards per row for all sections.
    persons: 3   # Three person cards per row.
    areas: [2,1] # [Two Strategy Card per row, 1 HASS card per row]

Note

Section specific options take precedence over options set for all sections!

Badge Options#

Badges are widgets that sit at the top of a panel, above all the cards.
The mushroom strategy has badges that indicate the number of entities for a specific domain which are in an "active" state.
Hidden/Disabled entities are excluded from this count.

  • Tapping a badge will set corresponding entities to an "inactive" state.1
    Note: The Switch badge requires a confirmation before executing its tap action to prevent accidental toggling of all switches.
  • Holding a badge, will navigate to the corresponding view.

The badges group enables you to specify its configuration of badges.

Name type default Description
light_count boolean false Number of lights on.
fan_count boolean false Number of fans on.
cover_count boolean false Number of covers not closed. No tap action.
switch_count boolean false Number of switches on.
climate_count boolean false Number of climate not off. No tap action.
weather_entity string auto Entity id for the weather badge to use.
extra_badges array [] List of extra badges to show.

If weather_entity is set to auto, the weather badge uses the first entity of the weather domain it finds.
You can define a custom entity to use by setting an entity id.

Note

To hide the weather badge, you should hide or disable the entity itself.

Example#

strategy:
  type: custom:mushroom-strategy
  options:
    badges:
      climate_count: false
      cover_count: false
      weather_entity: weather.forecast_home

Extra Badges#

To add custom badges, you can configure them in extra_badges.
See Mushroom Badges and Home Assistant Badges

Tip

You can build your badges in a temporary card in another dashboard and copy the badges group from the YAML of that card into group extra_badges of the strategy configuration. The YAML can be found in the Raw configuration editor.

Example#

strategy:
  type: custom:mushroom-strategy
  options:
    badges:
      extra_badges:
        - type: custom:mushroom-template-badge
          content: Hello
          icon: mdi:mushroom
          color: red
        - type: entity
          show_name: false
          show_state: true
          show_icon: true
          entity: light.kitchen
          tap_action:
            action: toggle

Quick Access Cards#

The quick_access_cards group enables you to specify the configuration of additional cards in the view. These cards will be shown between the greeting card and area cards.

Each card can have the options as described at Card Options.

Tip

You can build your view in a temporary dashboard and copy the views group from the YAML of that dashboard into group extra_views of the strategy configuration. The YAML can be found in the Raw configuration editor.

Example#

strategy:
  type: custom:mushroom-strategy
  options:
    quick_access_cards:
      - type: custom:mushroom-title-card
        title: Security
      - type: custom:mushroom-cover-card
        entity: cover.garage_door
        show_buttons_control: true
      - type: horizontal-stack
        cards:
          - type: custom:mushroom-lock-card
            entity: lock.front_door
          - type: custom:mushroom-entity-card
            entity: sensor.front_door_lock_battery
            name: Battery

Extra Cards#

The extra_cards group enables you to specify the configuration of additional cards in the view. These cards will be shown below the areas.

Each card can have the options as described at Card Options.

Tip

You can build your view in a temporary dashboard and copy the views group from the YAML of that dashboard into group extra_cards of the strategy configuration. The YAML can be found in the Raw configuration editor.

Example#

strategy:
  type: custom:mushroom-strategy
  options:
    extra_cards:
      - type: custom:xiaomi-vacuum-map-card
        map_source:
          camera: camera.xiaomi_cloud_map_extractor
        calibration_source:
          camera: true
        entity: vacuum.robot_vacuum
        vacuum_platform: default

  1. For some badges, the tap action is disabled. ↩