Skip to content

Commit

Permalink
Add missing documentation for numeric input and preset mode features (#…
Browse files Browse the repository at this point in the history
…30070)

* Add missing documentation for number value and preset mode features

* Rename to numeric input

* Update features.markdown

Co-authored-by: Fletcher <[email protected]>

---------

Co-authored-by: Fletcher <[email protected]>
  • Loading branch information
piitaya and FletcherAU authored Dec 1, 2023
1 parent 9c9d6ad commit c63883c
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions source/dashboards/features.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,40 @@ hvac_modes:
type: list
{% endconfiguration %}

## Climate preset modes

Widget that displays buttons or icons to control the preset mode for a [climate](/integrations/climate).

<p class='img'>
<img src='/images/dashboards/features/climate_preset_modes.png' alt='Screenshot of the tile card with the climate preset modes feature'>
Screenshot of the tile card with the climate preset modes feature
</p>

```yaml
features:
- type: "climate-preset-modes"
style: "icons"
preset_modes:
- home
- eco
```

{% configuration features %}
type:
required: true
description: "`climate-preset-modes`"
type: string
style:
required: false
description: "How the preset modes should be displayed. It can be either `dropdown` or `icons`."
type: string
default: dropdown
preset_modes:
required: true
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.
type: list
{% endconfiguration %}

## Cover open/close

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

## Numeric input

Widget that displays a slider or buttons to set the value for a [number](/integrations/number) or [input number](/integrations/input_number).

<p class='img'>
<img src='/images/dashboards/features/numeric_input.png' alt='Screenshot of the tile card with the numeric input feature'>
Screenshot of the tile card with the numeric input feature
</p>

```yaml
features:
- type: "numeric-input"
style: "buttons"
```

{% configuration features %}
type:
required: true
description: "`numeric-input`"
type: string
style:
required: false
description: "Which style of control to display. It can be either `buttons` or `slider`."
type: string
default: slider
{% endconfiguration %}

## Target temperature

Widget that displays buttons to select the target temperature for a [climate](/integrations/climate) or a [water heater](/integrations/water_heater).
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c63883c

Please sign in to comment.