diff --git a/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx b/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx index e3aa71389..eeec4ee6d 100644 --- a/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx +++ b/apps/docs/docs/advanced/keyboard-shortcuts/index.mdx @@ -6,14 +6,32 @@ tags: Homarr has the following keyboard shortcuts: -| Shortcut | Description | -| ----------------------------------------------- | ------------------------------------------ | -| `MOD` + `K` | Opens the search bar | -| `MOD` + `J` | Toggles Dark Mode | -| `MOD` + `E` | Toggles Edit Mode | -| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view | -| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed | -| `Esc` | Closes an open advanced view or board menu | +| Shortcut | Description | +| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `MOD` + `K` | Opens the search bar | +| `MOD` + `J` | Toggles Dark Mode | +| `MOD` + `E` | Toggles Edit Mode | +| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view | +| `Shift` + `Enter` on a supported widget | Opens its advanced view until it is closed | +| `Esc` | Stops keyboard tile editing, cancels an active pointer or touch move/resize, or closes an open advanced view or board menu | + +## Board editing + +`MOD` + `E` enters edit mode. Homarr keeps the current board visible while the editor prepares; movement and resizing become available when it is ready. + +When a tile is focused in edit mode: + +| Shortcut | Description | +| -------------------- | --------------------------------------------------------------------------- | +| `Enter` or `Space` | Starts or stops keyboard editing | +| Arrow keys | Moves the focused tile within its current canvas, rail, or Container | +| `Shift` + Arrow keys | Resizes from the tile's lower-right corner: Left/Up shrink; Right/Down grow | +| `Esc` | Stops keyboard editing without undoing its changes | + +Keyboard moves and resizes apply immediately. To move an item between a canvas, rail, or Container, drag it there or use **Move / resize item** for precise numeric placement. +Commands at a grid boundary or at the tile's minimum size are ignored and announced instead of moving or shrinking the tile. + +On touch screens, press and hold a tile before moving it; a quick tap does not start a drag. Resize handles accept direct touch input. During a pointer or touch move or resize, `Esc` cancels the interaction and restores the layout from before it started. ## Board editing diff --git a/apps/docs/docs/advanced/styling/img/custom-css-setting.png b/apps/docs/docs/advanced/styling/img/custom-css-setting.png index 63385622f..19f0a0d26 100644 Binary files a/apps/docs/docs/advanced/styling/img/custom-css-setting.png and b/apps/docs/docs/advanced/styling/img/custom-css-setting.png differ diff --git a/apps/docs/docs/advanced/styling/index.mdx b/apps/docs/docs/advanced/styling/index.mdx index 56d4305e5..ed2faac99 100644 --- a/apps/docs/docs/advanced/styling/index.mdx +++ b/apps/docs/docs/advanced/styling/index.mdx @@ -85,8 +85,8 @@ To do this, enter the board settings: ![](./img/enter-board-settings.png) -Scroll down a bit and click on custom CSS. -Here you can enter your CSS code, which will be applied on the respective board page. +Scroll to the **Custom CSS** section on the board settings page. It is part of the unified settings form; enter your CSS +there and save the board settings to apply it to that board. ![](./img/custom-css-setting.png) diff --git a/apps/docs/docs/getting-started/after-the-installation.mdx b/apps/docs/docs/getting-started/after-the-installation.mdx index 5cbe64858..d7485127f 100644 --- a/apps/docs/docs/getting-started/after-the-installation.mdx +++ b/apps/docs/docs/getting-started/after-the-installation.mdx @@ -6,10 +6,16 @@ tags: - Configuration --- -import manageBoardHeaderEditMode from "./img/manage-board-header-edit-mode.png"; -import manageBoardHeaderAddItem from "./img/manage-board-header-add-item-menu.png"; -import manageBoardHeaderChooseItem from "./img/manage-board-header-choose-item.png"; import manageBoardNoApp from "./img/manage-board-no-app.png"; +import currentKeyboardTileEditing from "../management/boards/img/keyboard-tile-editing.png"; +import boardDesktopCurrent from "./img/onboarding-board-desktop-current.png"; +import boardEditModeCurrent from "./img/onboarding-board-edit-mode-current.png"; +import addContentMenuCurrent from "./img/onboarding-add-content-menu-current.png"; +import chooseItemCurrent from "./img/onboarding-choose-item-current.png"; +import editItemCurrent from "./img/onboarding-edit-item-current.png"; +import boardsHomeMobileMenu from "./img/onboarding-boards-home-mobile-menu.png"; +import moveResizeMenuCurrent from "./img/onboarding-move-resize-menu-current.png"; +import currentBoardMobileView from "./img/onboarding-board-mobile-current.png"; :::tip @@ -72,9 +78,25 @@ Public boards are also accessible for users, that are not logged in ([see access ![](./img/manage-create-board-modal.png) -Congratulations - you've just created your first board. You can see boards, that you have access to, on this page: +Congratulations - you've just created another board. You can see the boards you have access to on this page: -![](./img/manage-view-board.png) +
+ Boards management page showing a Home badge and separate desktop and mobile home-board menu entries +
The Boards page selects the board opened from Home separately for desktop and mobile.
+
+ +The board marked **Home** is the board opened from the desktop Home route. **Set as your mobile board** selects which board +opens on phones. This is separate from the **Mobile** layout: the home-board setting chooses a board, while **Mobile** and +**Base** are responsive layouts inside that board. A phone can therefore open a different home board and still use that +board's Mobile layout. + +New boards start with **Mobile** and **Base** responsive layouts automatically, so you can edit the board for phones and +desktops without creating extra layouts first. Mobile starts at `0px` with 3 columns and Base at `768px` with 10 columns. +Each layout keeps its own tile positions and sizes. ## Add your first app to Homarr @@ -98,37 +120,63 @@ After you created the app, you'll see in on the apps page: Let's add your freshly created app, from the previous step, to the board. To do this, edit your previously created board by clicking on the big `Open board` button: -![](./img/manage-view-board.png) +
+ Current Homarr board opened from the Boards page +
Open a board to view its dashboard, then enter edit mode to arrange its content.
+
Here you have the following options in the header: ![](./img/manage-board-header.png) - **Search**: Here you can search for data. You can search for integrations, boards, actions, sites and much more. Some actions may be context dependent (eg. will only show when certain widgets are on your page) -- **Edit mode**: Clicking this button will toggle the edit mode. In this mode you can edit the contents of your board. +- **Edit board**: Clicking this button will toggle edit mode. In this mode you can edit the contents of your board. - **Settings**: Clicking this button will redirect you to a settings page where you can adjust the board settings (page title, colors, ...). +- **Board switcher**: Use this button to open another board that you can access. - **Profile**: This avatar will be visible on every page. Clicking it will show a menu with actions. When entering the edit mode, you'll get some additional buttons to work with: -{"Screenshot +
+ Current Homarr board editor with tile controls visible +
The current editor keeps the board visible while its editing controls are available.
+
-- **Add item**: Click this button to add new elements to your page. -- **Exit edit mode**: Click this button to save your changes and exit edit mode. +- **Add board content**: Click this button to create a new item, app, integration, or Container. +- **Save board**: Click this button to save your changes and leave edit mode. If you leave with unsaved changes, Homarr asks whether to discard them. Outside edit mode, right-click a widget for its live status, refresh, settings, quick options, and supported actions. Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the rest of the board stays visible but dimmed. Release `Shift` to close it. You can also focus that widget and press `Shift` + `Enter` to keep its advanced view open until you close it. Widgets without a distinct advanced experience adapt in place. -To continue, click the option "New Item": +To continue, click **New item** in the add-content menu. New content is placed at the first available position on the main +canvas; it is not inserted at a clicked empty cell or directly into a rail or Container: -{"Screenshot +
+ Current add board content menu with item, app, integration, and Container actions +
The add-content menu provides the four supported ways to place new content on the board.
+
Next, you can choose what item you'd like to add. We will discuss the other options in the following sections - for now choose "App" to continue. -{"Screenshot +
+ Current item picker showing the App card and other item types +
Choose the App item from the current picker to add an app tile.
+
As soon as you chose the app, the modal will close and you'll get the following item on your board: @@ -137,31 +185,52 @@ As soon as you chose the app, the modal will close and you'll get the following This is expected, because you haven't told Homarr what app it should show in this item. To configure this, click on the small 3 dots at the top of the item in the edit mode and choose "Edit item" in the menu. -![](./img/manage-board-edit-app.gif) +
+ Current board tile menu showing Edit item and Move or resize item +
The tile menu contains the item editor and the separate move-and-resize tools.
+
In the modal you can edit the app that you want to display: -![](./img/manage-board-choose-app.png) +
+ Current Edit item modal for an App tile +
Use the Edit item modal to choose the app and configure how its tile is displayed.
+
As soon as you save your changes, the tile on the board will refresh and display your app. -Use the resize handle at the bottom right to resize the tile. -Press and hold the handle, move the pointer, and release it when the tile has the size you want. +Resize from any visible edge or corner handle. For a Container, activate its top-left grip before using its resize handles. +Press and hold a handle, move the pointer, and release it when the tile has the size you want. -![](./img/resize-item.gif) - -To move a tile in edit mode, press and hold its content, move it to the desired position, and release it. +To move a tile in edit mode, press and hold its inert content area, move it to the desired position, and release it. Widget content is disabled while editing so its controls do not intercept the drag; use the tile's settings button for edit actions. -The tile snaps to the grid. Equally-sized tiles swap when one is dropped into the other's slot, while other neighboring tiles move out of the way automatically. - -![](./img/move-item.gif) +The tile snaps to the grid. A single compatible collision may swap the two items when both resulting placements fit; +otherwise the collision chain reflows neighboring tiles automatically. Every `1 × 1` tile has a logical content size of `200 × 200` pixels. Larger tiles use multiples of that fixed unit, with a consistent gap between cells. Homarr scales the complete board uniformly, like zooming a page. -The complete canvas always fits the available width without horizontal board scrolling. -Below 100%, Homarr preserves the widget's readable typography and control density instead of shrinking each widget independently. +The complete canvas always fits the available width without horizontal board scrolling. Below 100%, Homarr preserves the +widget's readable typography and control density instead of shrinking each widget independently. It does not squeeze or reflow the content of individual widgets, so a widget keeps the same design and proportions across screen sizes. +On a narrow screen, Homarr uses the **Mobile layout** for the selected board and stacks the board content vertically while +preserving each widget's fixed logical proportions: + +
+ Homarr's Mobile layout in a 390-pixel-wide viewport, with tiles scaled to fit and stacked vertically +
+ At phone width, the selected board uses its Mobile layout and fits the complete canvas to the viewport. +
+
+ :::note Viewing a board initially uses the lightweight, non-interactive layout. @@ -177,16 +246,17 @@ This helps you to explore the capabilities of Homarr before you build your board ::: -Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize. -Press Escape to stop. -For precise numeric controls or touch input, choose **Move / resize item** from the tile's edit menu. -The dialog can also move the tile to another section or fixed sidebar: +Keyboard users can focus a tile, press Enter or Space, then use arrow keys to move and Shift plus arrow keys to resize +within its current canvas, rail, or Container. Press Escape to stop keyboard editing. Touch dragging starts after a short +hold of about `200 ms`; resize handles accept direct touch input. During a pointer or touch move or resize, press Escape +to cancel and restore the previous layout. For cross-grid moves or precise numeric controls, choose **Move / resize item** +from the tile's edit menu. +Keyboard commands at a grid boundary or minimum tile size are ignored and announced; they do not move or shrink the tile. -![](./img/manage-board-move-resize-item-menu.png) +A board tile focused for keyboard editing -Be sure to save your changes by exiting edit mode! - -![](./img/exit-edit-mode.png) +Open **Move / resize item** from the tile menu to move the tile to another section or rail and enter precise numeric +coordinates and dimensions. After making changes, click **Save board** to persist them and leave edit mode. ## Adding your first integration @@ -221,7 +291,14 @@ Let's add your integration, that you have configured in the section above, as a First, navigate back to your board that you want to add it to. Next, enter edit mode again and add another item to your board: -![](./img/manage-board-header-add-item-menu.png) +
+ Current add board content menu with item, app, integration, and Container actions +
Use the same add-content menu to place an integration widget on the board.
+
Instead of choosing an app, let's choose `System Health Monitoring` this time. Click on "Add to board": @@ -248,9 +325,7 @@ Editing a widget will trigger a data update and data will soon appear: ![](./img/widget-system-health.png) -As with every change, don't forget to save your changes using the exit edit mode button: - -![](./img/exit-edit-mode.png) +As with every change, click **Save board** to persist your board changes and leave edit mode. ## Organizing items with Containers @@ -263,7 +338,7 @@ Each Container can configure: - Show or hide **Open all in new tabs**. - Change its border color and custom CSS classes. -Open the add-content menu and choose **New Container**. +Open the add-content menu and choose **New container**. In edit mode, move and resize it like any other item, then drag items into or out of it. Nested content stays within the Container's bounds. While resizing, the solid outline follows the pointer continuously and the dashed grid preview shows the size that will be saved on release. diff --git a/apps/docs/docs/getting-started/img/board-mobile-view.png b/apps/docs/docs/getting-started/img/board-mobile-view.png new file mode 100644 index 000000000..87686b455 Binary files /dev/null and b/apps/docs/docs/getting-started/img/board-mobile-view.png differ diff --git a/apps/docs/docs/getting-started/img/manage-board-header-add-item-menu.png b/apps/docs/docs/getting-started/img/manage-board-header-add-item-menu.png index 47b2d0bdf..7e3598759 100644 Binary files a/apps/docs/docs/getting-started/img/manage-board-header-add-item-menu.png and b/apps/docs/docs/getting-started/img/manage-board-header-add-item-menu.png differ diff --git a/apps/docs/docs/getting-started/img/manage-board-header-edit-mode.png b/apps/docs/docs/getting-started/img/manage-board-header-edit-mode.png index 297cd13f6..b5b5a6b87 100644 Binary files a/apps/docs/docs/getting-started/img/manage-board-header-edit-mode.png and b/apps/docs/docs/getting-started/img/manage-board-header-edit-mode.png differ diff --git a/apps/docs/docs/getting-started/img/manage-board-header.png b/apps/docs/docs/getting-started/img/manage-board-header.png index 2229b80dd..8c1f55618 100644 Binary files a/apps/docs/docs/getting-started/img/manage-board-header.png and b/apps/docs/docs/getting-started/img/manage-board-header.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-add-content-menu-current.png b/apps/docs/docs/getting-started/img/onboarding-add-content-menu-current.png new file mode 100644 index 000000000..3d05ac9c4 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-add-content-menu-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-board-desktop-current.png b/apps/docs/docs/getting-started/img/onboarding-board-desktop-current.png new file mode 100644 index 000000000..ece8f4b40 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-board-desktop-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-board-edit-mode-current.png b/apps/docs/docs/getting-started/img/onboarding-board-edit-mode-current.png new file mode 100644 index 000000000..e0bbac8b7 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-board-edit-mode-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-board-mobile-current.png b/apps/docs/docs/getting-started/img/onboarding-board-mobile-current.png new file mode 100644 index 000000000..d84733829 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-board-mobile-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-boards-home-mobile-menu.png b/apps/docs/docs/getting-started/img/onboarding-boards-home-mobile-menu.png new file mode 100644 index 000000000..f7332bba4 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-boards-home-mobile-menu.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-choose-item-current.png b/apps/docs/docs/getting-started/img/onboarding-choose-item-current.png new file mode 100644 index 000000000..3fcb2f4bb Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-choose-item-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-edit-item-current.png b/apps/docs/docs/getting-started/img/onboarding-edit-item-current.png new file mode 100644 index 000000000..8fe412aa7 Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-edit-item-current.png differ diff --git a/apps/docs/docs/getting-started/img/onboarding-move-resize-menu-current.png b/apps/docs/docs/getting-started/img/onboarding-move-resize-menu-current.png new file mode 100644 index 000000000..c6559a58d Binary files /dev/null and b/apps/docs/docs/getting-started/img/onboarding-move-resize-menu-current.png differ diff --git a/apps/docs/docs/management/api/index.mdx b/apps/docs/docs/management/api/index.mdx index 35e9f49e4..82fde7057 100644 --- a/apps/docs/docs/management/api/index.mdx +++ b/apps/docs/docs/management/api/index.mdx @@ -93,6 +93,10 @@ an optional `error` on a failed integration; media-request responses expose a `f requests endpoint returns its items in `requests`. When every selected integration fails, the query returns an error instead of a partial response. +Other widgets use the same settlement pattern with endpoint-specific shapes: a failed integration may appear as a named +fallback row, in a failure array, or be omitted while healthy results remain. Widget pages should identify the shape they +render rather than assuming every query exposes an `error` field. + ### Saving dashboard layouts The dashboard editor saves item positions and sections as one board update. diff --git a/apps/docs/docs/management/boards/img/board-edit-mode.png b/apps/docs/docs/management/boards/img/board-edit-mode.png new file mode 100644 index 000000000..568e42253 Binary files /dev/null and b/apps/docs/docs/management/boards/img/board-edit-mode.png differ diff --git a/apps/docs/docs/management/boards/img/board-view-mode.png b/apps/docs/docs/management/boards/img/board-view-mode.png new file mode 100644 index 000000000..bf9e51223 Binary files /dev/null and b/apps/docs/docs/management/boards/img/board-view-mode.png differ diff --git a/apps/docs/docs/management/boards/img/keyboard-tile-editing.png b/apps/docs/docs/management/boards/img/keyboard-tile-editing.png new file mode 100644 index 000000000..d650821fc Binary files /dev/null and b/apps/docs/docs/management/boards/img/keyboard-tile-editing.png differ diff --git a/apps/docs/docs/management/boards/img/layout-settings-custom-rails.png b/apps/docs/docs/management/boards/img/layout-settings-custom-rails.png new file mode 100644 index 000000000..7284c5831 Binary files /dev/null and b/apps/docs/docs/management/boards/img/layout-settings-custom-rails.png differ diff --git a/apps/docs/docs/management/boards/img/layout-settings.png b/apps/docs/docs/management/boards/img/layout-settings.png index 7266015cd..5b956cad7 100644 Binary files a/apps/docs/docs/management/boards/img/layout-settings.png and b/apps/docs/docs/management/boards/img/layout-settings.png differ diff --git a/apps/docs/docs/management/boards/index.mdx b/apps/docs/docs/management/boards/index.mdx index 261b0058c..2d14a6016 100644 --- a/apps/docs/docs/management/boards/index.mdx +++ b/apps/docs/docs/management/boards/index.mdx @@ -11,15 +11,17 @@ tags: import iconColorImage from "./img/icon-color.png"; 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 layoutSettingsImage from "./img/layout-settings.png"; +import layoutSettingsCustomRailsImage from "./img/layout-settings-custom-rails.png"; +import boardViewModeImage from "./img/board-view-mode.png"; +import boardEditModeImage from "./img/board-edit-mode.png"; +import keyboardTileEditingImage from "./img/keyboard-tile-editing.png"; Each dashboard is called a "board". You can create as many boards as you want. Boards can be restricted to user groups. -A user may also have a "home board" which they will see at the root path (e.g. my-homarr.com or my-homarr.com/board). -Other boards can be viewed by direct links (e.g. my-homarr.com/board/smart-home) or via the management pages. +A user may also have a "home board" which they will see at the root path (e.g. my-homarr.com or my-homarr.com/boards). +Other boards can be viewed by direct links (e.g. my-homarr.com/boards/smart-home) or via the management pages. The management page includes a compact structural preview of each board's Base layout so you can recognize it before opening it. Containers include their visible widgets and app icons instead of appearing empty. @@ -94,9 +96,23 @@ Homarr will fall back to the Homarr logo if nothing is set. In this section you can configure the different responsive layouts. Homarr selects the layout with the highest breakpoint that is not wider than the current screen, then scales its complete fixed-size canvas uniformly. -![](./img/layout-settings.png) +Board settings showing protected Mobile and Base responsive layouts with rail controls -Every board has two protected layouts: +The layout cards show the representative geometry used for planning. This current example also shows a custom layout +with both fixed rails enabled; the rails reserve columns and the remaining canvas reflows automatically. + +Board layout settings with a custom layout and both fixed rails enabled + +Every board has two protected layouts. Creating a board adds **Mobile** at `0px` with three columns and **Base** at +`768px` with the column count you choose. Both layouts can be edited, but neither can be removed. Every `1 × 1` tile has a `200 × 200` logical-pixel content area. The `24` logical-pixel gap between tiles is separate from that size. @@ -109,9 +125,18 @@ The complete canvas always fits the available width and never adds horizontal bo - **Mobile** starts at `0px` and uses three columns on new boards. - **Base** is the widest layout and starts at `768px` on new boards. -Mobile and Base can be renamed and their column counts can be changed, but they cannot be removed. Mobile has no fixed rails; rail configuration is available only on Base and custom layouts. You can add removable custom layouts between their breakpoints. +Mobile and Base can be renamed and their column counts can be changed, but they cannot be removed. Mobile has no fixed +rails; rail configuration is available only on Base and custom layouts. You can add removable custom layouts between +their breakpoints. -Each layout stores independent positions and sizes. Moving or resizing a widget while editing Mobile does not move it in Base or any custom layout. New custom layouts are generated from Base and scaled to their selected column count. +Each layout stores independent positions and sizes. Moving or resizing a widget while editing Mobile does not move it in +Base or any custom layout. New custom layouts start from Base's current column count and rail widths; Homarr chooses a +free breakpoint between Mobile and Base, and you can then change the breakpoint, columns, and rails. + +Older or incomplete boards are repaired automatically. A board with no layouts receives Mobile at `0px` with three +columns and Base at `768px` with ten columns. A board with one layout keeps it as Base and receives a generated Mobile +layout. With multiple layouts, the narrowest becomes Mobile, the widest becomes Base, and intermediate layouts remain +custom. Duplicate or out-of-order breakpoints are normalized without discarding saved positions. Use **Reset from Base** on Mobile or a custom layout to replace all of its positions and sizes with a newly generated version of Base. The layout's name, breakpoint, and column count are kept. @@ -130,13 +155,14 @@ The total number of columns in the layout. Changing it projects the saved positi #### Fixed rails -Base and custom responsive layouts can enable a fixed left rail, a fixed right rail, or both. Mobile has no fixed rails. +Each responsive layout can enable a fixed left rail, a fixed right rail, or both. Set a rail width to zero to disable it for that layout. Choose a width from one to three columns with the three-step slider. The preview shows how much space remains for the main canvas. Rail columns are reserved from the layout's total column count. For example, a 12-column layout with a two-column left rail leaves ten columns for the canvas. +The combined rail widths cannot consume the final main-canvas column. Enabling or widening a rail reflows canvas items into the remaining columns. Disabling a rail moves its contents back into the next available canvas positions. @@ -145,39 +171,63 @@ Apps, widgets, and Containers inside them still use the same fixed `200 × 200` #### Breakpoint -The minimum screen width where the layout is used. Mobile is fixed at `0px`. Custom breakpoints must be unique and sit between Mobile and Base. Base must remain the highest breakpoint. +The minimum screen width where the layout is used; a layout is eligible at its breakpoint and above. Mobile is fixed at +`0px`. Custom breakpoints must be unique and sit between Mobile and Base. Base must remain the highest breakpoint. +When the initial viewport is not available, Homarr uses its remembered viewport information, client hints, or User-Agent +fallback to select a layout. #### View and edit modes View mode renders a static board without executing the drag-and-drop editor. After the board is interactive, Homarr prepares the editor in the background for users who can modify it. -Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing without changing the board geometry. -Widget content is inert in edit mode, so dragging anywhere on the content moves the tile instead of activating the widget; its settings button remains visible in the compact header above the tile. -Dropping a tile into another tile's exact slot swaps their positions when both resulting placements fit without overlapping other content. -For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way. +Entering edit mode keeps the static board visible until that preparation finishes, then enables collision-aware movement and resizing. +Collapsed Containers are expanded while editing so their contents and controls are reachable. + +A Homarr board in view mode with the dashboard canvas and static widgets visible + +Widget content is inert in edit mode, so dragging from the inert widget area moves the tile instead of activating the widget; +settings and other controls remain usable in the compact header above the tile. +A single compatible collision can swap two items when both resulting placements fit, including different-sized or lateral moves. +For other collisions, or when a tile grows into occupied space, nearby tiles are compacted out of the way and collision chains reflow. The visible corner controls provide a 44-pixel resize target, and edge controls appear on hover for horizontal or vertical resizing. Resize handles stop at the tile's minimum allowed size while the pointer is still moving. -Exit edit mode to save the resulting positions. +Use the pencil button in the board header to enter edit mode; click it again to save. If you leave the page with unsaved +changes, Homarr asks whether to discard them. If the editor cannot load, the board remains in view mode. -Pointer users can drag anywhere on a widget tile. Containers use the grab button at their top-left corner. -Resize tiles from any edge or corner handle. -On a touch screen, press and hold the tile before moving it; resize handles support direct touch input. +Board in edit mode with the board header controls and editable dashboard tiles visible + +Pointer users can drag from the inert widget area; interactive controls are excluded. Containers use the grab button at their top-left corner. +Widgets can be resized from any edge or corner handle. Activate a Container's chrome with its top-left grip before using +its resize handles. +On a touch screen, press and hold a tile for about `200 ms` before moving it; a quick tap does not start a drag. Resize +handles support direct touch input. Keyboard users can focus a tile, press Enter or Space to start editing, use the arrow keys to move it, and use Shift plus the arrow keys to resize it. Press Enter, Space, or Escape to stop keyboard editing. -Keyboard moves and resizes apply immediately; Escape stops keyboard editing without undoing those changes. +Keyboard moves and resizes apply immediately within the current canvas, rail, or Container; they cannot move an item +between grids. Use pointer drag or **Move / resize item** for that. +Escape stops keyboard editing without undoing those changes. During a pointer or touch interaction, Escape cancels the move or resize and restores the layout from before that interaction. +Invalid, outside, or otherwise forbidden drops are cancelled in the same way. The **Move / resize item** action in the edit menu remains available for precise numeric input. +A focused board tile in keyboard editing mode + #### Preview -Layout Settings shows a lightweight structural preview for every layout, including saved spans, Containers, widget labels, and app icons. The canvas width represents the screen range where that layout is active. +Layout Settings shows a lightweight structural preview for every layout, including saved spans, Containers, widget labels, and app icons. +It uses a representative viewport width to project the saved geometry; it does not execute widget queries or represent every +pixel of the screen range where the layout is active. Choose **Edit layout** to open the real board editor at that representative width on desktop. Save returns to Layout Settings. Cancel discards the local changes. On phones and tablets, the normal board editor continues to use the layout selected by the device width. - - - - ### Containers and rails Containers can hold apps, widgets, and nested Containers. @@ -249,9 +299,10 @@ Change the radius of your items and Containers. This is the field where you can enter custom CSS. The styling will only be applied on the respective board page. -When Homarr Assistant is enabled, users with modify permission can also ask it to edit the board's Custom -CSS and other visual or behavior settings. The assistant reads the current stylesheet first and presents an -editable review form before requesting approval to save the change. +When Homarr Assistant is enabled, users with modify permission can also ask it to edit the board's General, Background, +Appearance, Custom CSS, and app-status settings. The assistant reads the current stylesheet first and presents an +editable review form before requesting approval to save the change. It does not edit responsive layouts, access control, +or Danger zone actions. [See this guide on how to work with custom CSS](/docs/advanced/styling/). @@ -268,12 +319,12 @@ Widgets expose their routine controls without requiring edit mode: - Hold `Shift` while hovering a widget that supports advanced view to expand it in place while the other widgets remain visible but dimmed. Release `Shift` to close it. Focus that widget and press `Shift` + `Enter` to keep the view open until you close it. On touch devices, open it from the widget menu. Other widgets adapt in place instead. -- Right-click a widget to inspect its live query status, refresh its data, change quick options, open settings, or run - supported actions. Available controls follow your board and integration permissions. -- If you can modify the board, right-click or touch and hold an empty grid cell to add an item there. Focus a board - section and press `Shift` + `F10` for the keyboard equivalent. +- When signed in, outside edit mode, and with **Enable right click on widgets** enabled, right-click a widget to inspect + its live query status, refresh its data, change quick options, open settings, or run supported actions. App tiles do + not use this widget menu, and available controls follow your board and integration permissions. -Widget and empty-space context menus follow the **Enable right click on widgets** preference in your user settings. +The widget context menu follows the **Enable right click on widgets** preference in your user settings. On touch devices, +use the widget menu where your browser exposes it. ### Access control @@ -332,7 +383,8 @@ Duplicating a board will not copy the users and groups that have access to the b nor the integrations the user does not have access to. ::: -Duplicating a board will create a new board with the same settings and layout as the original board. +Duplicating a board will create a new board with the same settings, all responsive layouts, and independent positions as the original board. +Duplicating a board that contains Custom Widgets also requires an administrator. You can duplicate a board by clicking on the three dots in the list of boards and selecting "Duplicate board". ![](./img/duplicate-board-modal.png) @@ -390,5 +442,13 @@ For the global home board you can only select boards that are public. ### Mobile home board -Same as the home board, you can also set a mobile home board. -It will be used for devices that are detected as mobile devices. (Using User-Agent header) +The mobile home board controls which board opens for devices that Homarr detects as mobile from the User-Agent header. +This is separate from a board's **Mobile layout**, which controls the layout selected inside that board. +You can set a mobile home board for yourself in your user preferences, for a user or group through management, or for the +whole server with **Global mobile board** under `Management` > `Settings` > `Boards`. + +For signed-in users, Homarr checks the user's mobile home board, then the user's desktop home board, then the mobile and +desktop defaults for the lowest-position matching group, followed by the mobile and desktop defaults for the `Everyone` +group, and finally the server-wide mobile and desktop defaults. Anonymous visitors use the server-wide mobile default and +then the server-wide desktop default. Server-wide fallback boards must be public. See the +[global board defaults](/docs/management/settings#boards) for the complete precedence and the required public-board rule. diff --git a/apps/docs/docs/management/custom-widgets/agent-authoring.mdx b/apps/docs/docs/management/custom-widgets/agent-authoring.mdx index 16ba34f9e..c59930f64 100644 --- a/apps/docs/docs/management/custom-widgets/agent-authoring.mdx +++ b/apps/docs/docs/management/custom-widgets/agent-authoring.mdx @@ -67,17 +67,23 @@ These interfaces do not return an archive URL or archive hash. 1. Load `customWidget_getSkill`, then get the prompt and live schema. 2. Call `customWidget_getComponentCatalog`, followed by `customWidget_getComponent` for only the relevant installed - components and `customWidget_getExample` when one catalog example matches the interaction pattern. If shared props - are needed, collect their catalog names and call `customWidget_getSharedProps` once for that set. + components and `customWidget_getExample` when one catalog example matches the interaction pattern. Fetch at most + eight component documents before the first validation (or four after a complete example already matches). If shared + props are needed, collect their catalog names and call `customWidget_getSharedProps` once for that set. 3. Read the external API documentation. 4. Build one definition, using `templateLines` for multiline JSX tool input. 5. Validate the definition without saving it and repair every reported issue. 6. Create a preview session. -7. Run `customWidget_previewQuery` for every query returned by the preview and inspect its actual status and data shape. +7. Run `customWidget_previewQuery` for every query returned by the preview and inspect its actual status and data shape. Use + `{}` for load queries; manual queries require exactly the returned primitive `parameterNames`. 8. Test relevant actions in simulation mode. 9. Open the returned preview path with browser tools. -10. Inspect the redacted journal and revise the local candidate until validation, data, and rendering all work. -11. Create the widget, including any source URLs and credentials the user already supplied. +10. Inspect the redacted journal and revise the local candidate until validation, data, and rendering all work. Keep the + exact tested preview candidate locally. Any definition, template, or source change requires a new validation and preview; + earlier query evidence belongs to the previous preview revision. +11. Create the widget from that final tested preview with `customWidget_createFromPreview`. The preview session already carries + the source URLs and encrypted credentials supplied during preview; the create call accepts only its session ID plus an + optional target board and persists that tested preview. 12. Open its returned management path, and use a structured question when the user must choose whether to place it on a board. 13. Otherwise, ask the user to configure the saved definition with the ten-minute Homarr source-setup URL. 14. Create a final preview with the saved definition ID so Homarr loads its stored credentials, then test it again. diff --git a/apps/docs/docs/management/custom-widgets/authoring.mdx b/apps/docs/docs/management/custom-widgets/authoring.mdx index aa2a18805..a2742a2e7 100644 --- a/apps/docs/docs/management/custom-widgets/authoring.mdx +++ b/apps/docs/docs/management/custom-widgets/authoring.mdx @@ -1,8 +1,37 @@ # Create a Custom Widget import { CanonicalCustomWidgetExample } from "@site/src/components/custom-widget-code"; +import workbenchImage from "./img/workbench.png"; +import workbenchMobileImage from "./img/workbench-mobile.png"; +import workbenchValidationImage from "./img/workbench-validation.png"; -The workbench is visual-first: configure the default API connection, add request cards, add option rows, then write JSX. Additional sources and raw manifest JSON remain under Advanced. Code and preview sit side by side on desktop and use tabs on mobile. +The workbench exposes **General**, **API sources**, **Requests**, **Options**, **JSX**, and **Preview** sections. Advanced JSON is +available in the manifest and request/option editors. Code and preview sit side by side on desktop; on smaller screens the +**Configure**/**Preview** switch shows one pane at a time and the section navigation scrolls horizontally. Preview sizes display +as **S/M/L** (Compact/Standard/Wide), and fixtures are **Live**, **Loading**, **Empty**, or **Error**. +For multiline JSX, prefer `templateLines` in agent or MCP input and keep the final tested preview as the source of truth before saving. + +Custom Widget workbench with configuration sections and a live preview + +Mobile Custom Widget workbench with Configure and Preview switch and horizontally scrollable section navigation + +The workbench keeps the configuration and preview together so you can inspect validation diagnostics, the redacted request +journal, fixture data, and preview size before saving. Invalid fields stay marked in the form while the preview explains why it +needs attention. + +Custom Widget workbench showing a Base URL validation error with Test, preview, and Create actions disabled ## Manual workflow @@ -21,7 +50,9 @@ The workbench is visual-first: configure the default API connection, add request -Every option has a default. Supported controls include text, textarea, number, switch, select, multi-select, slider, date, time, color, icon, URL, duration, time zone, and JSON. Dynamic choices use `choicesFrom` with a query ID and value/label paths. +Every option has a default. Supported controls include text, textarea, number, switch, select, multi-select, slider, date, time, color, icon, URL, duration, time zone, and JSON. Dynamic choices use `choicesFrom: { request, itemsPath?, valuePath, labelPath }`; the request must be a load query without invocation parameters, and you cannot provide both static `choices` and `choicesFrom`. + +Preview actions are simulated by default and recorded in the journal without contacting the service. Enable **Run actions against the configured API** only when you intend a real mutation; live actions still require configured confirmation. ## ChatGPT or Claude @@ -31,7 +62,8 @@ The model must return one fenced `json` block containing the complete widget, in field. Copy that single block and select **Paste**. Homarr fills the visual builders and the JSX editor without any placeholder replacement or second paste. -Homarr shows all actionable schema or JSX errors inline. Enter credentials separately. The prompt deliberately +Homarr shows all actionable schema or JSX errors inline. Enter credentials separately. The copied prompt does not include the +latest preview response; use **Preview** > **Data** to inspect it and mention important response fields in your request. The prompt deliberately recommends a focused Mantine component set, visual hierarchy, responsive layout, theme compatibility, and loading, empty, failure, and success states. diff --git a/apps/docs/docs/management/custom-widgets/custom-jsx.mdx b/apps/docs/docs/management/custom-widgets/custom-jsx.mdx index a8bb3bd85..b1f8e6aff 100644 --- a/apps/docs/docs/management/custom-widgets/custom-jsx.mdx +++ b/apps/docs/docs/management/custom-widgets/custom-jsx.mdx @@ -7,7 +7,21 @@ Templates are JSX expressions interpreted inside a widget-local safety and rende - `options.name` — saved widget configuration - `inputs.name` — temporary values from declarative `bind` +The v2 manifest requires a `default` source and supports up to eight sources, 64 requests, and 64 options. Source IDs are +case-insensitively unique. Each request allows up to 32 static headers and 32 invalidation targets; a widget can contain +up to 24 secrets, each up to 8,192 characters, and templates are limited to 50,000 characters. Validation reports the +exact field when a limit is exceeded. + +Authoring input accepts either `template` or `templateLines`, not both. `templateLines` accepts 1–2,000 lines, each up to +10,000 characters; after joining lines with newlines, the complete template must still fit the 50,000-character limit. + +The safe interpreter also bounds JSX evaluation: AST depth 64, 25,000 operations, 4,000 collection items, 10,000 rendered +nodes, and 200,000 characters in one string or rendered value. API responses are bounded separately before they reach the +template. + Use normal Mantine layouts, typography, feedback, dates, and charts. Official compound names such as `Card.Section`, `Tabs.List`, and `Radio.Group` are supported. Ordinary safe props pass through; a dangerous capability produces an explicit error. +Unsafe URLs, callback props, and unapproved style properties are stripped. Response data is deep-sanitized and budgeted +before it reaches `data`, so treat it as untrusted input even when the source is private. ## Temporary inputs @@ -15,7 +29,7 @@ Use normal Mantine layouts, typography, feedback, dates, and charts. Official co - {(results) => ( + {(results, meta) => ( {(results ?? []).map((item) => ( {item.name} @@ -32,14 +46,23 @@ Bound values live only in React memory while the widget is mounted. They are not Use expressions, conditionals, optional chaining, arrays, objects, template strings, safe standard helpers, and expression callbacks for `map`, `filter`, `sort`, and trusted runtime slots. Callback blocks, authored `const`, IIFEs, authored recursion, arbitrary functions, imports, hooks, refs, raw events, browser requests, `eval`, and bigint are blocked. -Bounded regex literals are supported for string matching, splitting, search, and replacement. Patterns with lookbehind, backreferences, nested quantifiers, excessive length, or unsupported flags are rejected. +Bounded regex literals are supported for string matching, splitting, search, and replacement. Regex literals are limited to +128 characters and flags `gimsu`; lookarounds, backreferences, repeated alternatives/groups, unsupported flags, and more +than one variable quantifier are rejected. ## Runtime components -- `SubFetch` runs a manual query with its `params`. Set `triggerContent` to a card or image to make that content the accessible click and keyboard trigger instead of showing the default load button. -- `ActionButton` and `ToggleSwitch` run actions. -- `RefreshButton` renders a compact, accessible icon control that refreshes load queries for authenticated viewers. It - is disabled for anonymous public-board viewers because refreshing invalidates shared server cache state. +- `SubFetch` runs a named query. Automatic queries run when the widget loads; set `trigger="manual"` to defer one and pass + primitive `params` for its invocation references. With `triggerContent`, any content node (commonly a card or image) becomes + the accessible click and keyboard trigger instead of showing the default load button. +- `SubFetch` with `trigger="manual"` keeps its result local to that instance; it does not populate the shared + `data.requestId` or `status.requestId` roots. The child callback receives `(result, meta)`, while loading, errors, and + retry are handled by `SubFetch`. Provide both `triggerContent` and `triggerAriaLabel` when custom content launches it. +- `ActionButton` and `ToggleSwitch` run actions only when the widget is mounted outside edit mode. A toggle needs both + enabled and disabled request parameters and rolls back its visual state if the action fails. +- `RefreshButton` renders a compact, accessible icon control that invalidates the client's load-query cache so active load + queries can refetch; it does not execute a request itself. It is disabled when the widget has no active item or preview + session, or while the board is in edit mode. - `Icon`/`TablerIcon` resolves installed safe icons. Always include responsive loading, empty, error, and success states. Runtime failures remain inside the widget tile. diff --git a/apps/docs/docs/management/custom-widgets/img/workbench-mobile.png b/apps/docs/docs/management/custom-widgets/img/workbench-mobile.png new file mode 100644 index 000000000..c23f6369a Binary files /dev/null and b/apps/docs/docs/management/custom-widgets/img/workbench-mobile.png differ diff --git a/apps/docs/docs/management/custom-widgets/img/workbench-validation.png b/apps/docs/docs/management/custom-widgets/img/workbench-validation.png new file mode 100644 index 000000000..e4ec4cc31 Binary files /dev/null and b/apps/docs/docs/management/custom-widgets/img/workbench-validation.png differ diff --git a/apps/docs/docs/management/custom-widgets/img/workbench.png b/apps/docs/docs/management/custom-widgets/img/workbench.png new file mode 100644 index 000000000..13f111dca Binary files /dev/null and b/apps/docs/docs/management/custom-widgets/img/workbench.png differ diff --git a/apps/docs/docs/management/custom-widgets/index.mdx b/apps/docs/docs/management/custom-widgets/index.mdx index e21af4a87..29083ce19 100644 --- a/apps/docs/docs/management/custom-widgets/index.mdx +++ b/apps/docs/docs/management/custom-widgets/index.mdx @@ -42,9 +42,14 @@ interface HomarrCustomWidgetV2 { ### Design with AI -The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and, when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The assistant receives the widget schema, current non-secret configuration, and latest test response, then proposes the matching create or update tool for your approval. +The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and, +when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The generated prompt includes the +widget schema and current non-secret configuration, but not the latest preview response. It proposes the matching create or +update tool for your approval. -Run **Test** first when possible so the prompt includes the endpoint's real response shape. Saved secrets are never added to the prompt. **Copy to clipboard** remains available when the Assistant is disabled or when you prefer another AI service. +Use the preview's **Data** tab to inspect the endpoint's real response shape and mention important fields in your request; the +copied prompt does not automatically include the latest preview response. Saved secrets are never added to the prompt. **Copy to +clipboard** remains available when the Assistant is disabled or when you prefer another AI service. diff --git a/apps/docs/docs/management/custom-widgets/requests-and-security.mdx b/apps/docs/docs/management/custom-widgets/requests-and-security.mdx index 1cae3ced1..f06362c8e 100644 --- a/apps/docs/docs/management/custom-widgets/requests-and-security.mdx +++ b/apps/docs/docs/management/custom-widgets/requests-and-security.mdx @@ -1,6 +1,11 @@ # Configure requests and security -Most widgets use a single source named `default`. Extra keyed sources are available under Advanced for widgets that combine APIs. Authentication is `none`, `bearer`, `basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest. +Most widgets use a single source named `default`; the manifest must contain it. Extra keyed sources are available for widgets +that combine APIs. Source IDs are case-insensitively unique. Base URLs must use HTTP(S), contain no embedded credentials, +query string, or fragment, and sources can be `public`, `private`, or `loopback`. Authentication is `none`, `bearer`, +`basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest. +Source origins are fixed by the definition and source-setup flow; widget options and invocation parameters cannot redirect a +request to a different origin. ## Named requests @@ -35,19 +40,28 @@ Bind values directly where they are used: `{option:name}` and `$option` read saved widget options. `{param:name}` and `$param` read invocation-time `params`. Load queries cannot use invocation parameters. Homarr infers the exact parameter names and primitive values from these references, rejecting missing or extra invocation params at the request boundary. -Paths and query-string values must resolve to text, numbers, or booleans. JSON bodies can also use structured `json` and `multiSelect` option values, for example `{ "entity_ids": { "$option": "entities" } }`. +Path placeholders and query values must resolve to text, numbers, or booleans. `$option` and `$param` references may appear +recursively in JSON bodies; invocation parameters remain primitive, and load queries cannot use `$param`. JSON bodies can +also use structured `json` and `multiSelect` option values, for example `{ "entity_ids": { "$option": "entities" } }`. ## Protection Every request uses Homarr's existing server executor: same-origin source enforcement, network scope, DNS and redirect validation, SSRF protection, board permissions, rate and request limits, body and response limits, timeouts, and encrypted credential injection. Static headers cannot override credentials, cookies, routing, proxy, forwarding, or hop-by-hop headers. +The executor caps request bodies at 10 KiB and response bodies at 1 MiB. Parsed JSON is limited to depth 32 and 50,000 nodes; +each network hop has a ten-second timeout, queries follow at most three same-origin redirects, actions do not follow redirects, +and the total request deadline is 45 seconds. + +The limiter allows four concurrent requests per user/item and eight per definition. Per minute, a user/item can make up to 60 +queries, 10 actions, or 3 DELETE actions; a definition can receive up to 240, 40, or 12 of those request categories. + Queries default to view permission and actions to modify. DELETE always requires full permission and confirmation. Actions are never cached, retried, or run on load. Management and runtime are intentionally separate. A Homarr administrator with board-modify permission places and configures the widget. After placement, query and action authorization follows the request's board permission. Public boards may execute queries for anonymous viewers, but mutations stay authenticated. This includes shared-cache -invalidation: `RefreshButton` is disabled for anonymous viewers, while ordinary scheduled query rendering remains -available. +invalidation: `RefreshButton` is disabled only without an active item or preview session, or in edit mode, while ordinary +scheduled query rendering remains available to anonymous viewers. Responses use bounded, versioned shared-Redis cache keys. Action invalidation advances the shared version so every Homarr replica stops serving the previous response without scanning or deleting a key prefix. diff --git a/apps/docs/docs/management/custom-widgets/troubleshooting.mdx b/apps/docs/docs/management/custom-widgets/troubleshooting.mdx index 068d8a21e..82045509c 100644 --- a/apps/docs/docs/management/custom-widgets/troubleshooting.mdx +++ b/apps/docs/docs/management/custom-widgets/troubleshooting.mdx @@ -41,7 +41,8 @@ The workbench marks the invalid field while you type. An invalid URL does not re An invalid definition disables widget preview and Save/Create. The Data, Options, Actions, and Diagnostics tabs remain available so you can correct it. -The Diagnostics tab shows the current schema errors. +The Diagnostics tab shows current schema and JSX errors, accessibility checks, and (after a preview) the redacted request +journal. It does not expose credentials or raw secret values. ## Workshop unavailable diff --git a/apps/docs/docs/management/img/assistant-config.png b/apps/docs/docs/management/img/assistant-config.png new file mode 100644 index 000000000..181d297b0 Binary files /dev/null and b/apps/docs/docs/management/img/assistant-config.png differ diff --git a/apps/docs/docs/management/img/assistant-widget.png b/apps/docs/docs/management/img/assistant-widget.png new file mode 100644 index 000000000..960d9ab40 Binary files /dev/null and b/apps/docs/docs/management/img/assistant-widget.png differ diff --git a/apps/docs/docs/management/mcp.mdx b/apps/docs/docs/management/mcp.mdx index 9cbbf5848..c0ed2e7b1 100644 --- a/apps/docs/docs/management/mcp.mdx +++ b/apps/docs/docs/management/mcp.mdx @@ -23,9 +23,9 @@ approval before running mutating procedures. ## Getting Started -The MCP endpoint lives under the **API** page at `Management` → `Tools` → `API` → **MCP** tab. +The MCP endpoint lives under the **API** page at `Management` → `Tools` → `API` → **AI / MCP** tab. -![MCP Instructions Page](./api/img/mcp-instructions.png) +![AI / MCP tab showing the endpoint, API-key warning, and client configuration](./api/img/mcp-instructions.png) ### 1. Create an API Key diff --git a/apps/docs/docs/widgets/app/index.mdx b/apps/docs/docs/widgets/app/index.mdx index dd5cef590..9321c968c 100644 --- a/apps/docs/docs/widgets/app/index.mdx +++ b/apps/docs/docs/widgets/app/index.mdx @@ -28,7 +28,8 @@ import piHoleApp from "./img/pi-hole-ping-icon.png"; ### Interactions -App tiles stay compact and open their configured destination directly. Right-click a tile to inspect its status or change its settings when the board and your preferences allow it. +App tiles stay compact and open their configured destination directly. They do not use the shared widget context menu; +configure the app and its status check from the tile's edit actions. ### Adding the widget diff --git a/apps/docs/docs/widgets/assistant/index.mdx b/apps/docs/docs/widgets/assistant/index.mdx index 9454c6e1f..0c03aecc6 100644 --- a/apps/docs/docs/widgets/assistant/index.mdx +++ b/apps/docs/docs/widgets/assistant/index.mdx @@ -7,6 +7,7 @@ hide_title: true import { AddingWidget } from "@site/src/components/widgets/adding"; import { WidgetHeader } from "@site/src/components/widgets/header"; import { assistantWidget } from "."; +import assistantWidgetImage from "../../management/img/assistant-widget.png"; @@ -15,7 +16,18 @@ board. Messages, conversations, tool calls, approvals, files, mentions, model co usage details, and response actions remain synchronized with the app-wide assistant. The assistant must be enabled by an administrator in **Management → Assistant**. Signed-out users and users -on an instance without an enabled model see an unavailable state instead of a broken composer. +on an instance without an enabled model see an unavailable state instead of a broken composer. Signed-out users see +**Sign in**; a configured provider without a saved model or with **Enable Assistant** off remains unavailable until +the administrator saves a working connection, selects a model, and enables the assistant. + +Assistant widget embedded on a dashboard with its conversation header, automatic approvals control, model selector, and composer + +The current preview capture labels the board-embedded surface: its header exposes conversation history, refresh, +automatic approvals, and new-conversation controls, while the footer exposes the model, thinking mode, and composer. ### Adding the widget @@ -42,10 +54,16 @@ keeps every assistant entry point synchronized without storing a user's private - Edit user messages and copy, regenerate, branch, quote, export, or rate responses. - Inspect syntax-highlighted Markdown, sources, generated files, tool results, streaming chain-of-thought, cumulative conversation usage, per-turn token and context use, timing, speed, provider routing, and cost. -- Change the model and reasoning effort for the active conversation. +- Change the model and reasoning effort for the active conversation. A model choice is saved per persisted thread, + does not change the administrator's default, and is restored when that thread is selected again; a new thread + starts from the configured default. - Refresh the current board from the conversation header. Approved mutations also refresh visible board data automatically. The expanded assistant and board widget use the same persisted thread runtime. A response continues in the background when the widget leaves the viewport or the expanded panel is minimized. Each visible surface keeps an independent draft, attachments, selection, and focus, so typing in a board widget cannot move or overwrite the floating panel composer. + +Automatic approvals are off by default, reset when switching conversations, and never select a neutral choice. A +structured question shows **Other** only when the tool allows it (`allowOther` is not `false`); selecting **Other** +opens a manual freeform response even when automatic approvals are enabled. diff --git a/apps/docs/docs/widgets/beszel-system-grid/index.mdx b/apps/docs/docs/widgets/beszel-system-grid/index.mdx index 70c477593..eb42c4800 100644 --- a/apps/docs/docs/widgets/beszel-system-grid/index.mdx +++ b/apps/docs/docs/widgets/beszel-system-grid/index.mdx @@ -10,6 +10,7 @@ import { WidgetHeader } from "@site/src/components/widgets/header"; import { AddingWidget } from "@site/src/components/widgets/adding"; import { WidgetConfig } from "@site/src/components/widgets/configuration"; import { WidgetIntegrations } from "@site/src/components/widgets/integrations"; +import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions"; import { beszelSystemGridWidget } from "."; import { beszelIntegration } from "@site/docs/integrations/beszel"; diff --git a/apps/docs/docs/widgets/beszel-system-stats/index.mdx b/apps/docs/docs/widgets/beszel-system-stats/index.mdx index cc44ffc9f..cf0c18fa6 100644 --- a/apps/docs/docs/widgets/beszel-system-stats/index.mdx +++ b/apps/docs/docs/widgets/beszel-system-stats/index.mdx @@ -17,7 +17,7 @@ import beszelSystemStats from "./img/beszel-system-stats.png"; -This widget displays time-series charts for a selected Beszel system, including CPU, memory, disk, network, and Docker container metrics. The Disk Usage chart combines the root disk and every extra filesystem reported by Beszel. Hover over or focus the widget controls to switch between the realtime Live view and historical periods ranging from 1 hour to 30 days. Live view keeps a one-minute window and pauses while the browser tab is hidden. If the live stream drops, the widget now shows the connection failure state immediately and can switch back to historical data. +This widget displays time-series charts for a selected Beszel system, including CPU, memory, disk, network, and Docker container metrics. The Disk Usage chart combines the root disk and every extra filesystem reported by Beszel. Use the widget controls to switch between the realtime Live view and historical periods ranging from 1 hour to 30 days. Live view keeps a one-minute window and pauses while the browser tab is hidden. If the live stream drops, the widget now shows the connection failure state immediately and can switch back to historical data. ### Screenshots diff --git a/apps/docs/docs/widgets/beszel-system-table/index.mdx b/apps/docs/docs/widgets/beszel-system-table/index.mdx index e1bbd8c93..8636b3945 100644 --- a/apps/docs/docs/widgets/beszel-system-table/index.mdx +++ b/apps/docs/docs/widgets/beszel-system-table/index.mdx @@ -10,6 +10,7 @@ import { WidgetHeader } from "@site/src/components/widgets/header"; import { AddingWidget } from "@site/src/components/widgets/adding"; import { WidgetConfig } from "@site/src/components/widgets/configuration"; import { WidgetIntegrations } from "@site/src/components/widgets/integrations"; +import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions"; import { beszelSystemTableWidget } from "."; import { beszelIntegration } from "@site/docs/integrations/beszel"; diff --git a/apps/docs/docs/widgets/calendar/img/advanced-view.png b/apps/docs/docs/widgets/calendar/img/advanced-view.png new file mode 100644 index 000000000..a17186774 Binary files /dev/null and b/apps/docs/docs/widgets/calendar/img/advanced-view.png differ diff --git a/apps/docs/docs/widgets/calendar/img/current-view.png b/apps/docs/docs/widgets/calendar/img/current-view.png new file mode 100644 index 000000000..0441e45e1 Binary files /dev/null and b/apps/docs/docs/widgets/calendar/img/current-view.png differ diff --git a/apps/docs/docs/widgets/calendar/index.mdx b/apps/docs/docs/widgets/calendar/index.mdx index ca6832598..57ca565fe 100644 --- a/apps/docs/docs/widgets/calendar/index.mdx +++ b/apps/docs/docs/widgets/calendar/index.mdx @@ -31,16 +31,12 @@ the same data is requested through Homarr's MCP or Assistant tools. ### Screenshots -import popover from "./img/popover.png"; -import withIntegrations from "./img/with-integrations.png"; -import withoutIntegrations from "./img/without-integrations.png"; +import currentView from "./img/current-view.png"; +import advancedView from "./img/advanced-view.png"; -
- calendar with-integrations big-size -
- calendar popover-details the-mandalorian - calendar without-integrations small-size -
+
+ Calendar month view with marked events + Calendar advanced view with grouped events
### Supported Integrations diff --git a/apps/docs/docs/widgets/custom-api/index.mdx b/apps/docs/docs/widgets/custom-api/index.mdx index 908625499..d7eb59617 100644 --- a/apps/docs/docs/widgets/custom-api/index.mdx +++ b/apps/docs/docs/widgets/custom-api/index.mdx @@ -32,7 +32,8 @@ Credentials remain on the server. :::note Custom API widgets must first be created in **Management → Custom Widgets** before they appear in the widget picker. -Action buttons can only be executed by administrators. +Action buttons require the request's minimum board permission, which is `modify` by default. Anonymous viewers cannot run +mutations. DELETE additionally requires full permission and confirmation. ::: ### Permissions and actions diff --git a/apps/docs/docs/widgets/dns-hole-controls/index.mdx b/apps/docs/docs/widgets/dns-hole-controls/index.mdx index e97407da7..387431190 100644 --- a/apps/docs/docs/widgets/dns-hole-controls/index.mdx +++ b/apps/docs/docs/widgets/dns-hole-controls/index.mdx @@ -22,7 +22,7 @@ import { technitiumDnsIntegration } from "@site/docs/integrations/technitium-dns When several DNS integrations are selected, Homarr keeps healthy controls available if one source fails and shows a warning identifying the unavailable integration. -This widget lets permitted users enable, disable, or temporarily pause one or more DNS services. It shares the summary query and cache with DNS Hole Summary. Every selected source stays available in the normal scrollable view, while cards and controls adapt to the widget's width and height. +This widget lets permitted users enable, disable, or temporarily pause one or more DNS services. It shares the summary query and cache with DNS Hole Summary. Every selected source stays available in the normal scrollable view, while cards and controls adapt to the widget's width and height. Bulk actions keep successful results visible and report the number of failures. ### Screenshots diff --git a/apps/docs/docs/widgets/docker-containers/img/table.png b/apps/docs/docs/widgets/docker-containers/img/table.png index ff5aa337a..43ad6a279 100644 Binary files a/apps/docs/docs/widgets/docker-containers/img/table.png and b/apps/docs/docs/widgets/docker-containers/img/table.png differ diff --git a/apps/docs/docs/widgets/docker-containers/index.mdx b/apps/docs/docs/widgets/docker-containers/index.mdx index 1959ca959..bd0e2ee19 100644 --- a/apps/docs/docs/widgets/docker-containers/index.mdx +++ b/apps/docs/docs/widgets/docker-containers/index.mdx @@ -8,6 +8,7 @@ import { WidgetHeader } from "@site/src/components/widgets/header"; import { AddingWidget } from "@site/src/components/widgets/adding"; import { WidgetConfig } from "@site/src/components/widgets/configuration"; import { WidgetIntegrations } from "@site/src/components/widgets/integrations"; +import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions"; import { IconAd } from "@tabler/icons-react"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -49,6 +50,8 @@ Each container row has an action menu, accessible via the three-dot icon or by r - **Remove** - permanently remove the container after a second confirmation click - **Add to Homarr** - create a bookmark app from the container + + ### Adding the widget diff --git a/apps/docs/docs/widgets/downloads/img/advanced-view.png b/apps/docs/docs/widgets/downloads/img/advanced-view.png new file mode 100644 index 000000000..042e713c3 Binary files /dev/null and b/apps/docs/docs/widgets/downloads/img/advanced-view.png differ diff --git a/apps/docs/docs/widgets/downloads/img/filter-panel.png b/apps/docs/docs/widgets/downloads/img/filter-panel.png new file mode 100644 index 000000000..e819e80f9 Binary files /dev/null and b/apps/docs/docs/widgets/downloads/img/filter-panel.png differ diff --git a/apps/docs/docs/widgets/downloads/index.mdx b/apps/docs/docs/widgets/downloads/index.mdx index 425efb0a7..85bace5e3 100644 --- a/apps/docs/docs/widgets/downloads/index.mdx +++ b/apps/docs/docs/widgets/downloads/index.mdx @@ -21,36 +21,79 @@ import { downloadsWidget } from "."; -This widget displays a list of torrents or usenet-articles that are currently being downloaded, along with their progress and other relevant information. It supports 7 download client integrations and provides a rich, responsive table interface. +This widget displays torrent, Usenet, and miscellaneous download jobs, along with their progress and other relevant information. It supports 7 download client integrations and provides a rich, responsive table interface. ### Screenshots import downloadsCard from "./img/screenshot.png"; import contextMenuImg from "./img/context-menu.png"; +import advancedViewImg from "./img/advanced-view.png"; +import filterPanelImg from "./img/filter-panel.png";
Downloads widget showing torrent and usenet items
-#### Right-click context menu +#### Download-row context menu
- Downloads widget context menu with pause, delete, and copy actions + Downloads row context menu with pause, delete, and copy actions +
+ +#### Advanced view + +
+ Downloads widget in advanced view with stats, sortable columns, and expanded details +
+ +#### Advanced filter panel + +
+ Downloads advanced view with the status filter panel open
### Features -- **Responsive table** — columns automatically adapt to widget width, hiding less important columns at smaller sizes -- **Sortable columns** — click any column header to sort ascending/descending +- **Responsive compact table** — in compact mode, selected columns adapt to both widget width and height; narrow or short tiles hide speed/state columns, and the shortest tiles also hide the ETA column +- **Sortable columns** — click any sortable column header to sort the current view; the configured default controls the initial column and direction - **Column customization** — choose which columns to display, then hover a header to reveal its grab handle for reordering or drag its edge to resize it; layouts save automatically per widget -- **Right-click context menu** — copy download names, or pause, resume, and delete when your account has Interact access and the client supports those actions +- **Download-row context menu** — copy a download name or ID from any row; pause, resume, and delete actions appear when you have Interact access to that integration - **Row expansion** — click any row to see full details inline without opening a separate modal - **Hover tooltips** — hover a download name to see size, speeds, ETA, ratio, and category; open tooltips close when switching between compact and advanced mode -- **Global stats bar** — toggle a summary bar showing queue progress, total size, speeds, ratio, and per-state counts +- **Global stats bar** — show queue progress, downloaded/total size, transfer speeds, global torrent ratio, and per-state counts in compact mode; advanced view always includes it - **Client filtering** — filter downloads by integration or status using the footer filter panel -- **Global controls** — pause/resume downloads from supported clients when your account has Interact access; read-only clients such as slskd do not expose these controls +- **Global controls** — pause/resume actionable queues from the footer bar, limited to selected integrations where you have Interact access - **Status indicators** — color-coded badges show download state at a glance -- **Speed overview** — total download and upload speeds displayed in the footer +- **Speed overview** — total download and upload speeds for the selected clients are displayed in the footer + +:::note + +Compact layouts use both dimensions: below 500px wide, speed columns are hidden; below 300px wide, the ETA and state +columns are hidden too. A tile shorter than 180px hides speed and state columns, and a tile shorter than 120px also +hides ETA. The footer is hidden below 96px in compact mode. Advanced view bypasses these compact size reductions, +keeps the selected column set, and always includes the stats bar and footer controls, with the filter panel available +from the footer. + +The filter panel changes the visible rows. Its client/status filters also change the stats bar's progress, size, and +state counts, while transfer-speed totals summarize the selected clients and the global torrent ratio summarizes the +selected torrent clients. The configured category/label filter can optionally be applied to the global torrent ratio +through **Use category filter for global torrent ratio**; footer client/status filters do not change that ratio. + +The per-item **Ratio** is sent bytes divided by the item's total size. **Global Ratio** is total uploaded bytes divided +by total downloaded bytes. + +Mutation controls depend on the integration's Interact permission. Users without that permission can still view rows and +use the row menu's copy actions. `slskd` is list-only: its pause, resume, and delete operations are no-ops, so those +controls have no effect for that client even when Interact permission exposes them. + +The screenshot above is a Downloads row menu, separate from the shared widget context menu. When board right-click menus +are enabled, the shared menu provides widget-level actions such as advanced view, widget options, refresh, and settings. + +::: ### Supported Integrations @@ -82,20 +125,20 @@ import contextMenuImg from "./img/context-menu.png"; }, { integration: slskdIntegration, - note: "Soulseek client (read-only)", + note: "Soulseek client (list-only; mutation controls are no-ops)", }, ]} /> ### Interactions -- **Right-click** any download to copy its name; pause/resume and delete require Interact access and client support +- **Right-click** any download to copy its name or ID; pause, resume, and delete are available only with Interact access - **Click** any row to expand it and see full download details inline - **Hover** a download name for a quick stats tooltip -- **Stats toggle** — show or hide the global stats bar from the footer -- **Pause / Resume** downloads from supported clients using the footer controls when you have Interact access; slskd remains read-only -- **Filter** by integration or status using the filter button in the footer -- **Sort** the current view by clicking column headers to switch direction +- **Stats toggle** — show or hide the global stats bar in compact mode; advanced view always shows the stats bar +- **Pause / Resume** actionable queues using the footer controls +- **Filter** rows by integration or status using the filter button in the footer +- **Sort** by clicking sortable column headers; the default sort is configured per widget, while header changes apply to the current view diff --git a/apps/docs/docs/widgets/downloads/index.ts b/apps/docs/docs/widgets/downloads/index.ts index fba87aad1..f4e1945b1 100644 --- a/apps/docs/docs/widgets/downloads/index.ts +++ b/apps/docs/docs/widgets/downloads/index.ts @@ -30,19 +30,20 @@ export const downloadsWidget: WidgetDefinition = { { name: "Columns to show", description: - "Select the columns you want to display in the widget. Columns automatically hide/show based on widget width.", + "Select the columns you want to display in the widget. Compact layouts automatically hide/show selected columns based on widget width and height; advanced view keeps the selected columns visible.", values: `List of columns: ${columnsList.join(", ")}`, defaultValue: ["name", "progress", "downSpeed", "time", "state"].join(", "), }, { name: "Default sort column", - description: "The column used for initial sorting when the widget loads.", + description: + "The column used for initial sorting when the widget loads. Clicking a column header changes the current view only.", defaultValue: "progress", values: `List of columns: ${sortColumns.join(", ")}`, }, { name: "Invert sorting", - description: "This will invert the default sorting order.", + description: "This sets the initial sorting direction.", values: { type: "boolean" }, defaultValue: "no", }, @@ -66,8 +67,7 @@ export const downloadsWidget: WidgetDefinition = { }, { name: "Hide completed torrent under this threshold (in kiB/s)", - description: - "This will hide completed torrent entries that have an upload speed below the specified threshold.", + description: "This will hide completed torrent entries whose upload speed is below the specified threshold.", values: "Any number above 0, 0 to disable", defaultValue: "0", }, @@ -85,15 +85,16 @@ export const downloadsWidget: WidgetDefinition = { defaultValue: "no", }, { - name: "Use filter to calculate Ratio", - description: "This will use the category filter when calculating the global torrent ratio.", + name: "Use category filter for global torrent ratio", + description: + "When enabled, the configured category/label filter is applied to the global torrent ratio. Footer client/status filters do not change this ratio.", values: { type: "boolean" }, defaultValue: "yes", }, { name: "Limit items per integration", description: "This will limit the number of items shown per integration, not globally.", - values: "Any number above 1", + values: "Any whole number from 1 upward", defaultValue: "50", }, ], diff --git a/apps/docs/docs/widgets/media-server/img/advanced-view.png b/apps/docs/docs/widgets/media-server/img/advanced-view.png new file mode 100644 index 000000000..75a49a3a2 Binary files /dev/null and b/apps/docs/docs/widgets/media-server/img/advanced-view.png differ diff --git a/apps/docs/docs/widgets/media-server/img/table.png b/apps/docs/docs/widgets/media-server/img/table.png index d8153d22f..9100a7a8c 100644 Binary files a/apps/docs/docs/widgets/media-server/img/table.png and b/apps/docs/docs/widgets/media-server/img/table.png differ diff --git a/apps/docs/docs/widgets/media-server/index.mdx b/apps/docs/docs/widgets/media-server/index.mdx index a8a9a517e..0c4dc18d0 100644 --- a/apps/docs/docs/widgets/media-server/index.mdx +++ b/apps/docs/docs/widgets/media-server/index.mdx @@ -31,8 +31,12 @@ Sessions without user metadata remain visible and are labeled as an unknown user ### Screenshots import mediaTable from "./img/table.png"; +import mediaAdvancedView from "./img/advanced-view.png"; -media-server-streams +
+ Media server compact streams table + Media server advanced view with stream summary +
### Supported Integrations diff --git a/apps/docs/docs/widgets/weather/img/advanced-view.png b/apps/docs/docs/widgets/weather/img/advanced-view.png new file mode 100644 index 000000000..96e37daf4 Binary files /dev/null and b/apps/docs/docs/widgets/weather/img/advanced-view.png differ diff --git a/apps/docs/docs/widgets/weather/index.mdx b/apps/docs/docs/widgets/weather/index.mdx index f36dc68ea..f64f5d754 100644 --- a/apps/docs/docs/widgets/weather/index.mdx +++ b/apps/docs/docs/widgets/weather/index.mdx @@ -15,17 +15,20 @@ import { weatherWidget } from "."; The Weather Widget uses your location to display the current, highest and lowest temperature. In the compact view, select a condition icon or forecast day to open details with a mouse, keyboard or touch. -The advanced view always combines current conditions with the full seven-day forecast, including humidity, wind, -gusts, sunrise and sunset. Both views reuse the same cached Open Meteo response. +The compact forecast shows up to the configured number of days. The advanced view combines current conditions with the +available daily forecast, including humidity, wind, gusts, sunrise and sunset. Both views reuse the same cached Open +Meteo response. ### Screenshots import forecastWeather from "./img/forecast.png"; import currentWeather from "./img/current.png"; +import advancedWeather from "./img/advanced-view.png";
- weather forecast-5-days - weather current + Weather compact forecast + Weather compact current conditions + Weather advanced view with seven-day forecast details
diff --git a/apps/docs/src/components/widgets/interactions.tsx b/apps/docs/src/components/widgets/interactions.tsx index c75102f92..14fdbf0ee 100644 --- a/apps/docs/src/components/widgets/interactions.tsx +++ b/apps/docs/src/components/widgets/interactions.tsx @@ -1,10 +1,10 @@ -import { IconArrowsMaximize, IconLayoutGrid, IconMouse2, IconPlus } from "@tabler/icons-react"; +import { IconArrowsMaximize, IconLayoutGrid, IconMouse2, IconRefresh } from "@tabler/icons-react"; const advancedInteraction = { icon: IconArrowsMaximize, title: "Advanced view", description: - "Hold Shift while hovering for an in-place preview, press Shift + Enter, or choose Open advanced view from the widget menu.", + "Supported widgets explicitly opt into advanced view. Focus a widget and press Shift + Enter, hold Shift while hovering for about 500 ms, or choose Open advanced view from its menu. It is unavailable in edit mode and remains compact-only on widgets that do not opt in.", } as const; const standardInteractions = [ @@ -12,19 +12,19 @@ const standardInteractions = [ icon: IconMouse2, title: "Widget actions", description: - "Right-click for live query status, refresh, settings, quick options, and actions supported by the widget.", - }, - { - icon: IconPlus, - title: "Place it precisely", - description: - "With board changes allowed, right-click or touch and hold empty grid space to add there. Keyboard users can press Shift + F10.", + "Signed-in users can open the widget context menu outside edit mode when Enable right click on widgets is enabled. App tiles are excluded. Settings, quick options, and integration actions appear or enable only when the widget and your board or integration permissions allow them.", }, { icon: IconLayoutGrid, title: "Adaptive detail", description: - "Resize a widget to tune its density. Compact views keep primary status visible, then reveal details and controls as space or intent allows.", + "Resize a widget to tune its density. Compact layouts hide lower-priority details and controls as space shrinks; compact-only widgets adapt in place instead of opening a separate advanced view.", + }, + { + icon: IconRefresh, + title: "Data status", + description: + "Widgets distinguish initial loading, successful empty results, terminal errors, stale cached data, and partial integration failures as applicable. Initial loads use a loading state, empty results use an empty state, and terminal failures can offer retry; retained data can stay visible with a stale warning, while healthy integrations can remain visible when another source fails. The shared menu reports Loading while matching active queries fetch, Idle when none are active, Error when any match is in error, otherwise Success with the latest data age when available. Refresh refetches only active queries owned by that widget and view and is disabled while they fetch.", }, ] as const; @@ -35,14 +35,12 @@ export const WidgetInteractionGuide = ({ advancedView = true }: { advancedView?:
Power-user controls - Show shortcuts + Show controls - Hide shortcuts + Hide controls -
+
{interactions.map(({ icon: Icon, title, description }) => (
@@ -53,8 +51,13 @@ export const WidgetInteractionGuide = ({ advancedView = true }: { advancedView?:
{advancedView && (

- Advanced view reuses the widget's live data and cache. The rest of the board stays visible but dimmed. On - touch devices, use the widget menu; compact-only widgets adapt in place instead. + Advanced view reuses existing data where possible; some widgets request additional or denser data. Hold Shift + while hovering a supported widget for a temporary preview; it opens after about 500 ms and closes when Shift + is released, the pointer leaves, or the window loses focus. For a persistent view, focus the widget and press + Shift + Enter or use Open advanced view from its menu. Manual view closes with Escape after nested menus or + popovers handle their own Escape, its close button, or the backdrop; it restores focus, traps focus, and locks + background scrolling. Shift + wheel scrolls a scrollable advanced panel when it can consume the event. On + touch devices, use the widget menu when available; compact-only widgets adapt in place instead.

)}