jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Buttons docs (#11885)

Browse Source
This commit is contained in:
Paulus Schoutsen 2020-01-27 05:30:07 -08:00 committed by Franck Nijhof
parent 74a4fdb4ba
commit 70f61c8608
3 changed files with 40 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
source/images/lovelace/header-footer/screenshot-picture-buttons.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
source/images/lovelace/header-footer/screenshot-picture-header.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 20 KiB

124
source/lovelace/header-footer.markdown
View File

@ -5,14 +5,14 @@ description: "Decorate your Lovelace cards with header and footer widgets."
Some Lovelace cards have support for header and footer widgets. These widgets fill up the whole available space in a card.
<p class='img'><img src='/images/lovelace/header-footer/screenshot-picture-buttons.png' alt="Screenshot of an entities card with a picture header.">
Screenshot of an entities card with a picture header and buttons footer.
</p>
## Picture header & footer
Widget to show a picture as a header or a footer. A picture can have touch actions associated with it.
<p class='img'><img src='/images/lovelace/header-footer/screenshot-picture-header.png' alt="Screenshot of an entities card with a picture header.">
Screenshot of an entities card with a picture header.
</p>
```yaml
type: picture
image: 'https://www.home-assistant.io/images/lovelace/header-footer/balloons-header.png'
@ -29,92 +29,48 @@ image:
type: string
tap_action:
required: false
description: Action to take on tap
description: Action to take on tap.
type: map
keys:
action:
required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)"
type: string
default: "`toggle`"
navigation_path:
required: false
description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`"
type: string
default: none
url_path:
required: false
description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`"
type: string
default: none
service:
required: false
description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`"
type: string
default: none
service_data:
required: false
description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`"
type: string
default: none
hold_action:
required: false
description: Action to take on tap-and-hold
type: map
keys:
action:
required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)"
type: string
default: "`more-info`"
navigation_path:
required: false
description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`"
type: string
default: none
url_path:
required: false
description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`"
type: string
default: none
service:
required: false
description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`"
type: string
default: none
service_data:
required: false
description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`"
type: string
default: none
double_tap_action:
required: false
description: Action to take on double tap
description: Action to take on tap-and-hold
type: map
keys:
action:
required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)"
type: string
default: "`more-info`"
navigation_path:
required: false
description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`"
type: string
default: none
url_path:
required: false
description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`"
type: string
default: none
service:
required: false
description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`"
type: string
default: none
service_data:
required: false
description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`"
type: string
default: none
{% endconfiguration %}
## Buttons header & footer
Widget to show entities as buttons in the header or footer.
```yaml
type: buttons
entities:
- script.launch_confetti
- entity: script.swirl_lights
icon: 'mdi:track-light'
- entity: script.run_siren
icon: 'mdi:alarm-light'
```
{% configuration header-footer %}
entities:
required: true
description: A list of entities to show. Each entry is either an entity ID or a map.
type: list
keys:
entity:
required: true
description: The entity to render.
type: string
icon:
required: false
description: Override the entity icon.
type: string
image:
required: false
description: Override the entity image.
type: string
{% endconfiguration %}