Skip to content

Commit

Permalink
Merge pull request #1267 from FlowFuse/1229-error-in-documentation
Browse files Browse the repository at this point in the history
Docs: Added missing documentation reference of tabs layout
  • Loading branch information
Steve-Mcl authored Sep 5, 2024
2 parents d059483 + 794cf3d commit a371146
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Currently, we have three different options for a page's layout:
- **Grid:** ([docs](https://dashboard.flowfuse.com/layouts/types/grid.html)) The default layout for a page. It uses a 12-column grid structure to layout the groups. The widths of each group or widget defines the number of columns they will render in. So, a "width" of 6" would render to 50% of the screen. Grid layouts are entirely responsive, and will adjust to the size of the screen.
- **Fixed:** ([docs](https://dashboard.flowfuse.com/layouts/types/fixed.html)) Each component will render at a _fixed_ width, no matter what the screen size is. The "width" property is converted a fixed pixel value (multiples of 48px by default).
- **Notebook:** ([docs](https://dashboard.flowfuse.com/layouts/types/notebook.html)) This layout will stretch to 100% width, up to a maximum width of 1024px, and will centrally align. It's particularly useful for storytelling (e.g. articles/blogs) or analysis type user interfaces (e.g. Jupyter Notebooks), where you want the user to digest content in a particular order through scrolling.
- **Tabs:** ([docs](https://dashboard.flowfuse.com/layouts/types/tabs.html)) This layout organizes content into separate tabbed sections, allowing users to switch between different views or content categories without leaving the page. Each tab can contain multiple groups and widgets, and it’s specially useful for organizing large amounts of information into easily digestible segments. The "Tabs" layout ensures better navigation and a cleaner UI when multiple content categories need to be displayed in a single view.


### Navigation Sidebar
Expand Down
2 changes: 1 addition & 1 deletion docs/layouts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Layouts are a configuration available on a page-by-page basis. They control how
![Screenshot of the layout options on a ui-page](../assets/images/layouts-page-layout-option.png){data-zoomable}
_Screenshot of the layout options on a `ui-page`_

We currently offer three different layout options:
We currently offer four different layout options:

- [Grid](./types/grid.md)
- [Fixed](./types/fixed.md)
Expand Down

0 comments on commit a371146

Please sign in to comment.