Sean Mooney dad4a22e4f
Add UI setup instructions to Lovelace card pages (#15155)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2020-10-10 13:55:56 +02:00

76 lines
1.8 KiB
Markdown

---
title: "Light Card"
sidebar_label: Light
description: "The Light card allows you to change the brightness of the light."
---
The Light card allows you to change the brightness of the light.
<p class='img'>
<img src='/images/lovelace/lovelace_light_card.png' alt='Screenshot of the Light card'>
Screenshot of the Light card.
</p>
To add the Light card to your user interface, click the Lovelace menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the plus button in the bottom right corner and select **Light** from the card picker. All options for this card can be configured via the user interface.
Alternatively, the card can be configured using YAML:
```yaml
type: light
entity: light.bedroom
```
{% configuration %}
type:
required: true
description: light
type: string
entity:
required: true
description: Home Assistant Light Domain entity ID.
type: string
name:
required: false
description: Overwrites friendly name.
type: string
default: Name of Entity
icon:
required: false
description: Overwrites icon.
type: string
default: Entity Domain Icon
theme:
required: false
description: Set to any theme within `themes.yaml`.
type: string
hold_action:
required: false
description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action).
type: map
double_tap_action:
required: false
description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action).
type: map
{% endconfiguration %}
## Examples
Overwriting names example:
```yaml
type: light
entity: light.bedroom
name: Kids Bedroom
```
```yaml
type: light
entity: light.office
name: My Office
```
<p class='img'>
<img src='/images/lovelace/lovelace_light_complex_card.png' alt='Screenshot of the Light card'>
Screenshot of the Light card names.
</p>