openhab-webui/bundles/org.openhab.ui/doc/components/oh-icon.md

12 KiB

title component label description source prev
oh-icon - Icon oh-icon Icon Display an openHAB icon https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-icon.md /docs/ui/components/

oh-icon - Icon

toc

Display an openHAB icon

Configuration

General

oh:iconName or iconName (openHAB icon), f7:iconName (Framework7 icon), material:iconName (Material icon) or iconify:iconSet:iconName (Iconify icon, requires being online if not in cache) Width of the icon in pixels Height of the icon in pixels Color of the icon (for F7/Material icons, a Framework7 color theme, for Iconify icons, a CSS color). Not applicable to OH icons. Display the icon inline (for Iconify icons only) Rotate the icon (for Iconify icons only; use a CSS value e.g. 90deg) Flips the icon horizontally (for Iconify icons only) Flips the icon vertically (for Iconify icons only) State of the icon (usually the state of an item) to use dynamic icons

Action

Action to perform when the element is clicked Type of action to perform URL to navigate to Open the URL in the same tab/window instead of a new one. This will exit the app. Item to perform the action on Command to send to the Item. If "Toogle Item" is selected as the action, only send the command when the state is different Command to send to the Item when "Toggle Item" is selected as the action, and the Item's state is equal to the command above Comma-separated list of options; if omitted, retrieve the command options from the Item dynamically. Use value=label format to provide a label different than the option. Scene, Script or Rule to run Object representing the optional context to pass. Edit in YAML or provide a JSON object, e.g. { "param1": "value1", "param2": { "subkey1": "testing", "subkey2": 123 } }. Page to navigate to Use a specific page transition animation Page or widget to display in the modal Configuration (prop values) for the target modal page or widget Array of URLs or objects representing the images. Auto-refresh is not supported.
Edit in YAML, e.g.
- item: ImageItem1
caption: Camera
or provide a JSON array, e.g.
[ "url1", { "item": "ImageItem1", "caption": "Camera" } ]
Objects are in the photos array format with an additional item property to specify an item to view. Configuration for the photo browser.
Edit in YAML or provide a JSON object, e.g.
{ "exposition": false, "type": "popup", "theme": "dark" }
See photo browser parameters (not all are supported). Group Item whose members to show in a popup Start analyzing with the specified (set of) Item(s) The initial analyzing period - dynamic or a predefined fixed period: day, week, month or year The initial coordinate system of the analyzer - time, aggregate or calendar (only time is supported for dynamic periods) Shows a toast popup when the action has been executed. Can either be a text to show or a JSON object including some of the supported parameters The variable name to set The value to set the variable to Consider the variable value is an object and set the corresponding deep property within that object using a key syntax. Examples: user.name, user[0].address[1].street, [0], [0].label. The inner property and its parent hierarchy will be created if missing.