-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: document dashboard stack containers #11779
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,22 @@ | ||
| --- | ||
| title: Spacer & Divider | ||
| description: Non-data layout elements — a spacer for whitespace and a divider line — that help you structure a dashboard. | ||
| title: Layout widgets | ||
| description: Non-data layout elements — a stack container, spacer, and divider — that help you structure a dashboard. | ||
| --- | ||
|
|
||
| Spacer and divider are non-data **layout** widgets. They carry no data of their own; you place them on the canvas alongside charts, text, and controls to add whitespace and visual structure to a dashboard. | ||
| Stack, spacer, and divider are non-data **layout** widgets. Stack carries other widgets; spacer and divider carry no data of their own. Place them on the canvas alongside charts, text, and controls to structure a dashboard. | ||
|
|
||
| ## Stack | ||
|
|
||
| A stack is a container that groups other widgets and lays them out along one axis: | ||
|
|
||
| - **Horizontal stack** — arranges its children side by side. | ||
| - **Vertical stack** — stacks its children on top of each other. | ||
|
|
||
| A stack's children share the space evenly along that axis and have no size of their own — only a position in the line. Resizing the stack resizes every child with it. | ||
|
|
||
| Drag a widget onto a stack to add it — an empty stack prompts you to **Drag widgets here**. As you drag over the stack, it opens a slot under the pointer showing exactly where the widget will land. A stack can hold other stacks too, nested up to 4 levels deep. | ||
|
|
||
| Controls placed inside a stack ([filters](/docs/explore-analyze/dashboards/widgets/controls#filter), [time granularity switchers](/docs/explore-analyze/dashboards/widgets/controls#time-granularity-switcher), [field switchers](/docs/explore-analyze/dashboards/widgets/controls#field-switcher), and [parent controls](/docs/explore-analyze/dashboards/widgets/controls#parent)) drive the dashboard the same as controls placed directly on the canvas. | ||
|
|
||
| ## Spacer | ||
|
|
||
|
|
@@ -17,11 +30,11 @@ A divider is a horizontal separator line that breaks up the layout flow — a li | |
|
|
||
| ## Adding a layout widget | ||
|
|
||
| In the [dashboard builder][ref-workbooks], open the **Add Widgets** menu in the toolbar and choose **Spacer** or **Divider**. The widget is added to the canvas, where you can drag it into place and (for a spacer) resize it. | ||
| In the [dashboard builder][ref-workbooks], open the **Add Widgets** menu in the toolbar and choose **Horizontal stack**, **Vertical stack**, **Spacer**, or **Divider**. The widget is added to the canvas, where you can drag it into place and (for a spacer or stack) resize it. | ||
|
|
||
| ## Styling | ||
|
|
||
| Both widgets follow the dashboard's [widget styling settings](/docs/explore-analyze/dashboards/styling): | ||
| The spacer and divider follow the dashboard's [widget styling settings](/docs/explore-analyze/dashboards/styling): | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Narrowing this from "Both widgets" to "The spacer and divider" is correct, but it leaves stack unaddressed: a reader who just learned about a third layout widget will wonder whether a stack picks up the dashboard's border/background settings, and this section now silently excludes it. Worth one clause either way — e.g. "A stack is invisible on the published dashboard and takes no styling of its own." (assuming that's what the implementation does). |
||
|
|
||
| - The **divider** draws its line using the widget **border** width, style, and color. | ||
| - A **spacer** picks up the same border and background settings while you are editing, so its bounds are easy to see. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sibling pages in this group use bare nouns as titles —
Charts,Text,Controls,AI summary.Layout widgetsis the odd one out, and since the sidebar group is already Widgets, the suffix reads as redundant there. It also doesn't match the link text you used on the index page (- [Layout](...)).