Local input boolean¶

A local input boolean is a local on/off value that can be used by the card like an entity state. It is useful for choices that only affect the card, such as showing labels, enabling a grid, or revealing an extra layer, without creating a Home Assistant helper.

A local input boolean is not created in Home Assistant. Its entity ID must start with fhs_input_boolean., which tells the card to create and manage the value locally.

This page shows how to define the boolean, control it, use its on/off state elsewhere in the card, and optionally keep the value after a reload.

Add an on/off value¶

Use a local boolean when the card needs to remember a local true/false choice without a Home Assistant helper.

1
2
3
4

entities:
  - entity: fhs_input_boolean.show_labels  # Create or use this local input
    initial: true  # Value used when this local input is created
    scope: card  # Keep this value inside this card

The state is exposed as on or off.

Change it with a Toggle¶

A Toggle is the direct visual control for changing a local boolean between on and off.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

entities:
  - entity: fhs_input_boolean.option_1  # Local on/off value used by the example
    initial: false

layout:
  controls:
    - id: show-labels  # Name this item so it can be referenced later
      type: toggle  # Create a toggle control
      entity_index: 0  # Use entity 0 from entities: (0 = first entity)
      xpos: 50  # Horizontal position; 50 = center of the card
      ypos: 85  # Vertical position; 50 = center of the card
      width: 24  # Width of the complete control

Use the value in the card¶

This example only shows a Text item while the input is on:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

entities:
  - entity: fhs_input_boolean.option_1  # Local on/off value used by the example
    initial: false

layout:
  texts:
    - entity_index: 0  # Use entity 0 from entities: (0 = first entity)
      text: Scale labels  # Text shown to the user
      xpos: 50  # Horizontal position; 50 = center of the card
      ypos: 65  # Vertical position; 50 = center of the card
      visibility: |
        [[[
          return state === 'on' ? 'visible' : 'hidden';
        ]]]

Change the value from an action¶

Available actions:

Share or persist the value¶

Use scope: global to share the value with other cards in this Home Assistant client. Add persist: true to restore a global value after reloading.

Configuration options¶

Required applies to the specific form described by that table: Yes means you need the field for that form; No means you can leave it out. Not set means the card adds no explicit value when the option is omitted.

Related¶

• Toggle
• Local input entities
• Visibility
• JavaScript templates