Add frontmatter to component reference pages (#881)
Regenerate docs. Signed-off-by: Yannick Schaus <github@schaus.net>pull/883/head
Yannick Schaus
GitHub
parent
9be043e4ee
commit
5e7c092f55
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Component Reference
|
||||
description: Index of all components defined in openHAB's main UI
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/src/index.md
|
||||
---
|
||||
|
||||
# Component Reference
|
||||
|
||||
## System Widget Library
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-aggregate-series - Aggregate Series
|
||||
component: oh-aggregate-series
|
||||
label: Aggregate Series
|
||||
description: Reference documentation for the oh-aggregate-series component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-aggregate-series.md
|
||||
---
|
||||
|
||||
# oh-aggregate-series - Aggregate Series
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-block - Layout Grid Block
|
||||
component: oh-block
|
||||
label: Layout Grid Block
|
||||
description: A block in a grid layout
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-block.md
|
||||
---
|
||||
|
||||
# oh-block - Layout Grid Block
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-button - Button
|
||||
component: oh-button
|
||||
label: Button
|
||||
description: Button performing an action
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-button.md
|
||||
---
|
||||
|
||||
# oh-button - Button
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-calendar-axis - Calendar
|
||||
component: oh-calendar-axis
|
||||
label: Calendar
|
||||
description: Reference documentation for the oh-calendar-axis component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-calendar-axis.md
|
||||
---
|
||||
|
||||
# oh-calendar-axis - Calendar
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-calendar-series - Calendar Series
|
||||
component: oh-calendar-series
|
||||
label: Calendar Series
|
||||
description: Reference documentation for the oh-calendar-series component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-calendar-series.md
|
||||
---
|
||||
|
||||
# oh-calendar-series - Calendar Series
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-category-axis - Category Axis
|
||||
component: oh-category-axis
|
||||
label: Category Axis
|
||||
description: Reference documentation for the oh-category-axis component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-category-axis.md
|
||||
---
|
||||
|
||||
# oh-category-axis - Category Axis
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-cell - Cell
|
||||
component: oh-cell
|
||||
label: Cell
|
||||
description: A regular or expandable cell
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-cell.md
|
||||
---
|
||||
|
||||
# oh-cell - Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-datazoom - Data Zoom
|
||||
component: oh-chart-datazoom
|
||||
label: Data Zoom
|
||||
description: Reference documentation for the oh-chart-datazoom component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-datazoom.md
|
||||
---
|
||||
|
||||
# oh-chart-datazoom - Data Zoom
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-grid - Cartesian Grid
|
||||
component: oh-chart-grid
|
||||
label: Cartesian Grid
|
||||
description: Reference documentation for the oh-chart-grid component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-grid.md
|
||||
---
|
||||
|
||||
# oh-chart-grid - Cartesian Grid
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-legend - Legend
|
||||
component: oh-chart-legend
|
||||
label: Legend
|
||||
description: Reference documentation for the oh-chart-legend component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-legend.md
|
||||
---
|
||||
|
||||
# oh-chart-legend - Legend
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-page - Chart Page
|
||||
component: oh-chart-page
|
||||
label: Chart Page
|
||||
description: Visualize historical series
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-page.md
|
||||
---
|
||||
|
||||
# oh-chart-page - Chart Page
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-title - Title
|
||||
component: oh-chart-title
|
||||
label: Title
|
||||
description: Reference documentation for the oh-chart-title component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-title.md
|
||||
---
|
||||
|
||||
# oh-chart-title - Title
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-toolbox - Toolbox
|
||||
component: oh-chart-toolbox
|
||||
label: Toolbox
|
||||
description: Reference documentation for the oh-chart-toolbox component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-toolbox.md
|
||||
---
|
||||
|
||||
# oh-chart-toolbox - Toolbox
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-tooltip - Tooltip
|
||||
component: oh-chart-tooltip
|
||||
label: Tooltip
|
||||
description: Reference documentation for the oh-chart-tooltip component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-tooltip.md
|
||||
---
|
||||
|
||||
# oh-chart-tooltip - Tooltip
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart-visualmap - Visual Map
|
||||
component: oh-chart-visualmap
|
||||
label: Visual Map
|
||||
description: Reference documentation for the oh-chart-visualmap component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart-visualmap.md
|
||||
---
|
||||
|
||||
# oh-chart-visualmap - Visual Map
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-chart - Chart
|
||||
component: oh-chart
|
||||
label: Chart
|
||||
description: Visualize series of data
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-chart.md
|
||||
---
|
||||
|
||||
# oh-chart - Chart
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-clock-card - Digital Clock Card
|
||||
component: oh-clock-card
|
||||
label: Digital Clock Card
|
||||
description: Display a digital clock in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-clock-card.md
|
||||
---
|
||||
|
||||
# oh-clock-card - Digital Clock Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-colorpicker-card - Color Picker Card
|
||||
component: oh-colorpicker-card
|
||||
label: Color Picker Card
|
||||
description: Display a color picker in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-colorpicker-card.md
|
||||
---
|
||||
|
||||
# oh-colorpicker-card - Color Picker Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-colorpicker-cell - Colorpicker Cell
|
||||
component: oh-colorpicker-cell
|
||||
label: Colorpicker Cell
|
||||
description: A cell expanding to a color picker
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-colorpicker-cell.md
|
||||
---
|
||||
|
||||
# oh-colorpicker-cell - Colorpicker Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-colorpicker-item - Color Picker List Item
|
||||
component: oh-colorpicker-item
|
||||
label: Color Picker List Item
|
||||
description: Display a color picker in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-colorpicker-item.md
|
||||
---
|
||||
|
||||
# oh-colorpicker-item - Color Picker List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-colorpicker - Colorpicker
|
||||
component: oh-colorpicker
|
||||
label: Colorpicker
|
||||
description: Control to pick a color
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-colorpicker.md
|
||||
---
|
||||
|
||||
# oh-colorpicker - Colorpicker
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-data-series - Data Series
|
||||
component: oh-data-series
|
||||
label: Data Series
|
||||
description: Reference documentation for the oh-data-series component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-data-series.md
|
||||
---
|
||||
|
||||
# oh-data-series - Data Series
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
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
|
||||
---
|
||||
|
||||
# oh-equipment-card - Equipment Class Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-gauge-card - Gauge Card
|
||||
component: oh-gauge-card
|
||||
label: Gauge Card
|
||||
description: Display a read-only gauge in a card to visualize a quantifiable item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-gauge-card.md
|
||||
---
|
||||
|
||||
# oh-gauge-card - Gauge Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-gauge - Gauge
|
||||
component: oh-gauge
|
||||
label: Gauge
|
||||
description: Circular or semi-circular read-only gauge
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-gauge.md
|
||||
---
|
||||
|
||||
# oh-gauge - Gauge
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-grid-col - Layout Grid Column
|
||||
component: oh-grid-col
|
||||
label: Layout Grid Column
|
||||
description: A column in a grid layout
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-grid-col.md
|
||||
---
|
||||
|
||||
# oh-grid-col - Layout Grid Column
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-grid-row - Layout Grid Row
|
||||
component: oh-grid-row
|
||||
label: Layout Grid Row
|
||||
description: A row in a grid layout
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-grid-row.md
|
||||
---
|
||||
|
||||
# oh-grid-row - Layout Grid Row
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-icon - Icon
|
||||
component: oh-icon
|
||||
label: Icon
|
||||
description: Display an openHAB icon
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-icon.md
|
||||
---
|
||||
|
||||
# oh-icon - Icon
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-image-card - Image Card
|
||||
component: oh-image-card
|
||||
label: Image Card
|
||||
description: Display an image (URL or Image item ) in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-image-card.md
|
||||
---
|
||||
|
||||
# oh-image-card - Image Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-image - Image
|
||||
component: oh-image
|
||||
label: Image
|
||||
description: Displays an image from a URL or an item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-image.md
|
||||
---
|
||||
|
||||
# oh-image - Image
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-input-card - Input Card
|
||||
component: oh-input-card
|
||||
label: Input Card
|
||||
description: Display an input in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-input-card.md
|
||||
---
|
||||
|
||||
# oh-input-card - Input Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-input-item - Input List Item
|
||||
component: oh-input-item
|
||||
label: Input List Item
|
||||
description: Display an input field in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-input-item.md
|
||||
---
|
||||
|
||||
# oh-input-item - Input List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-input - Input
|
||||
component: oh-input
|
||||
label: Input
|
||||
description: Displays an input field, used to set a variable
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-input.md
|
||||
---
|
||||
|
||||
# oh-input - Input
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-knob-card - Knob Card
|
||||
component: oh-knob-card
|
||||
label: Knob Card
|
||||
description: Display a knob in a card to visualize and control a quantifiable item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-knob-card.md
|
||||
---
|
||||
|
||||
# oh-knob-card - Knob Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-knob-cell - Knob Cell
|
||||
component: oh-knob-cell
|
||||
label: Knob Cell
|
||||
description: A cell expanding to a knob control
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-knob-cell.md
|
||||
---
|
||||
|
||||
# oh-knob-cell - Knob Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-knob - Knob
|
||||
component: oh-knob
|
||||
label: Knob
|
||||
description: Knob control, allow to change a number value on a circular track
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-knob.md
|
||||
---
|
||||
|
||||
# oh-knob - Knob
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-label-card - Label Card
|
||||
component: oh-label-card
|
||||
label: Label Card
|
||||
description: Display the state of an item in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-label-card.md
|
||||
---
|
||||
|
||||
# oh-label-card - Label Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-label-cell - Label Cell
|
||||
component: oh-label-cell
|
||||
label: Label Cell
|
||||
description: A cell with a big label to show a short item state value
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-label-cell.md
|
||||
---
|
||||
|
||||
# oh-label-cell - Label Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-label-item - Label List Item
|
||||
component: oh-label-item
|
||||
label: Label List Item
|
||||
description: Display the state of an item in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-label-item.md
|
||||
---
|
||||
|
||||
# oh-label-item - Label List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-link - Link
|
||||
component: oh-link
|
||||
label: Link
|
||||
description: Link performing an action
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-link.md
|
||||
---
|
||||
|
||||
# oh-link - Link
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-list-card - List Card
|
||||
component: oh-list-card
|
||||
label: List Card
|
||||
description: Display a list in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-list-card.md
|
||||
---
|
||||
|
||||
# oh-list-card - List Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-list-item - List Item
|
||||
component: oh-list-item
|
||||
label: List Item
|
||||
description: A list item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-list-item.md
|
||||
---
|
||||
|
||||
# oh-list-item - List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-list - List
|
||||
component: oh-list
|
||||
label: List
|
||||
description: List control, hosts list items
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-list.md
|
||||
---
|
||||
|
||||
# oh-list - List
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-location-card - Location Card
|
||||
component: oh-location-card
|
||||
label: Location Card
|
||||
description: A card showing model items in a certain location
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-location-card.md
|
||||
---
|
||||
|
||||
# oh-location-card - Location Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-map-circle-marker - Circle Marker
|
||||
component: oh-map-circle-marker
|
||||
label: Circle Marker
|
||||
description: A circle on a map, to represent a radius
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-map-circle-marker.md
|
||||
---
|
||||
|
||||
# oh-map-circle-marker - Circle Marker
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-map-marker - Map Marker
|
||||
component: oh-map-marker
|
||||
label: Map Marker
|
||||
description: An icon on a map
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-map-marker.md
|
||||
---
|
||||
|
||||
# oh-map-marker - Map Marker
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-map-page - Map page
|
||||
component: oh-map-page
|
||||
label: Map page
|
||||
description: Displays markers on a map
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-map-page.md
|
||||
---
|
||||
|
||||
# oh-map-page - Map page
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-masonry - Masonry Layout
|
||||
component: oh-masonry
|
||||
label: Masonry Layout
|
||||
description: Arranges widgets automatically depending on the screen size
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-masonry.md
|
||||
---
|
||||
|
||||
# oh-masonry - Masonry Layout
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-plan-marker - Floor Plan Marker
|
||||
component: oh-plan-marker
|
||||
label: Floor Plan Marker
|
||||
description: A marker on a floor plan
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-plan-marker.md
|
||||
---
|
||||
|
||||
# oh-plan-marker - Floor Plan Marker
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-plan-page - Floor plan
|
||||
component: oh-plan-page
|
||||
label: Floor plan
|
||||
description: Displays markers on an image overlay
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-plan-page.md
|
||||
---
|
||||
|
||||
# oh-plan-page - Floor plan
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-player-card - Player Card
|
||||
component: oh-player-card
|
||||
label: Player Card
|
||||
description: Display player controls in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-player-card.md
|
||||
---
|
||||
|
||||
# oh-player-card - Player Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-player-item - Player List Item
|
||||
component: oh-player-item
|
||||
label: Player List Item
|
||||
description: Display player controls in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-player-item.md
|
||||
---
|
||||
|
||||
# oh-player-item - Player List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-player - Media player
|
||||
component: oh-player
|
||||
label: Media player
|
||||
description: Media player controls, with previous track/pause/play/next buttons
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-player.md
|
||||
---
|
||||
|
||||
# oh-player - Media player
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-property-card - Property Card
|
||||
component: oh-property-card
|
||||
label: Property Card
|
||||
description: A card showing model items related to a certain property
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-property-card.md
|
||||
---
|
||||
|
||||
# oh-property-card - Property Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-repeater - Repeater
|
||||
component: oh-repeater
|
||||
label: Repeater
|
||||
description: Iterate over an array and repeat the children components in the default slot
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-repeater.md
|
||||
---
|
||||
|
||||
# oh-repeater - Repeater
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-rollershutter-card - Rollershutter Card
|
||||
component: oh-rollershutter-card
|
||||
label: Rollershutter Card
|
||||
description: Display rollershutter controls in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-rollershutter-card.md
|
||||
---
|
||||
|
||||
# oh-rollershutter-card - Rollershutter Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-rollershutter-cell - Rollershutter Cell
|
||||
component: oh-rollershutter-cell
|
||||
label: Rollershutter Cell
|
||||
description: A cell expanding to rollershutter controls
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-rollershutter-cell.md
|
||||
---
|
||||
|
||||
# oh-rollershutter-cell - Rollershutter Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-rollershutter-item - Rollershutter List Item
|
||||
component: oh-rollershutter-item
|
||||
label: Rollershutter List Item
|
||||
description: Display rollershutter controls in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-rollershutter-item.md
|
||||
---
|
||||
|
||||
# oh-rollershutter-item - Rollershutter List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-rollershutter - Rollershutter
|
||||
component: oh-rollershutter
|
||||
label: Rollershutter
|
||||
description: Rollershutter control, with up/down/stop buttons
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-rollershutter.md
|
||||
---
|
||||
|
||||
# oh-rollershutter - Rollershutter
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-slider-card - Slider Card
|
||||
component: oh-slider-card
|
||||
label: Slider Card
|
||||
description: Display a slider in a card to control an item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-slider-card.md
|
||||
---
|
||||
|
||||
# oh-slider-card - Slider Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-slider-cell - Slider Cell
|
||||
component: oh-slider-cell
|
||||
label: Slider Cell
|
||||
description: A cell expanding to a big vertical slider
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-slider-cell.md
|
||||
---
|
||||
|
||||
# oh-slider-cell - Slider Cell
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-slider-item - Slider List Item
|
||||
component: oh-slider-item
|
||||
label: Slider List Item
|
||||
description: Display a slider control in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-slider-item.md
|
||||
---
|
||||
|
||||
# oh-slider-item - Slider List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-slider - Slider
|
||||
component: oh-slider
|
||||
label: Slider
|
||||
description: Slider control, allows to pick a number value on a scale
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-slider.md
|
||||
---
|
||||
|
||||
# oh-slider - Slider
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-stepper-card - Stepper Card
|
||||
component: oh-stepper-card
|
||||
label: Stepper Card
|
||||
description: Display a stepper in a card to control an item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-stepper-card.md
|
||||
---
|
||||
|
||||
# oh-stepper-card - Stepper Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-stepper-item - Stepper List Item
|
||||
component: oh-stepper-item
|
||||
label: Stepper List Item
|
||||
description: Display a stepper control in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-stepper-item.md
|
||||
---
|
||||
|
||||
# oh-stepper-item - Stepper List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-stepper - Stepper
|
||||
component: oh-stepper
|
||||
label: Stepper
|
||||
description: Stepper control, allows to input a number or decrement/increment it using buttons
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-stepper.md
|
||||
---
|
||||
|
||||
# oh-stepper - Stepper
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-swiper-card - Swiper Card
|
||||
component: oh-swiper-card
|
||||
label: Swiper Card
|
||||
description: Display a swiper allowing to browse slides, in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-swiper-card.md
|
||||
---
|
||||
|
||||
# oh-swiper-card - Swiper Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-swiper - Swiper
|
||||
component: oh-swiper
|
||||
label: Swiper
|
||||
description: Swiper control, allows to display multiple swipeable slides
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-swiper.md
|
||||
---
|
||||
|
||||
# oh-swiper - Swiper
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-time-axis - Time Axis
|
||||
component: oh-time-axis
|
||||
label: Time Axis
|
||||
description: Reference documentation for the oh-time-axis component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-time-axis.md
|
||||
---
|
||||
|
||||
# oh-time-axis - Time Axis
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-time-series - Time Series
|
||||
component: oh-time-series
|
||||
label: Time Series
|
||||
description: Reference documentation for the oh-time-series component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-time-series.md
|
||||
---
|
||||
|
||||
# oh-time-series - Time Series
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-toggle-card - Toggle Card
|
||||
component: oh-toggle-card
|
||||
label: Toggle Card
|
||||
description: Display a toggle swtich in a card to send ON/OFF commands
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-toggle-card.md
|
||||
---
|
||||
|
||||
# oh-toggle-card - Toggle Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-toggle-item - Toggle List Item
|
||||
component: oh-toggle-item
|
||||
label: Toggle List Item
|
||||
description: Display a toggle switch in a list
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-toggle-item.md
|
||||
---
|
||||
|
||||
# oh-toggle-item - Toggle List Item
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
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
|
||||
---
|
||||
|
||||
# oh-toggle - Toggle
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-trend - Trend line
|
||||
component: oh-trend
|
||||
label: Trend line
|
||||
description: Trend line to display the overall recent evoluation of an item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-trend.md
|
||||
---
|
||||
|
||||
# oh-trend - Trend line
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-value-axis - Value Axis
|
||||
component: oh-value-axis
|
||||
label: Value Axis
|
||||
description: Reference documentation for the oh-value-axis component
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-value-axis.md
|
||||
---
|
||||
|
||||
# oh-value-axis - Value Axis
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-video-card - Video Card
|
||||
component: oh-video-card
|
||||
label: Video Card
|
||||
description: Display a video (URL or URL from String item) in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-video-card.md
|
||||
---
|
||||
|
||||
# oh-video-card - Video Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-video - Video
|
||||
component: oh-video
|
||||
label: Video
|
||||
description: Displays a video player from a URL or an item
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-video.md
|
||||
---
|
||||
|
||||
# oh-video - Video
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-webframe-card - Web Frame Card
|
||||
component: oh-webframe-card
|
||||
label: Web Frame Card
|
||||
description: Display a web page in a card
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-webframe-card.md
|
||||
---
|
||||
|
||||
# oh-webframe-card - Web Frame Card
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: oh-webframe - Web frame
|
||||
component: oh-webframe
|
||||
label: Web frame
|
||||
description: Displays a web page in a frame
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-webframe.md
|
||||
---
|
||||
|
||||
# oh-webframe - Web frame
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
---
|
||||
title: {componentType} - {componentLabel}
|
||||
component: {componentType}
|
||||
label: {componentLabel}
|
||||
description: {componentDescription}
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/{componentType}.md
|
||||
---
|
||||
|
||||
# {componentType} - {componentLabel}
|
||||
|
||||
<!-- GENERATED componentDescription -->
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ const processComponent = (component, name) => {
|
|||
let final = doc
|
||||
final = final.replace(/\{componentType\}/g, componentType)
|
||||
final = final.replace(/\{componentLabel\}/g, component.label)
|
||||
final = final.replace(/\{componentDescription\}/g, component.description || 'Reference documentation for the ' + componentType + ' component')
|
||||
final = replaceBetweenComments('componentDescription', final, component.description || '')
|
||||
final = replaceBetweenComments('props', final, buildProps(component))
|
||||
// final = final.replace(/\{componentDescription\}/g, component.description || '')
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Component Reference
|
||||
description: Index of all components defined in openHAB's main UI
|
||||
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/src/index.md
|
||||
---
|
||||
|
||||
# Component Reference
|
||||
|
||||
## System Widget Library
|
||||
|
|
|
|||
Loading…
Reference in New Issue