DigiLive/mushroom-strategy
1
0
Fork 1
mirror of https://github.com/DigiLive/mushroom-strategy.git synced 2025-08-04 12:04:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for quick_access_cards, extra_cards and extra_views

Aalian Khan
2025-03-08 09:01:15 -08:00
parent a1603967ae
commit 2e51b731b3
1 changed files with 59 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
Strategy-Options.md

@@ -13,9 +13,9 @@ The options available are:
| `card_options` | object (optional) | unset | Card options for cards, see [Card Options](#card-options). |
| `views` | object (optional) | All default views | See available [Views](#views). |
| `chips` | object | All count chips enabled with auto selected weather card | See [Chips](#chips). |
| `quick_access_cards` | array of cards (optional) | unset | List of cards to show between the Welcome card and the Rooms cards. |
| `extra_cards` | array of cards (optional | unset | List of cards to show below the Room cards. |
| `extra_views` | array of views (optional) | unset | List of user defined views to add to the dashboard. |
| `quick_access_cards` | array of cards (optional) | unset | List of cards to show between the Welcome card and the Rooms cards. See [Additional Cards](#additional-cards) |
| `extra_cards` | array of cards (optional | unset | List of cards to show below the Room cards. See [Additional Cards](#additional-cards) |
| `extra_views` | array of views (optional) | unset | List of user defined views to add to the dashboard. See [Additional Views](#additional-views) |
| `domains` | object (optional) | All supported domains | See [Domains](#domains). |
| `home_view` | object (optional) | unset | Options for the home view, see [Home View](#home-view) |
@@ -317,6 +317,62 @@ strategy:
action: toggle
```
# Additional Cards
Sometimes we want to add static cards in our dashboard. You can add these cards in either `quick_access_cards` or `extra_cards`. `extra_cards` is also available on a per-area basis shown at the bottom of the area subview (See [Areas](#areas)). `quick_access_cards` are shown in between the welcome card and area title and `extra_cards are shown after the area cards. You can also add extra chips in the chips section. See [chips](#chips)
![additonal_cards.png](https://github.com/AalianKhan/mushroom-strategy/blob/main/docs/additonal_cards.png)
## Example
```yaml
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:
- 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
views: []
```
# Additional Views
You can add an additional static view to the dashboard by using `extra_views`. The best way is to create your view in a different dashboard using the UI, then copy the YAML and paste it under `extra_views`. Make sure the indentation is correct.
## Example
```yaml
strategy:
type: custom:mushroom-strategy
options:
extra_views:
- theme: Backend-selected
title: cool view
path: cool-view
icon: mdi:emoticon-cool
badges: []
cards:
- type: markdown
content: I am cool
views: []
```
<!-- References -->
[mushroom-chipsUrl]: https://github.com/piitaya/lovelace-mushroom/blob/main/docs/cards/chips.md