Hi all,
I have at last added a whole new section in the documentation for everything related to UIs: mostly the main UI, but also others (i.e. sitemaps, HABPanel and the mobile apps have been migrated there).
So you’ll find:
-
An introduction here:
https://openhab.org/docs/ui/ -
Some documentation on the layout pages here:
https://openhab.org/docs/ui/layout-pages
(there are articles about the other types of pages as well: Maps, Floorplans, Tabbed, Charts) -
Information on building Pages & Widgets here:
https://openhab.org/docs/ui/building-pages -
A reference of all
oh-*UI components here:
https://openhab.org/docs/ui/components/
From the components reference index above you can access a description page for every component. These pages are currently entirely pre-generated by a script; so when there are more components added, or their configuration properties change, the index page and the individual components pages will be updated. However, outside these clearly identified generated sections - between comments, see here for explanations - it’s perfectly possible to edit the files from their Markdown source, including directly on GitHub, and contributions are welcome. (I’m just realizing the “Edit on GitHub” links are missing, not sure why, I’ll find a way to restore them.)
This will allow us to expand the articles on particular critical components (like oh-repeater) with:
- a detailed introduction on what the component is for, when to use it, or equally important, when not to use it (and e.g. use the related
f7-*component instead); - a screenshot of what it looks like by default;
- whether it’s a wrapper to a underlying component;
- examples of use, the more the better!
So I believe there’s still a lot of work, but now that the basic infrastructure is in place, I hope we can come up with usable docs for the UI in the foreseeable future…?!
Thanks!