feat: rebuild board grid with dnd-kit
This commit is contained in:
118 files changed
+6772
-4339
No files matched your search
@@ -321,39 +321,34 @@ As with every change, don't forget to save your changes using the exit edit mode
|
||||
|
||||

|
||||
|
||||
## Organizing items with sections
|
||||
## Organizing items with Containers
|
||||
|
||||
Sections are resizable containers for apps, widgets, and other sections.
|
||||
The same section works on the main canvas and inside a fixed sidebar.
|
||||
Each section can configure:
|
||||
Containers are resizable areas for apps, widgets, and nested Containers.
|
||||
The same Container works on the main canvas, inside a fixed rail, or inside another Container.
|
||||
Each Container can configure:
|
||||
|
||||
- Show or hide its label.
|
||||
- Its label and whether that label is visible.
|
||||
- Allow or disable collapsing.
|
||||
- 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**.
|
||||
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.
|
||||
|
||||
After adding a section, drag and resize it like any other tile, then drag items into it:
|
||||
### Collapsing and opening apps
|
||||
|
||||

|
||||
Users can collapse an eligible Container like an accordion in view mode without changing its saved expanded size.
|
||||
Expanding it restores its bounds and makes room for its contents.
|
||||
If **Open all in new tabs** is enabled, the Container menu can open every app link it contains.
|
||||
|
||||
### Labeled and collapsible sections
|
||||
### Fixed rails
|
||||
|
||||
Open the add-content menu and choose **New section**.
|
||||
Use its settings menu to add a label and enable the behavior you want.
|
||||
In edit mode, move items into or out of the section directly.
|
||||
In view mode, each user can collapse eligible sections without changing the saved board layout.
|
||||
If **Open all in new tabs** is enabled, the section menu can open every app link it contains.
|
||||
|
||||
### Fixed sidebars
|
||||
|
||||
Open the board's **Layout** settings to enable the left or right sidebar for each responsive layout.
|
||||
Open the board's **Layout** settings to enable the left or right rail for each responsive layout.
|
||||
Choose one, two, or three columns with the slider and use the preview to check the remaining canvas width.
|
||||
The sidebar reserves those columns from the dashboard, so Homarr moves canvas items into the next available positions.
|
||||
Sidebar content stays visible while the page scrolls and remains editable.
|
||||
|
||||
Existing categories become sections automatically, and category rails become fixed sidebars.
|
||||
The rail reserves those columns from the dashboard, so Homarr moves canvas items into the next available positions.
|
||||
Rail content stays visible while the page scrolls and remains editable.
|
||||
Each responsive layout keeps its own rail widths, item positions, and item sizes.
|
||||
|
||||
## Guided tours
|
||||
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
# Glossary
|
||||
|
||||
In the glossary, you'll learn the different components and their names of Homarr.
|
||||
|
||||
| Term | Definition |
|
||||
|-----------------|----------------------------------------------------------------------------------------------------------------|
|
||||
| Apps | An piece of software that you or a third party hosts (eg. Google) |
|
||||
| Integration | A connection to a service outside of Homarr |
|
||||
| Dynamic section | Resizeable area where items on your board can be placed and grouped |
|
||||
| Widget | A tile that uses your integrations to display data or enables you to interact with with them |
|
||||
| Edit mode | Temporary state that you can enter where you can drag and drop, edit or customize your board |
|
||||
| Board | Customizable page which can be edited using the edit mode. This is where apps, sections and widgets are placed |
|
||||
| Tasks | Workloads that are performed in the background - even if there is no user present |
|
||||
| Term | Definition |
|
||||
| ----------- | --------------------------------------------------------------------------------------- |
|
||||
| Apps | A piece of software that you or a third party hosts (for example, Google) |
|
||||
| Integration | A connection to a service outside of Homarr |
|
||||
| Container | A resizable area that can hold apps, widgets, and nested Containers |
|
||||
| Widget | A tile that uses your integrations to display data or enables you to interact with them |
|
||||
| Edit mode | A temporary state where you can drag, resize, edit, or customize your board |
|
||||
| Board | A customizable page where apps, widgets, and Containers are arranged |
|
||||
| Tasks | Workloads that are performed in the background, even if no user is present |
|
||||
@@ -100,13 +100,14 @@ When fitting below 100%, Homarr keeps widget typography and control density at t
|
||||
On larger canvases, the complete board grows together like browser zoom.
|
||||
The scale never drops below 75%; on narrower screens the canvas scrolls horizontally instead of shrinking controls below an accessible size.
|
||||
|
||||
The position and size of every item can be changed separately in each responsive layout.
|
||||
When adding a new layout the position and sizes will automatically be generated depending on the column count.
|
||||
New items use their widget's default grid size, while a new inline section starts at a useful `4 × 3` size when the layout has enough columns.
|
||||
The position and size of every item are independent in each responsive layout.
|
||||
Moving or resizing an item in one layout does not change any other layout.
|
||||
When adding a new layout, its initial positions and sizes are generated from the column count.
|
||||
New items use their widget's default grid size, while a new Container starts at a useful `4 × 3` size when the layout has enough columns.
|
||||
Both are placed in the first available position.
|
||||
|
||||
Moving content downward in edit mode extends the canvas automatically, while view mode trims it back to the content.
|
||||
Nested sections keep their own resizable bounds.
|
||||
Nested Containers keep their own resizable bounds.
|
||||
|
||||
#### Name
|
||||
|
||||
@@ -117,20 +118,20 @@ The name of the layout can be chosen freely. It is only used for management and
|
||||
Total number of columns for this layout.
|
||||
When changed, Homarr moves items into the next available positions without overlap.
|
||||
|
||||
#### Fixed sidebars
|
||||
#### Fixed rails
|
||||
|
||||
Each responsive layout can enable a fixed left sidebar, a fixed right sidebar, or both.
|
||||
Set a sidebar width to zero to disable it for that layout.
|
||||
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.
|
||||
|
||||
Sidebar columns are reserved from the layout's total column count.
|
||||
For example, a 12-column layout with a two-column left sidebar leaves ten columns for the canvas.
|
||||
Enabling or widening a sidebar reflows canvas items into the remaining columns.
|
||||
Disabling a sidebar moves its contents back into the next available canvas positions.
|
||||
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.
|
||||
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.
|
||||
|
||||
Sidebars remain visible while the page scrolls.
|
||||
Apps, widgets, and sections inside them still use the same fixed `200 × 200` cells and can be rearranged in edit mode.
|
||||
Rails remain visible while the page scrolls.
|
||||
Apps, widgets, and Containers inside them still use the same fixed `200 × 200` cells and can be rearranged in edit mode.
|
||||
|
||||
#### Breakpoint
|
||||
|
||||
@@ -149,9 +150,13 @@ The visible corner controls provide a 44-pixel resize target, and edge controls
|
||||
Resize handles stop at the tile's minimum allowed size while the pointer is still moving.
|
||||
Exit edit mode to save the resulting positions.
|
||||
|
||||
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.
|
||||
The **Move / resize item** action in the edit menu remains available for precise numeric or touch input.
|
||||
Pointer users can drag anywhere on a tile; the grip is a visual cue for that move surface rather than a separate control.
|
||||
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.
|
||||
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.
|
||||
During a pointer or touch interaction, Escape cancels the move or resize and restores the layout from before that interaction.
|
||||
The **Move / resize item** action in the edit menu remains available for precise numeric input.
|
||||
|
||||
#### Preview
|
||||
|
||||
@@ -159,22 +164,22 @@ The **Move / resize item** action in the edit menu remains available for precise
|
||||
<img src={layoutMediumImage} height={256} />
|
||||
<img src={layoutLargeImage} height={256} />
|
||||
|
||||
### Sections and sidebars
|
||||
### Containers and rails
|
||||
|
||||
Sections can contain apps, widgets, and nested sections.
|
||||
Every section uses the same model whether it is on the canvas or inside a sidebar.
|
||||
Sections can be moved and resized directly in edit mode.
|
||||
Expanding it creates space for its contents and pushes following items out of the way; collapsing it compacts the board.
|
||||
Containers can hold apps, widgets, and nested Containers.
|
||||
The same Container model works on the main canvas, inside a fixed rail, or inside another Container.
|
||||
Move and resize Containers directly in edit mode; nested content stays within the Container's local bounds.
|
||||
Each responsive layout stores its own Container position and size.
|
||||
|
||||
Each section can configure:
|
||||
Each Container can configure:
|
||||
|
||||
- Whether its label is visible.
|
||||
- Whether users may collapse it.
|
||||
- Whether its menu shows **Open all in new tabs**.
|
||||
- Its label, border color, and custom CSS classes.
|
||||
- Its label and whether that label is visible.
|
||||
- Whether users can collapse and expand it like an accordion.
|
||||
- Whether its menu shows **Open all in new tabs** for the app links it contains.
|
||||
- Its border color and custom CSS classes.
|
||||
|
||||
Existing categories and dynamic sections are converted into this unified section model.
|
||||
Existing category rails become board sidebars automatically.
|
||||
Collapsing a Container compacts the surrounding layout without losing its expanded size.
|
||||
Expanding it restores those bounds and moves following items out of the way.
|
||||
|
||||
### Background
|
||||
|
||||
@@ -220,7 +225,7 @@ Change the color of your bookmark / app icons.
|
||||
|
||||
#### Item radius
|
||||
|
||||
Change the radius of your items / categories.
|
||||
Change the radius of your items and Containers.
|
||||
|
||||
<img src={itemRadiusImage} height={100} />
|
||||
|
||||
|
||||
Reference in new issue
Block a user