Actions
Some cards have support for tap actions. These actions define what will happen when you tap or hold on an object within a card.
Actions can be enabled on:
Tap-Action
Action that will be performed when an object on a card is tapped.
tap_action:
action: toggle
Configuration Variables
Action taken on tap.
Action to perform (more-info, toggle, call-service, navigate, url, assist, none)
toggle (some cards overwrite default to more-info if the provided entity cannot be toggled)
Path to navigate to (e.g., /lovelace/0/) when the action is defined as navigate
Whether to replace the current page in the the history with the new URL when the action is defined as navigate
Path to navigate to (e.g., https://www.home-assistant.io) when the action is defined as url
Service to call (e.g., media_player.media_play_pause) when the action is defined as call-service
Service data to include (e.g., entity_id: media_player.bedroom) when the action is defined as call-service
Present a confirmation dialog to confirm the action. See confirmation object below
Assist pipeline to use when the action is defined as assist. It can be either last_used, preferred, or a pipeline id.
Hold Action
Action that will be performed when an object on a card is tapped, held for at least half a second and then released. Action will only be triggered once, not continuously during hold.
hold_action:
action: toggle
Configuration Variables
Action taken on tap-and-hold
Action to perform (more-info, toggle, call-service, navigate, url, assist, none)
Path to navigate to (e.g., /lovelace/0/) when the action is defined as navigate
Whether to replace the current page in the the history with the new URL when the action is defined as navigate
Path to navigate to (e.g., https://www.home-assistant.io) when the action is defined as url
Service to call (e.g., media_player.media_play_pause) when the action is defined as call-service
Service data to include (e.g., entity_id: media_player.bedroom) when the action is defined as call-service
Present a confirmation dialog to confirm the action. See confirmation object below
Assist pipeline id to use when the action is defined as assist
Double-Tap Action
Action that will be performed when an object on a card is double-tapped.
double_tap_action:
action: toggle
Configuration Variables
Action taken on double tap
Action to perform (more-info, toggle, call-service, navigate, url, assist, none)
Path to navigate to (e.g., /lovelace/0/) when the action is defined as navigate
Whether to replace the current page in the the history with the new URL when the action is defined as navigate
Path to navigate to (e.g., https://www.home-assistant.io) when the action is defined as url
Service to call (e.g., media_player.media_play_pause) when the action is defined as call-service
Service data to include (e.g., entity_id: media_player.bedroom) when the action is defined as call-service
Present a confirmation dialog to confirm the action. See confirmation object below
Assist pipeline id to use when the action is defined as assist
Options for confirmation
If you define confirmation as an object instead of boolean, you can add more customization and configurations.
double_tap_action:
action: call-service
confirmation:
text: Are you sure you want to restart?
service: script.restart
hold_action:
action: call-service
confirmation: true
service: script.do_other_thing
Options for exemptions
double_tap_action:
action: call-service
confirmation:
text: Are you sure you want to restart?
exemptions:
- user: x9405b8c64ee49bb88c42000e0a9dfa8
- user: 88bcfbdc39155d16c3b2d09cbf8b0367
service: script.restart
Examples
Tap action implemented on an entity button card:
type: button
tap_action:
action: toggle
hold_action:
action: more-info
Limitations
It is not possible to use templates for actions. But calling a script is a good alternative.