Add/Update component docs

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
openhab · Oct 1, 2024 · 437540a · 437540a
1 parent 06a2572
commit 437540a
Show file tree

Hide file tree

Showing 8 changed files with 511 additions and 5 deletions.
diff --git a/bundles/org.openhab.ui/doc/components/images/oh-card/example.png b/bundles/org.openhab.ui/doc/components/images/oh-card/example.png
diff --git a/bundles/org.openhab.ui/doc/components/index.md b/bundles/org.openhab.ui/doc/components/index.md
@@ -39,6 +39,7 @@ source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.u
 
 | Component | Name | Description |
 |--------|------|-------------|
+| [`oh-card`](./oh-card.html) |  [Card](./oh-card.html) | The basic structure of all card widgets, providing title and footer and requiring a content slot |
 | [`oh-clock-card`](./oh-clock-card.html) |  [Digital Clock Card](./oh-clock-card.html) | Display a digital clock in a card |
 | [`oh-colorpicker-card`](./oh-colorpicker-card.html) |  [Color Picker Card](./oh-colorpicker-card.html) | Display a color picker in a card |
 | [`oh-gauge-card`](./oh-gauge-card.html) |  [Gauge Card](./oh-gauge-card.html) | Display a read-only gauge in a card to visualize a quantifiable item |

diff --git a/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md b/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md
@@ -46,7 +46,7 @@ Position widgets on a canvas layout with arbitrary position and size down to pix
 </PropBlock>
 <PropBlock type="INTEGER" name="screenHeight" label="Screen Height">
   <PropDescription>
-    Screen width in pixels (default 720)
+    Screen height in pixels (default 720)
   </PropDescription>
 </PropBlock>
 <PropBlock type="BOOLEAN" name="scale" label="Scaling">

diff --git a/bundles/org.openhab.ui/doc/components/oh-card.md b/bundles/org.openhab.ui/doc/components/oh-card.md
diff --git a/bundles/org.openhab.ui/doc/components/oh-slider-card.md b/bundles/org.openhab.ui/doc/components/oh-slider-card.md
@@ -80,7 +80,7 @@ Display a slider in a card to control an item
     Minimum interval between values
   </PropDescription>
 </PropBlock>
-<PropBlock type="DECIMAL" name="vertical" label="Vertical">
+<PropBlock type="BOOLEAN" name="vertical" label="Vertical">
   <PropDescription>
     Display the slider vertically
   </PropDescription>

diff --git a/bundles/org.openhab.ui/doc/components/oh-slider-cell.md b/bundles/org.openhab.ui/doc/components/oh-slider-cell.md
@@ -90,7 +90,7 @@ A cell expanding to a big vertical slider
     Minimum interval between values
   </PropDescription>
 </PropBlock>
-<PropBlock type="DECIMAL" name="vertical" label="Vertical">
+<PropBlock type="BOOLEAN" name="vertical" label="Vertical">
   <PropDescription>
     Display the slider vertically
   </PropDescription>

diff --git a/bundles/org.openhab.ui/doc/components/oh-slider-item.md b/bundles/org.openhab.ui/doc/components/oh-slider-item.md
@@ -85,7 +85,7 @@ Display a slider control in a list
     Minimum interval between values
   </PropDescription>
 </PropBlock>
-<PropBlock type="DECIMAL" name="vertical" label="Vertical">
+<PropBlock type="BOOLEAN" name="vertical" label="Vertical">
   <PropDescription>
     Display the slider vertically
   </PropDescription>

diff --git a/bundles/org.openhab.ui/doc/components/oh-slider.md b/bundles/org.openhab.ui/doc/components/oh-slider.md
@@ -48,7 +48,7 @@ Slider control, allows to pick a number value on a scale
     Minimum interval between values
   </PropDescription>
 </PropBlock>
-<PropBlock type="DECIMAL" name="vertical" label="Vertical">
+<PropBlock type="BOOLEAN" name="vertical" label="Vertical">
   <PropDescription>
     Display the slider vertically
   </PropDescription>