Fredrik Andersson 6c6268a08e
Update documentation for how cards can be configured in the UI (#21556)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <git@frenck.dev>
fixes undefined
2023-01-16 17:54:11 +01:00

2.1 KiB

type, title, sidebar_label, description
type title sidebar_label description
card Entity Card Entity The Entity card gives you a quick overview of your entity's state

The Entity card gives you a quick overview of your entity's state.

Screenshot of the entity card Screenshot of the Entity card.

To add the Entity card to your user interface, click the menu (three dots at the top right of the screen) and then Edit Dashboard. Click the Add Card button in the bottom right corner and select from the card picker.

All options for this card can be configured via the user interface.

YAML Configuration

The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.

{% configuration %} type: required: true description: "entity" type: string entity: required: true description: Entity ID. type: string name: required: false description: Name of entity. type: string default: Entity name. icon: required: false description: Overwrites icon. type: string state_color: required: false description: Set to true to have icon colored when entity is active. type: boolean default: false
attribute: required: false description: An attribute associated with the entity. type: string unit: required: false description: Unit of measurement given to data. type: string default: Unit of measurement given by entity. theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the frontend documentation. type: string footer: required: false description: Footer widget to render. See footer documentation. type: map {% endconfiguration %}

Example

- type: entity
  entity: cover.kitchen_window
- type: entity
  entity: light.bedroom
  attribute: brightness
  unit: "%"
- type: entity
  entity: vacuum.downstairs
  name: Vacuum
  icon: "mdi:battery"
  attribute: battery_level
  unit: "%"