Actions


Some Lovelace 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

tap_actionmap(Optional)

Action to take on tap.

actionstringRequired, default: toggle

Action to perform (more-info, toggle, call-service, navigate, url, none)

navigation_pathstring(Optional, default: none)

Path to navigate to (e.g., /lovelace/0/) when action defined as navigate

url_pathstring(Optional, default: none)

Path to navigate to (e.g., https://www.home-assistant.io) when action defined as url

servicestring(Optional, default: none)

Service to call (e.g., media_player.media_play_pause) when action defined as call-service

service_datastring(Optional, default: none)

Service data to include (e.g., entity_id: media_player.bedroom) when action defined as call-service

confirmationboolean | map(Optional, default: false)

Present a confirmation dialog to confirm the action. See confirmation object below

Hold Action

Action that will be performed when an object on a card is tapped and held.

hold_action:
  action: toggle

Configuration Variables

hold_actionmap(Optional)

Action to take on tap-and-hold

actionstringRequired, default: more-info

Action to perform (more-info, toggle, call-service, navigate, url, none)

navigation_pathstring(Optional, default: none)

Path to navigate to (e.g., /lovelace/0/) when action defined as navigate

url_pathstring(Optional, default: none)

Path to navigate to (e.g., https://www.home-assistant.io) when action defined as url

servicestring(Optional, default: none)

Service to call (e.g., media_player.media_play_pause) when action defined as call-service

service_datastring(Optional, default: none)

Service data to include (e.g., entity_id: media_player.bedroom) when action defined as call-service

confirmationboolean | map(Optional, default: false)

Present a confirmation dialog to confirm the action. See confirmation object below

Double-Tap Action

Action that will be performed when an object on a card is double-tapped.

double_tap_action:
  action: toggle

Configuration Variables

double_tap_actionmap(Optional)

Action to take on double tap

actionstringRequired, default: more-info

Action to perform (more-info, toggle, call-service, navigate, url, none)

navigation_pathstring(Optional, default: none)

Path to navigate to (e.g., /lovelace/0/) when action defined as navigate

url_pathstring(Optional, default: none)

Path to navigate to (e.g., https://www.home-assistant.io) when action defined as url

servicestring(Optional, default: none)

Service to call (e.g., media_player.media_play_pause) when action defined as call-service

service_datastring(Optional, default: none)

Service data to include (e.g., entity_id: media_player.bedroom) when action defined as call-service

confirmationboolean | map(Optional, default: false)

Present a confirmation dialog to confirm the action. See confirmation object below

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

Configuration Variables

textstring(Optional)

Text to present in the confirmation dialog.

exemptionslist(Optional)

List of exemption objects. See below

Options For Exemptions

Configuration Variables

userstringRequired

User id that can see the view tab.

Examples

Tap action implemented on an entity button card:

type: button
tap_action:
  action: toggle
hold_action:
  action: more-info