Skip to content

Commit c63883c

Browse files
piitayaFletcherAU
andauthored
Add missing documentation for numeric input and preset mode features (home-assistant#30070)
* Add missing documentation for number value and preset mode features * Rename to numeric input * Update features.markdown Co-authored-by: Fletcher <fletcher.boyd@artifactory.org.au> --------- Co-authored-by: Fletcher <fletcher.boyd@artifactory.org.au>
1 parent 9c9d6ad commit c63883c

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

source/dashboards/features.markdown

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,40 @@ hvac_modes:
7474
type: list
7575
{% endconfiguration %}
7676

77+
## Climate preset modes
78+
79+
Widget that displays buttons or icons to control the preset mode for a [climate](/integrations/climate).
80+
81+
<p class='img'>
82+
<img src='/images/dashboards/features/climate_preset_modes.png' alt='Screenshot of the tile card with the climate preset modes feature'>
83+
Screenshot of the tile card with the climate preset modes feature
84+
</p>
85+
86+
```yaml
87+
features:
88+
- type: "climate-preset-modes"
89+
style: "icons"
90+
preset_modes:
91+
- home
92+
- eco
93+
```
94+
95+
{% configuration features %}
96+
type:
97+
required: true
98+
description: "`climate-preset-modes`"
99+
type: string
100+
style:
101+
required: false
102+
description: "How the preset modes should be displayed. It can be either `dropdown` or `icons`."
103+
type: string
104+
default: dropdown
105+
preset_modes:
106+
required: true
107+
description: List of preset modes to show on the card. The list can contain `eco`, `away`, `boost`, `comfort`, `home`, `sleep`, and `activity` or any other custom preset mode.
108+
type: list
109+
{% endconfiguration %}
110+
77111
## Cover open/close
78112

79113
Widget that displays buttons to open, close, or stop a [cover](/integrations/cover).
@@ -270,6 +304,33 @@ type:
270304
type: string
271305
{% endconfiguration %}
272306

307+
## Numeric input
308+
309+
Widget that displays a slider or buttons to set the value for a [number](/integrations/number) or [input number](/integrations/input_number).
310+
311+
<p class='img'>
312+
<img src='/images/dashboards/features/numeric_input.png' alt='Screenshot of the tile card with the numeric input feature'>
313+
Screenshot of the tile card with the numeric input feature
314+
</p>
315+
316+
```yaml
317+
features:
318+
- type: "numeric-input"
319+
style: "buttons"
320+
```
321+
322+
{% configuration features %}
323+
type:
324+
required: true
325+
description: "`numeric-input`"
326+
type: string
327+
style:
328+
required: false
329+
description: "Which style of control to display. It can be either `buttons` or `slider`."
330+
type: string
331+
default: slider
332+
{% endconfiguration %}
333+
273334
## Target temperature
274335

275336
Widget that displays buttons to select the target temperature for a [climate](/integrations/climate) or a [water heater](/integrations/water_heater).
Loading
Loading

0 commit comments

Comments
 (0)