2021-02-05 18:22:23 +00:00
|
|
|
---
|
|
|
|
title: oh-equipment-card - Equipment Class Card
|
|
|
|
component: oh-equipment-card
|
|
|
|
label: Equipment Class Card
|
|
|
|
description: A card showing model items belonging to a certain equipment class
|
|
|
|
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-equipment-card.md
|
2021-03-01 14:42:17 +00:00
|
|
|
prev: /docs/ui/components/
|
2021-02-05 18:22:23 +00:00
|
|
|
---
|
|
|
|
|
2021-02-05 14:16:35 +00:00
|
|
|
# oh-equipment-card - Equipment Class Card
|
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
<!-- Put a screenshot here if relevant:
|
|
|
|

|
|
|
|
-->
|
|
|
|
|
|
|
|
[[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 -->
|
2021-02-05 14:16:35 +00:00
|
|
|
<!-- GENERATED componentDescription -->
|
|
|
|
A card showing model items belonging to a certain equipment class
|
|
|
|
<!-- GENERATED /componentDescription -->
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
<!-- DO NOT REMOVE the following comments -->
|
2021-02-05 14:16:35 +00:00
|
|
|
<!-- GENERATED props -->
|
|
|
|
### Model Card
|
2021-03-01 14:42:17 +00:00
|
|
|
<div class="props">
|
|
|
|
<PropGroup name="card" label="Model Card">
|
|
|
|
General settings for this card
|
|
|
|
<PropBlock type="TEXT" name="title" label="Title">
|
|
|
|
<PropDescription>
|
|
|
|
Title of the card
|
|
|
|
</PropDescription>
|
|
|
|
</PropBlock>
|
|
|
|
<PropBlock type="TEXT" name="subtitle" label="Subtitle">
|
|
|
|
<PropDescription>
|
|
|
|
Subtitle of the card
|
|
|
|
</PropDescription>
|
|
|
|
</PropBlock>
|
|
|
|
<PropBlock type="TEXT" name="backgroundColor" label="Background Color">
|
|
|
|
<PropDescription>
|
|
|
|
Color of the card's background; if unset, choose automatically from built-in defaults for certain semantic classes
|
|
|
|
</PropDescription>
|
|
|
|
<PropOptions>
|
|
|
|
<PropOption value="red" label="Red" />
|
|
|
|
<PropOption value="green" label="Green" />
|
|
|
|
<PropOption value="blue" label="Blue" />
|
|
|
|
<PropOption value="pink" label="Pink" />
|
|
|
|
<PropOption value="yellow" label="Yellow" />
|
|
|
|
<PropOption value="(empty)" label="Orange" />
|
|
|
|
<PropOption value="purple" label="Purple" />
|
|
|
|
<PropOption value="deeppurple" label="Deep Purple" />
|
|
|
|
<PropOption value="lightblue" label="Light Blue" />
|
|
|
|
<PropOption value="teal" label="Teal" />
|
|
|
|
<PropOption value="lime" label="Lime" />
|
|
|
|
<PropOption value="deeporange" label="Deep Orange" />
|
|
|
|
<PropOption value="gray" label="Gray" />
|
|
|
|
<PropOption value="black" label="Black" />
|
|
|
|
</PropOptions>
|
|
|
|
</PropBlock>
|
|
|
|
<PropBlock type="TEXT" name="backgroundImage" label="Background Image">
|
|
|
|
<PropDescription>
|
|
|
|
URL of an image to display in the background
|
|
|
|
</PropDescription>
|
|
|
|
</PropBlock>
|
|
|
|
<PropBlock type="BOOLEAN" name="invertText" label="Invert Text">
|
|
|
|
<PropDescription>
|
|
|
|
Display the text in black (for light backgrounds)
|
|
|
|
</PropDescription>
|
|
|
|
</PropBlock>
|
|
|
|
</PropGroup>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- GENERATED /props -->
|
2021-02-05 14:16:35 +00:00
|
|
|
|
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
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
-->
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
<!-- If applicable describe the slots recognized by the component and what they represent:
|
|
|
|
### Slots
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
#### `default`
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
The contents of the oh-equipment-card.
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
-->
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
<!-- Add as many examples as desired - put the YAML in a details container when it becomes too long (~150/200+ lines):
|
|
|
|
## Examples
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
### Example 1
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|

|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
```yaml
|
|
|
|
component: oh-equipment-card
|
|
|
|
config:
|
|
|
|
prop1: value1
|
|
|
|
prop2: value2
|
|
|
|
```
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
### Example 2
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|

|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
::: details YAML
|
|
|
|
```yaml
|
|
|
|
component: oh-equipment-card
|
|
|
|
config:
|
|
|
|
prop1: value1
|
|
|
|
prop2: value2
|
|
|
|
slots
|
|
|
|
```
|
|
|
|
:::
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
-->
|
2021-02-05 14:16:35 +00:00
|
|
|
|
2021-03-01 14:42:17 +00:00
|
|
|
<!-- 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)
|
|
|
|
-->
|