2.9 KiB
title, sidebar_label, description
| title | sidebar_label | description |
|---|---|---|
| Button Card | Button | The Button card allows you to add buttons to perform tasks. |
The Button card allows you to add buttons to perform tasks.
Screenshot of the Button card.
To add the Button card to your user interface, click the Lovelace menu (three dots at the top right of the screen) and then Edit Dashboard. Click the plus button in the bottom right corner and select Button from the card picker. All options for this card can be configured via the user interface.
Alternatively, the card can be configured using YAML:
type: button
entity: light.living_room
{% configuration %}
type:
required: true
description: button
type: string
entity:
required: false
description: Home Assistant entity ID.
type: string
name:
required: false
description: Overwrites friendly name.
type: string
default: Name of Entity
icon:
required: false
description: Icon that will be be used to overwrite the entity picture or entity icon.
type: string
default: Entity Domain Icon
show_name:
required: false
description: Show name.
type: boolean
default: "true"
show_icon:
required: false
description: Show icon.
type: boolean
default: "true"
show_state:
required: false
description: Show state.
type: boolean
default: "false"
icon_height:
required: false
description: Set the height for the icon. This is in pixels which is handled by the configuration UI. (Advanced users can use other CSS values if they like)
type: string
default: auto
state_color:
required: false
description: Set to true to have icons colored when entity is active
type: boolean
default: true
tap_action:
required: false
description: Action taken on card tap. See action documentation.
type: map
hold_action:
required: false
description: Action taken on card tap and hold. See action documentation.
type: map
double_tap_action:
required: false
description: Action taken on card double tap. See action documentation.
type: map
theme:
required: false
description: "Set to any theme within themes.yaml"
type: string
{% endconfiguration %}
Options For Exemptions
{% configuration badges %} user: required: true description: User id that can see the view tab. type: string {% endconfiguration %}
Examples
Title and Script Service Example:
type: button
name: Turn Off Lights
show_state: false
tap_action:
action: call-service
service: script.turn_on
service_data:
entity_id: script.turn_off_lights
Screenshot of the Button card with Title and Script Service.