Documentation for canvas layout.

ui/layout-pages.md

@@ -7,14 +7,14 @@ title: Layout Pages
 Layout Pages are used in the main web user interface to display widgets in an organized manner.
 You can choose between two different basic types of layouts:
 
-## Responsive Layouts
+- Responsive Layouts
 
 Responsive Layouts are the main layouts in openHAB and recommended for most uses. They automatically adjust to the device's screen and thus can be used as general interface from all devices.
 Within Responsive Layouts you can choose among several types of arrangements, based on whether you want to control the layout completely, or let the container decide where to place the widgets.
 
 ![Responsive Layout Page Example](./images/responsive_layout_example.png)
 
-## Fixed Grid Layouts
+- Fixed Grid Layouts
 
 Fixed Grid Layouts allow you to create a Layout Page where elements have predefined positions and sizes. They are used to design a panel-like page for a specific screen size and are most suitable for static interfaces like wall mounted tablets.
 
@@ -67,7 +67,8 @@ The breakpoints work like this: the `width` property of the column is the defaul
 
 <footnote><small>* Note that the sidebar will potentially be displayed and has a width of 260px</small></footnote>
 
-If you don't specify any width or breakpoints, the column will spread evenly on the row, without wrapping. This is fine for a couple of columns and simple widgets only, since on a small smartphone screen, you will rapidly get out of room.
+If you don't specify any width or breakpoints, the column will spread evenly on the row, without wrapping.
+This is fine for a couple of columns and simple widgets only, since on a small smartphone screen, you will rapidly get out of room.
 That's why you may find yourself wanting to let a column be 100% by default, so that it occupies the entire screen, and then reduce the width for `medium` or `large` breakpoints.
 
 For example, given this set of rows & cols:
@@ -124,7 +125,8 @@ Blocks are also good candidates to use the conditional visibility features on, w
 You can restrict what's displayed on the page based on an expression, or who is currently viewing the page.
 In Design mode, _you will not be able to see the effect of these properties_, notably `visible`, but in Run mode they will be taken into account.
 
-Under blocks, as explained above, you can have a mix of cells or rows. The 2 buttons **Add Row** and **Add Cells** will let you add more of them.
+Under blocks, as explained above, you can have a mix of cells or rows.
+The 2 buttons **Add Row** and **Add Cells** will let you add more of them.
 They will be added at the end of the block, but as for the blocks themselves, you can reorder them, or duplicate them, using the context menus or the YAML.
 
 In Design mode, rows will feature an additional step before you can actually add widgets: adding columns: the **Add Column** serves this purpose.
@@ -135,7 +137,9 @@ Big gray placeholders with a "+" sign will appear where you can add Widgets.
 
 Depending on the type of containers, different widgets from the Standard library will be offered in the menu, as well as widgets from your personal library.
 
-You will also get an additional option: **Add from Model...**. This option will display your semantic model, and let you pick one or several items, then add them in the container. The Widget that will be added will be the _default widget_ for the item for that type of container which can be controlled with metadata:
+You will also get an additional option: **Add from Model...**.
+This option will display your semantic model, and let you pick one or several items, then add them in the container.
+The Widget that will be added will be the _default widget_ for the item for that type of container which can be controlled with metadata:
 
 - for columns or masonry, the _default standalone widget_;
 - for items inside list cards, the _default list item widget_;
@@ -149,39 +153,50 @@ The widget that will be put on the page is a _copy_ of the current widget as def
 
 :::
 
-## Fixed Grid Layouts
+## Fixed Layouts
 
-The first thing to do when creating a Fixed Grid Layout is to define your screen size. In most cases this should be the **CSS Resolution** of the device you're creating this layout for.
+Fixed layouts allow you to position and size widgets freely, either on a grid with **Fixed Grid** layout, or in a completely free way with **Fixed Canvas** layouts (with **Fixed Canvas**, you are still able to temporarily switch on a grid if you want to snap some widgets).
+
+The first thing to do when creating a Fixed Layout is to define your screen size. In most cases this should be the **CSS Resolution** of the device you're creating this layout for.
 
 ::: tip Note
 
-For most modern tablets, mobile phones and some other screens the **CSS resolution** is different from the **physical pixel resolution** (sometimes referred to as *Retina* displays). The user interface tries to help you determining the CSS resolution by showing the currently detected value as *Current Screen* rate at the top of the virtual screen area.
+For most modern tablets, mobile phones and some other screens the **CSS resolution** is different from the **physical pixel resolution** (sometimes referred to as *Retina* displays).
+The user interface tries to help you determining the CSS resolution by showing the currently detected value as *Current Screen* rate at the top of the virtual screen area.
 
 :::
 
+### Fixed Grid Layouts
+
 To define your screen size open the '#' menu and click **Configure Grid Layout**.
 
-The layout editor shows a gray surface as the *virtual screen area*, which represents your defined screen. You can now place widgets on that screen by clicking the **Add Widget** button. Just like with responsive layouts a placeholder will appear, allowing you to choose widgets from the library.
+The layout editor shows a gray surface as the *virtual screen area*, which represents your defined screen.
+You can now place widgets on that screen by clicking the **Add Widget** button.
+Just like with responsive layouts a placeholder will appear, allowing you to choose widgets from the library.
 
-Additionally, you can move the widget within the virtual screen area by dragging its upper left corner at the arrow icon shown. You can also resize the widget by grabbing the handle at the bottom right corner.
+Additionally, you can move the widget within the virtual screen area by dragging its upper left corner at the arrow icon shown.
+You can also resize the widget by grabbing the handle at the bottom right corner.
 
-Positioning and resizing will snap to the underlying invisible grid. The size of that grid can be adjusted by configuring the number of columns in the layout configuration. The number of rows gets automatically aligned to create the most square-like grid.
+Positioning and resizing will snap to the underlying invisible grid.
+The size of that grid can be adjusted by configuring the number of columns in the layout configuration.
+The number of rows gets automatically aligned to create the most square-like grid.
 
 The gear icon on the top right corner of each widget allows you to configure or remove a widget.
 
-### Configuration
+#### Configuration
 
 The following parameters can be adjusted for a Fixed Grid Layout:
 
-#### Layout Settings
+##### Layout Settings
 
 *Number of Columns:*
-Number of grid columns across the page. Defaults to 16. Limited to a minimum widget width of 50px (calculated from screen width, margin and number of columns)
+Number of grid columns across the page. Defaults to 16.
+Limited to a minimum widget width of 50px (calculated from screen width, margin and number of columns)
 
 *Margin:*
 Margin between items and to screen edge in CSS pixels. Defaults to 10.
 
-#### Screen Settings
+##### Screen Settings
 
 *Screen Width:*
 Screen width in CSS pixels. Defaults to 1280.
@@ -190,15 +205,85 @@ Screen width in CSS pixels. Defaults to 1280.
 Screen width in CSS pixels. Defaults to 720.
 
 *Scaling:*
-Enabling this scales the defined screen to the width available in the browser window. All widgets are resized accordingly, with the margin staying fixed. While this works well in many cases, it can lead to unpredictable styling issues, especially on large divergence from the defined screen width. Defaults to false.
+Enabling this scales the defined screen to the width available in the browser window.
+All widgets are resized accordingly, with the margin staying fixed.
+While this works well in many cases, it can lead to unpredictable styling issues, especially on large divergence from the defined screen width.
+Defaults to false.
 
-#### Appearance
+##### Appearance
 
 *Hide Navigation Bar:*
-When enabled the navigation bar on top of a page does not get displayed on this page. In conjunction with hiding the sidebar via its pin icon, this can be used for full screen display, e.g. in a fullscreen browser or when used as Home Screen App on iOS. Defaults to false.
+When enabled the navigation bar on top of a page does not get displayed on this page.
+In conjunction with hiding the sidebar via its pin icon, this can be used for full screen display, e.g. in a fullscreen browser or when used as Home Screen App on iOS.
+Defaults to false.
 
 *Hide Sidebar Icon:*
-With the navigation bar hidden, an icon is displayed on the top left corner when the sidebar is closed. Enabling this hides the icon. Defaults to false.
+With the navigation bar hidden, an icon is displayed on the top left corner when the sidebar is closed.
+Enabling this hides the icon. Defaults to false.
 
 *Show Fullscreen Icon:*
-Show a fullscreen icon on the top right corner to enter browser fullscreen mode. Defaults to false.
+Show a fullscreen icon on the top right corner to enter browser fullscreen mode.
+Defaults to false.
+
+### Fixed Canvas Layouts
+
+To define your screen size open the canvas menu and click **Configure Canvas Layout**.
+
+The layout editor shows a gray surface as the *virtual screen area*, which represents your defined screen.
+You can now place widgets on that screen by clicking the **Add Widget** button.
+Just like with responsive layouts a placeholder will appear, allowing you to choose widgets from the library.
+
+Additionally, you can move the widget within the virtual screen area by dragging its upper left corner at the arrow icon shown.
+You can also resize the widget by grabbing the handles.
+Depending on the widget, you may also toggle the **Autosize** option in the widget options available from the gear icon on the top right corner of each widget to have the widget take its natural size.
+
+If you toggle the grid using the grid button, positioning and resizing will snap to the grid but untouched widgets will remain at their current size and position.
+The pitch of that grid can be adjusted in the layout configuration.
+
+The gear icon on the top right corner of each widget allows you to configure or remove a widget.
+
+#### Configuration
+
+The following parameters can be adjusted for a Fixed Canvas Layout:
+
+##### Layout Settings
+
+*Grid size:*
+Pitch of the grid when the editor grid button is enabled, in CSS pixels.
+
+##### Screen Settings
+
+*Screen Width:*
+Screen width in CSS pixels. Defaults to 1280.
+
+*Screen Height:*
+Screen width in CSS pixels. Defaults to 720.
+
+*Scaling:*
+Enabling this scales the defined screen to the width available in the browser window. All widgets are resized accordingly.
+While this works well in many cases, it can lead to unpredictable styling issues, especially on large divergence from the defined screen width.
+Defaults to false.
+
+*Image URL:*
+URL of the image to display in the background. The image is stretched to fit the screen size, while preserving its aspect ratio.
+If you want to achieve a different placement, adding margins to the image in an image editor will be necessary.
+
+*Image Source Set:*
+The setting is passed to the [`srcset`](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images) attribute of the image element, allowing to specify different images to be used depending on the actual resolution of the device, for example is the layout will be used both on a so called 'retina' and non-'retina' tablet.
+
+##### Widget Settings
+
+Specific widget settings are available through the gear popup menu displayed on each widget in the layout.
+It provides access to the settings related to the type of the widget (**Widget Settings**) and to settings specific to the usage of this widget within a canvas.
+
+##### Container Settings
+
+*Preserve classic style:*
+Enabling this option preserves the widget style definition as in other layout pages (responsive, fixed grid).
+Usually, this means preserving the background of the widget.
+
+*Shadow:*
+Applies a shadow to the widget inner outline.
+
+*Bring to Front*, *Mode Up*, *Move Down*, *Send to Back*:
+Change the drawing order of several overlapping widgets.