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-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add default

Browse Source
This commit is contained in:
Fabian Affolter 2017-11-01 11:44:32 +01:00
parent 68ee2ccb70
commit 1348cdbed4
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/developers/documentation/create_page.markdown
View File

@ -60,11 +60,14 @@ The **Configuration Variables** section must use the {% raw %}`{% configuration
name: name:
description: Name to use in the frontend. description: Name to use in the frontend.
required: false required: false
default: The default name to use in the frontend.
type: string type: string
{% endconfiguration %} {% endconfiguration %}
{% endraw %} {% endraw %}
``` ```
Available keys:
- **`description:`**: That the variable is about. - **`description:`**: That the variable is about.
- **`required:`**: If the variable is required. - **`required:`**: If the variable is required.
```text ```text
@ -75,6 +78,7 @@ required: exclusive #=> Exclusive
required: any string here #=> Any string here required: any string here #=> Any string here
``` ```
- **`type:`**: The type of the variable. Allowed entries: `string`, `int` or `map`. For multiple possibilities use `[string, int]`. If you use `map` then you need to define `keys:` (see the [`template` sensor](/components/sensor.template/) for an example). - **`type:`**: The type of the variable. Allowed entries: `string`, `int` or `map`. For multiple possibilities use `[string, int]`. If you use `map` then you need to define `keys:` (see the [`template` sensor](/components/sensor.template/) for an example).
- **`default:`**: The default value for the variable.
### {% linkable_title Embedding Code %} ### {% linkable_title Embedding Code %}