openhab-docs/_addons_uis/basic
Yannick Schaus c0eef8b525
Partial merge final -> final-stable (#1569)
This performs a selective merge of the current docs into the "stable" branch
that will hold the default docs for the 3.0.2 release (until they're
replaced with the current ones once 3.1 is released).

* Backport bindings docs that looked applicable to 3.0
* Revert UI components changes not in stable

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: openHAB Build Server <infrastructure@openhab.org>
Co-authored-by: stefan-hoehn <stefan.hoehn@aoe.com>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Co-authored-by: Matt <lawrence.matt@gmail.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Kai Kreuzer <kai@openhab.org>
Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
Co-authored-by: Eiko Wagenknecht <eiko.wagenknecht@web.de>
Co-authored-by: Alexander Behring <github.com@alexander-behring.eu>
Co-authored-by: Matthew Skinner <matt@pcmus.com>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Patrick Fink <mail@pfink.de>
Co-authored-by: Gifford47 <49484063+Gifford47@users.noreply.github.com>
Co-authored-by: Seganku <seganku@users.noreply.github.com>
Co-authored-by: digitlength <62958838+digitlength@users.noreply.github.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
Co-authored-by: Jonathan Gilbert <github.10.jgilbert@xoxy.net>
Co-authored-by: Richard Koshak <rkoshak@users.noreply.github.com>
Co-authored-by: Wolfgang Schueschen <76775650+WolfgangSn@users.noreply.github.com>
Co-authored-by: Gareth Western <gareth@garethwestern.com>
Co-authored-by: Bob A <bobadair@users.noreply.github.com>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Peter Schraffl <p.schraffl@gmx.at>
Co-authored-by: Georgios Moutsos <50378548+jossuar@users.noreply.github.com>
Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: JensHoRi <47488279+JensHoRi@users.noreply.github.com>
Co-authored-by: Felix <24674809+fex01@users.noreply.github.com>
Co-authored-by: Koen Schockaert <54985218+QbusKoen@users.noreply.github.com>
Co-authored-by: Ethan Dye <mrtops03@gmail.com>
Co-authored-by: Senne Croughs <38940112+sencro@users.noreply.github.com>
Co-authored-by: Ben Clark <ben@benjyc.uk>
Co-authored-by: Sam Spencer <43712250+samsp99@users.noreply.github.com>
Co-authored-by: chingon007 <76529461+chingon007@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com>
Co-authored-by: aurelio1 <aurelio@caliaro.net>
Co-authored-by: Bernd Weymann <bernd.weymann@gmail.com>
Co-authored-by: Martin Hogg <hoggm2@hotmail.co.uk>
2021-05-15 15:11:12 +02:00
..
doc Updated external content (Jenkins build 217) 2019-04-14 07:27:28 +00:00
readme.md Partial merge final -> final-stable (#1569) 2021-05-15 15:11:12 +02:00

readme.md

id label title type description since install
basic Basic UI Basic UI - UIs ui The Basic UI is a web interface based on Material Design Lite from Google. 3x auto

{% include base.html %}

Basic UI

The Basic UI is a web interface based on Material Design Lite from Google.

Features

  • Responsive layout suitable for various screen sizes
  • AJAX navigation
  • Live update

Configuration

org.openhab.basicui:defaultSitemap=demo
# Icons can be disabled
org.openhab.basicui:enableIcons=true
# Icons can be shown as PNG or SVG images
# Default: PNG
org.openhab.basicui:iconType=svg

Accessing Sitemaps

The Basic UI has a default layout showing all things and their corresponding items. You may create your own sitemaps and access them through the basic UI in 2 ways.

  1. Set the default sitemap via the UI via Settings -> Basic UI -> Configure, and set the Default Sitemap name.

  2. Passing the "sitemap" parameter to the URL used to access the server.

Example: http://hostname:8080/basicui/app?sitemap=sitemapname

Screenshots:

Screenshot 1 Screenshot 2