4d56c879ed
Reasons for following changes: * Support for hold action and double tap action was added to Light card, but not mentioned here. * Entity Button card was renamed to Button a few versions ago * Renamed "Entity" card to "Entities" as that is the proper name, and there's an actual Entity card now (which doesn't support actions). So it was wrong.
5.6 KiB
title, description
| title | description |
|---|---|
| Actions | Define what an object does when interacted with. |
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 tap-action %}
tap_action:
required: false
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
confirmation:
required: false
description: "Present a confirmation dialog to confirm the action. See confirmation object below"
type: [boolean, map]
default: "false"
{% endconfiguration %}
Hold Action
Action that will be performed when an object on a card is tapped and held.
hold_action:
action: toggle
{% configuration hold_action %}
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
confirmation:
required: false
description: "Present a confirmation dialog to confirm the action. See confirmation object below"
type: [boolean, map]
default: "false"
{% endconfiguration %}
Double-Tap Action
Action that will be performed when an object on a card is double-tapped.
double_tap_action:
action: toggle
{% configuration double_tap_action %}
double_tap_action:
required: false
description: Action to take on double tap
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
confirmation:
required: false
description: "Present a confirmation dialog to confirm the action. See confirmation object below"
type: [boolean, map]
default: "false"
{% endconfiguration %}
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 confirmation%}
text:
required: false
description: Text to present in the confirmation dialog.
type: string
exemptions:
required: false
description: "List of exemption objects. See below"
type: list
{% endconfiguration %}
Options For Exemptions
{% configuration exemptions %} user: required: true description: User id that can see the view tab. type: string {% endconfiguration %}
Examples
Tap action implemented on an entity button card:
type: button
tap_action:
action: toggle
hold_action:
action: more-info