| title | component | label | description | source | prev |
|---|---|---|---|---|---|
oh-label-card - Label Card |
oh-label-card |
Label Card |
Display the state of an item in a card |
/docs/ui/components/ |
[[toc]]
Display the state of an item in a card
Parameters of the card
Title of the card
Footer of the card
Do not render the card border
Do not render a shadow effect to the card
Show the card outline
Action to perform when the element is clicked
Type of action to perform
URL to navigate to or to send HTTP request to
Open the URL in the same tab/window instead of a new one. This will exit the app.
HTTP method to use for the request
Body to send with the request
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
Edit in YAML, e.g.
Objects are in the photos array format with an additional
Edit in YAML or provide a JSON object, e.g.
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 dialog or sheet to ask for confirmation before the action is executed. Can either be a text to show in the dialog or a JSON object
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
[ "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 dialog or sheet to ask for confirmation before the action is executed. Can either be a text to show in the dialog or a JSON object
{ type: "dialog", title: "Confirm", text: "Are you sure?" } or { type: "sheet", text: "Confirm", color: "green" }
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.
Action performed when tapping and holding card (or calling contextual menu on desktop)
Type of action to perform
URL to navigate to or to send HTTP request to
Open the URL in the same tab/window instead of a new one. This will exit the app.
HTTP method to use for the request
Body to send with the request
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
Edit in YAML, e.g.
Objects are in the photos array format with an additional
Edit in YAML or provide a JSON object, e.g.
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 dialog or sheet to ask for confirmation before the action is executed. Can either be a text to show in the dialog or a JSON object
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
[ "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 dialog or sheet to ask for confirmation before the action is executed. Can either be a text to show in the dialog or a JSON object
{ type: "dialog", title: "Confirm", text: "Are you sure?" } or { type: "sheet", text: "Confirm", color: "green" }
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.
Parameters of the label
Item to display
Display this text (or expression result) instead of the item's state
Background style (in CSS "background" attribute format)
Font size (e.g. "34px")
Font weight (e.g. "normal" or "bold")
Use
oh:iconName (openHAB icon), f7:iconName (Framework7 icon), material:iconName (Material icon) or iconify:iconSet:iconName (Iconify icon, requires being online if not in cache)
Not applicable to openHAB icons
Size of the icon in px
Use the state of the Item to get a dynamic icon (enabled by default for Contact, Dimmer, Rollershutter & Switch Item types) (for openHAB icons only)
Display label below icon
Show a trend line in the background
Item to show as a trend line in the background
Thickness of the trend line
Width of the trend line (leave blank to set automatically)
Colors of the trend line (see vue-trend)
Direction of the trend line gradient (default: top)
Amount of minutes between each point of the trendline (default: 60). Affected by persistence strategies different from "every minute"