OpenHAB
/
openhab-webui
mirror of https://github.com/openhab/openhab-webui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
openhab-webui/bundles/org.openhab.ui/doc/components/oh-toggle.md

107 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

Add frontmatter to component reference pages (#881) Regenerate docs. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 18:22:23 +00:00
---
title: oh-toggle - Toggle
component: oh-toggle
label: Toggle
description: Toggle control, allows to switch on or off
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-toggle.md
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
prev: /docs/ui/components/
Add frontmatter to component reference pages (#881) Regenerate docs. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 18:22:23 +00:00
---
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
# oh-toggle - Toggle
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
<!-- Put a screenshot here if relevant:
![](./images/oh-toggle/header.jpg)
-->
[[toc]]
<!-- Note: you can overwrite the definition-provided description and add your own intro/additional sections instead -->
<!-- DO NOT REMOVE the following comments if you intend to keep the definition-provided description -->
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
<!-- GENERATED componentDescription -->
Toggle control, allows to switch on or off
<!-- GENERATED /componentDescription -->
## Configuration
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
<!-- DO NOT REMOVE the following comments -->
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
<!-- GENERATED props -->
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
### General
<div class="props">
<PropGroup label="General">
<PropBlock type="TEXT" name="item" label="Item" context="item">
<PropDescription>
Item to control
</PropDescription>
</PropBlock>
<PropBlock type="TEXT" name="color" label="Color">
<PropDescription>
Color of the control (supported values: red, green, blue, pink, yellow, orange, purple, deeppurple, lightblue, teal, lime, deeporange, gray, white, black)
</PropDescription>
</PropBlock>
<PropBlock type="TEXT" name="variable" label="Variable">
<PropDescription>
Name of the variable to set on input change
</PropDescription>
</PropBlock>
Add possibility to edit JSON variable keys in widgets (#1556) Implements a possibility to work with nested JSON objects/arrays in widget variables. It allows to set the value of a custom key of the variable. The key can be nested in any depth to allow more complex scenarios. Adds a new action configuration `actionVariableKey` which allows to set the key of the object. The configuration syntax is like this: ``` actionVariableKey: name actionVariableKey: user.name actionVariableKey: user[0].address[1].street actionVariableKey: [0] actionVariableKey: [0].label ``` If you want to edit the key `user.name` but the key `user` is missing in the object, the parent hierarchy is automatically created. (Same applies if you want to add an value to an array but the array is not existing) This should make it easier for not so advanced users. Signed-off-by: Florian Michel <florianmichel@hotmail.de> Also-by: Yannick Schaus <github@schaus.net>
2022-12-11 11:35:11 +00:00
<PropBlock type="TEXT" name="variableKey" label="Variable Key">
<PropDescription>
Consider the variable value is an object and set the corresponding deep property within that object using a key syntax. Examples: <code>user.name</code>, <code>user[0].address[1].street</code>, <code>[0]</code>, <code>[0].label</code>. The inner property and its parent hierarchy will be created if missing.
</PropDescription>
</PropBlock>
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
</PropGroup>
</div>
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
<!-- GENERATED /props -->
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
<!-- If applicable describe how properties are forwarded to a underlying component from Framework7, ECharts, etc.:
### Inherited Properties
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
-->
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
<!-- If applicable describe the slots recognized by the component and what they represent:
### Slots
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
#### `default`
Add generated component reference (#864) Add a Node.JS script to generate or update Markdown documentation from the definitions of components. Generate an initial set of pages. Signed-off-by: Yannick Schaus <github@schaus.net>
2021-02-05 14:16:35 +00:00
Component docs (#900) Signed-off-by: Andrew Black <andrewm.black@outlook.com> Also-by: Yannick Schaus <github@schaus.net>
2021-03-01 14:42:17 +00:00
The contents of the oh-toggle.
-->
<!-- Add as many examples as desired - put the YAML in a details container when it becomes too long (~150/200+ lines):
## Examples
### Example 1
![](./images/oh-toggle/example1.jpg)
```yaml
component: oh-toggle
config:
prop1: value1
prop2: value2
```
### Example 2
![](./images/oh-toggle/example2.jpg)
::: details YAML
```yaml
component: oh-toggle
config:
prop1: value1
prop2: value2
slots
```
:::
-->
<!-- Try to clean up URLs to the forum (https://community.openhab.org/t/<threadID>[/<postID>] should suffice)
## Community Resources
- [Community Post 1](https://community.openhab.org/t/12345)
- [Community Post 2](https://community.openhab.org/t/23456)
-->