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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update blueprint input documentation (#16425)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Erik Montnemery 2021-02-05 16:36:06 +01:00 committed by GitHub
parent 2603b6ceb3
commit 3bc4747a40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_docs/blueprint/schema.markdown
View File

@ -96,7 +96,7 @@ a default value and also provide a [selector](/docs/blueprint/selectors/) that
ensures a matching input field in the user interface.
Each input field can be referred to, outside of the blueprint metadata, using
the `!input` custom tag.
the `!input` custom YAML tag.
The following example shows a minimal blueprint with a single input:
@ -117,6 +117,19 @@ was used in the user interface, a text input field would be shown to the user.
A blueprint can have as many inputs as you like.
### Blueprint inputs in templates
The inputs are available as custom YAML tags, but not as template variables.
To use a blueprint input in a template, it first needs to be exposed as either
a [script level variable](/integrations/script/#-configuration-variables) or in
a [variable script step](/docs/scripts/#variables).
```yaml
variables:
# Make input my_input available as a script level variable
my_input: !input my_input
```
## Example blueprints
The [built-in blueprints][blueprint-built-in]