Actions¶

Interactive elements (items, footer buttons, title/clock/date, and the markdown footer) support three gestures: tap_action, hold_action (long press), and double_tap_action.

Visual editorYAML

Each gesture has its own collapsible section on the element, with a Test Action button for the actionable types. Choose an Action from the dropdown and fill in the keys it needs (entity, path, service, and so on).

Each gesture is a mapping with an action key plus whatever that action needs. See the table below for the keys per action.

Action types¶

Action	Keys	Does
`none`	-	Nothing.
`toggle`	`entity`	Toggles the entity, using the right service per domain (lock/unlock, cover open/close, else turn_on/off).
`more-info`	`entity`	Opens the entity's more-info dialog.
`navigate`	`navigation_path`	Navigates to a dashboard path.
`url`	`url_path`	Opens a web address in a new tab.
`call-service`	`service`, `data`, `entity`	Calls a Home Assistant service.
`assist`	`pipeline_id`, `start_listening`	Opens the Assist voice dialog.

Visual editorYAML

Pick the action in each gesture's section. For call-service, set the service and its data; the action's own Entity field overrides the element's entity, so one element can act on a different entity per gesture.

tap_action:
  action: call-service
  service: light.turn_on
  entity: light.kitchen
  data:
    brightness_pct: 40
hold_action:
  action: more-info
  entity: light.kitchen
double_tap_action:
  action: navigate
  navigation_path: /lovelace/lights

An assist action opens the voice dialog; both keys are optional:

tap_action:
  action: assist
  pipeline_id: 01ABCDEF
  start_listening: true

Assist in the companion app

In the companion app, assist opens the app's own Assist screen. In a browser it opens the dialog Home Assistant uses for the toolbar microphone; if nothing on the dashboard has loaded that dialog yet, the first press can take a moment (or need a second press) while it loads.

The action's own entity takes precedence over the element's entity, so one element can act on a different entity per gesture.

Active-page highlight¶

An element whose tap action navigates is highlighted when it points at the page you're currently on: the theme accent color, with a tinted pill on rows and footer buttons. It matches an exact path or a sub-path (e.g. a link to /lovelace/home highlights on /lovelace/home/room) and updates live as you navigate.

Visual editorYAML

Opt out per element with the Highlight When Active toggle under Advanced, shown only when the tap action is navigate.

- type: item
  title: Home
  icon: mdi:home
  active_highlight: false
  tap_action:
    action: navigate
    navigation_path: /lovelace/home