jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the constant selector (#26844)

Browse Source
This commit is contained in:
Erik Montnemery 2023-04-03 10:45:47 +02:00 committed by Franck Nijhof
parent e728fa95cc
commit 422af5a870
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
2 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_docs/blueprint/selectors.markdown
View File

@ -22,6 +22,7 @@ The following selectors are currently available:
- [Boolean selector](#boolean-selector) - [Boolean selector](#boolean-selector)
- [Color temperature selector](#color-temperature-selector) - [Color temperature selector](#color-temperature-selector)
- [Config entry selector](#config-entry-selector) - [Config entry selector](#config-entry-selector)
- [Constant selector](#constant-selector)
- [Date selector](#date-selector) - [Date selector](#date-selector)
- [Date & time selector](#date--time-selector) - [Date & time selector](#date--time-selector)
- [Device selector](#device-selector) - [Device selector](#device-selector)
@ -241,12 +242,11 @@ For example: `next_dawn`.
## Boolean selector ## Boolean selector
The boolean selector shows a toggle that allows the user to turn on or off The boolean selector shows a toggle that allows the user to turn on or off
the selected option. The input's value will contain the boolean value of that the selected option.
toggle as a boolean value, being `true` or `false`.
![Screenshot of a boolean selector](/images/blueprints/selector-boolean.png) ![Screenshot of a boolean selector](/images/blueprints/selector-boolean.png)
The boolean selector can be incredibly useful for adding feature switches The boolean selector is suitable for adding feature switches
to, for example, blueprints. to, for example, blueprints.
This selector does not have any other options; therefore, it only has its key. This selector does not have any other options; therefore, it only has its key.
@ -255,7 +255,7 @@ This selector does not have any other options; therefore, it only has its key.
boolean: boolean:
``` ```
The output of this selector is `true` when the toggle was on, `false` otherwise. The output of this selector is `true` when the toggle is on, `false` otherwise.
## Color temperature selector ## Color temperature selector
@ -305,6 +305,24 @@ integration:
The output of this selector is the entry ID of the config entry, for example, `6b68b250388cbe0d620c92dd3acc93ec`. The output of this selector is the entry ID of the config entry, for example, `6b68b250388cbe0d620c92dd3acc93ec`.
## Constant selector
The constant selector shows a toggle that allows the user to enable the selected option.
This is similar to the [boolean selector](#boolean-selector), the difference
is that the constant selector has no value when it's not enabled.
![Screenshot of a constant selector](/images/blueprints/selector-constant.png)
The selector's value must be configured, and optionally, a label.
```yaml
boolean:
value: true
label: Enabled
```
The output of this selector is the configured value when the toggle is on, it has not output otherwise.
## Date selector ## Date selector
The date selector shows a date input that allows the user to specify a date. The date selector shows a date input that allows the user to specify a date.

BIN
source/images/blueprints/selector-constant.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.1 KiB