Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add autocomplete and clarify type parameters for text selector #24715

Merged
merged 5 commits into from
Nov 15, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vscode/cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"Lutron",
"macos",
"Meteobridge",
"mireds",
"Modbus",
"Mosquitto",
"Multiday",
Expand Down
31 changes: 22 additions & 9 deletions source/_docs/blueprint/selectors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,29 @@ The following selectors are currently available:
- [Action selector](#action-selector)
- [Add-on selector](#add-on-selector)
- [Area selector](#area-selector)
- [Example area selectors](#example-area-selectors)
steverep marked this conversation as resolved.
Show resolved Hide resolved
- [Attribute selector](#attribute-selector)
- [Boolean selector](#boolean-selector)
- [Color temperature selector](#color-temperature-selector)
- [Config entry selector](#config-entry-selector)
- [Date selector](#date-selector)
- [Date & time selector](#date--time-selector)
- [Device selector](#device-selector)
- [Example device selector](#example-device-selector)
- [Duration selector](#duration-selector)
- [Entity selector](#entity-selector)
- [Example entity selector](#example-entity-selector)
- [Icon selector](#icon-selector)
- [Location selector](#location-selector)
- [Media selector](#media-selector)
- [Number selector](#number-selector)
- [Example number selectors](#example-number-selectors)
- [Object selector](#object-selector)
- [RGB color selector](#rgb-color-selector)
- [Select selector](#select-selector)
- [State selector](#state-selector)
- [Target selector](#target-selector)
- [Example target selectors](#example-target-selectors)
- [Template selector](#template-selector)
- [Text selector](#text-selector)
- [Theme selector](#theme-selector)
Expand Down Expand Up @@ -216,7 +221,7 @@ area:

## Attribute selector

The attributes selector shows a list of state attribites from a provided entity
The attributes selector shows a list of state attributes from a provided entity
of which one can be selected.

This allows for selecting, e.g., the "Effect" attribute from a light entity, or the
Expand Down Expand Up @@ -314,7 +319,7 @@ This selector does not have any other options; therefore, it only has its key.
date:
```

The output of this selector is will contain the date in Year-Month-Day
The output of this selector will contain the date in Year-Month-Day
(`YYYY-MM-DD`) format, for example, `2022-02-22`.

## Date & time selector
Expand All @@ -330,7 +335,7 @@ This selector does not have any other options; therefore, it only has its key.
datetime:
```

The output of this selector is will contain the date in Year-Month-Day
The output of this selector will contain the date in Year-Month-Day
(`YYYY-MM-DD`) format and the time in 24-hour format, for example:
`2022-02-22 13:30:00`.

Expand Down Expand Up @@ -619,7 +624,7 @@ radius: 500 # Only provided when radius was set to true.

The media selector is a powerful selector that allows a user to easily select
media to play on a media device. Media can be a lot of things, for example,
cameras, local media, text-to-speech, Home Assistant Dashboads, and many more.
cameras, local media, text-to-speech, Home Assistant Dashboards, and many more.

The user selects the device to play media on, and automatically limits the
selectable media suitable for the selected device.
Expand Down Expand Up @@ -1013,11 +1018,19 @@ suffix:
required: false
type:
description: >
The type of input. This is a browser hint, which can improve
the client-side validation of the input. The value isn't validated
by the backend. Possible types are:
The type of input. This supplies the [HTML `type` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types),
which controls how the browser displays and validates the field. A subset of types available to the attribute are supported,
since some are handled by other selectors. Possible types are:
`color`, `date`, `datetime-local`, `email`, `month`, `number`, `password`, `search`, `tel`, `text`, `time`, `url`, `week`.
type: string
default: text
required: false
autocomplete:
description: >
Guides the browser on the type of information which should automatically fill the field.
This supplies the [HTML `autocomplete` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).
Any value supported by the HTML attribute is valid.
type: string
required: false
{% endconfiguration %}

Expand All @@ -1036,7 +1049,7 @@ theme:

This selector does not have any other options; therefore, it only has its key.

The output of this selector is will contain the selected theme, for example:
The output of this selector will contain the selected theme, for example:
`waves_dark`.

## Time selector
Expand All @@ -1052,5 +1065,5 @@ This selector does not have any other options; therefore, it only has its key.
time:
```

The output of this selector is will contain the time in 24-hour format,
The output of this selector will contain the time in 24-hour format,
for example, `23:59:59`.