Skip to content

Commit 94e9e1c

Browse files
authored
Adjust documentation for the redesigned area card (#39637)
1 parent 940045c commit 94e9e1c

File tree

5 files changed

+47
-9
lines changed

5 files changed

+47
-9
lines changed

source/_dashboards/area.markdown

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ related:
1717
The area card lets you control and monitor an individual {% term area %}.
1818

1919
<p class='img'>
20-
<img src='/images/dashboards/area-card.png' alt='Screenshot of the area card'>
21-
Screenshot of the area card.
20+
<img src='/images/dashboards/area-cards.png' alt='Screenshot of the area cards'>
21+
Screenshot of the area cards.
2222
</p>
2323

2424
{% include dashboard/edit_dashboard.md %}
@@ -42,14 +42,14 @@ area:
4242
required: true
4343
description: ID of the `area`.
4444
type: string
45-
show_camera:
45+
display_type:
4646
required: false
47-
description: Changes the area picture to a live feed of the camera set for the area.
48-
type: boolean
49-
default: false
47+
description: Defines the card's display style. Options include `compact` (a minimal layout), `icon` (shows an area icon), `picture` (displays an image of the area), or `camera` (shows the live camera feed).
48+
type: string
49+
default: "picture"
5050
camera_view:
5151
required: false
52-
description: 'If showing a camera, "live" will show the live view if `stream` is enabled.'
52+
description: 'If showing a camera, `live` will show the live view if `stream` is enabled.'
5353
default: auto
5454
type: string
5555
aspect_ratio:
@@ -69,12 +69,21 @@ alert_classes:
6969
required: false
7070
type: list
7171
default: "moisture, motion"
72-
description: A list of binary sensor device classes which will populate alert icons in the card when the state is on.
72+
description: A list of binary sensor device classes which will populate alert icons in the card when the state is on. If the display type is set to `compact`, only the first alert icon will be displayed.
7373
sensor_classes:
7474
required: false
7575
type: list
7676
default: "temperature, humidity"
77-
description: A list of sensor device classes which will display their averaged sensor readings for the area.
77+
description: A list of sensor device classes which will display their averaged sensor readings for the area.
78+
features:
79+
required: false
80+
description: Additional widgets to control entities in the area. See [available features](/dashboards/features).
81+
type: list
82+
features_position:
83+
required: false
84+
description: Position of the features on the area card. Can be `bottom` or `inline`. Only the first feature will be displayed when the option is set to `inline`.
85+
type: string
86+
default: bottom
7887
{% endconfiguration %}
7988

8089
### Example

source/dashboards/features.markdown

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Features can be enabled on the following cards:
2121
- [Humidifier](/dashboards/humidifier/)
2222
- [Thermostat](/dashboards/thermostat/)
2323
- [Tile](/dashboards/tile/)
24+
- [Area](/dashboards/area/)
2425

2526
## Customizing features
2627

@@ -720,3 +721,31 @@ operation_modes:
720721
type: list
721722
{% endconfiguration %}
722723

724+
## Area control
725+
726+
Widget that displays buttons to control different types of entity in your area.
727+
728+
<p class='img'>
729+
<img src='/images/dashboards/features/area_controls.png' alt='Screenshot of the area card with the area controls feature'>
730+
Screenshot of the area card with the area controls feature
731+
</p>
732+
733+
```yaml
734+
features:
735+
- type: "area-controls"
736+
controls:
737+
- light
738+
- fan
739+
- switch
740+
```
741+
742+
{% configuration features %}
743+
type:
744+
required: true
745+
description: "`area-controls`"
746+
type: string
747+
controls:
748+
required: true
749+
description: List of controls to show on the card. The list can contain `light`, `fan`, and `switch`.
750+
type: list
751+
{% endconfiguration %}
-141 KB
Binary file not shown.
92.2 KB
Loading
Loading

0 commit comments

Comments
 (0)