diff --git a/docs/management/boards/img/create-board-modal.png b/docs/management/boards/img/create-board-modal.png index a3f9322f..9415434c 100644 Binary files a/docs/management/boards/img/create-board-modal.png and b/docs/management/boards/img/create-board-modal.png differ diff --git a/docs/management/boards/img/layout-settings.png b/docs/management/boards/img/layout-settings.png index 7266015c..bbc57d5d 100644 Binary files a/docs/management/boards/img/layout-settings.png and b/docs/management/boards/img/layout-settings.png differ diff --git a/docs/management/boards/index.mdx b/docs/management/boards/index.mdx index 448be873..19b1bb77 100644 --- a/docs/management/boards/index.mdx +++ b/docs/management/boards/index.mdx @@ -14,6 +14,7 @@ import itemRadiusImage from './img/item-radius.png' import layoutLargeImage from './img/layout-large.png' import layoutMediumImage from './img/layout-medium.png' import layoutSmallImage from './img/layout-small.png' +import {GridLayout} from '@site/src/components/grid-layout'; Each dashboard is called a "board". You can create as many boards as you want. @@ -32,6 +33,14 @@ When creating a board, the availability of the board name will be checked for yo The name must not include any special characters and must be at least one character long. Underscores and hyphen-minus are allowed. +### Layout mode + +There are two layout modes available. They define how the board will behave on different screen sizes. +- **Auto:** The board items will adjust for different screen sizes automatically based on the base layout. +- **Custom:** The board items have to be adjusted manually for different screen sizes. + +For visualization of the two modes, see [here](#visualizations). + ### Column count Homarr has a complex drag and drop system that can be used from the browser. The column count defines how many horizontal columns are available to drag and drop elements to. @@ -84,6 +93,59 @@ On each element the position and size of items can be changed seperately. When adding a new layout the position and sizes will automatically be generated depending on the column count. When adding a new item / dynamic section that will always be 1x1 on each layout and placed on the first available position. +#### Layout mode + +There are two layout modes available. They define how the board will behave on different screen sizes. +- **Auto:** The board items will adjust for different screen sizes automatically based on the base layout +- **Custom:** The board items have to be adjusted manually for different screen sizes. + +##### Visualizations + +This is how the different layout modes behave on different screen sizes with the 8 column layout as base: + +