Skip to content

Commit f6aa3ec

Browse files
mngrclaude
authored andcommitted
docs(dashboards): document the Grid container widget
Add a Grid container page to the dashboard widgets section, covering: adding a container, the independent inner cols×rows grid, dragging widgets in, arranging (move/resize container + children, move a child out), Distribute evenly, nesting containers, and Edit/Delete. Registers the page in the widgets nav (docs.json) and lists it on the widgets index. Documents the Grid container shipped in cubejs-enterprise PR #13919 (CUB-3811). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 748d522 commit f6aa3ec

3 files changed

Lines changed: 72 additions & 2 deletions

File tree

docs-mintlify/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@
115115
"docs/explore-analyze/dashboards/widgets/text",
116116
"docs/explore-analyze/dashboards/widgets/controls",
117117
"docs/explore-analyze/dashboards/widgets/ai-summary",
118-
"docs/explore-analyze/dashboards/widgets/layout"
118+
"docs/explore-analyze/dashboards/widgets/layout",
119+
"docs/explore-analyze/dashboards/widgets/container"
119120
]
120121
},
121122
"docs/explore-analyze/dashboards/styling",
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Grid container
3+
description: Group widgets into a nested grid so you can arrange, resize, and move them together on a dashboard.
4+
---
5+
6+
<Warning>
7+
8+
The grid container widget is currently in preview, and its behavior may still change. Reach out to the [Cube support team](/admin/account-billing/support) to activate it for your account.
9+
10+
</Warning>
11+
12+
A grid container is a widget that holds other widgets in its own grid. Use it to group related tiles — a chart with its controls, a section of KPIs, a labelled block of text and visuals — so they can be arranged, moved, and resized as a unit. Containers can be nested, letting you build structured, multi-section layouts on a single dashboard.
13+
14+
## Adding a grid container
15+
16+
In the [dashboard builder][ref-workbooks], open the **Add Widgets** group in the toolbar and drag the **Grid** entry onto the canvas. The container is added with an empty inner grid, and its settings panel opens so you can size the grid right away.
17+
18+
<Steps>
19+
<Step title="Drag a Grid onto the canvas">
20+
Open **Add Widgets** in the toolbar and drop the **Grid** entry where you want the container.
21+
</Step>
22+
<Step title="Set the inner grid size">
23+
In the settings panel that opens, set the number of **Columns** and **Rows** for the container's inner grid. It starts as a 2 × 2 grid.
24+
</Step>
25+
<Step title="Add widgets into it">
26+
Drag charts and other widgets straight into the container — see [Adding widgets to a container](#adding-widgets-to-a-container) below.
27+
</Step>
28+
</Steps>
29+
30+
## The inner grid
31+
32+
Each container has its own grid, independent of the dashboard's grid. The **Columns** and **Rows** you set describe that inner grid, and it fills the whole container surface — so the container's cells resize with it rather than being tied to the dashboard's column width. Grid lines are shown while you're editing so you can see where widgets will land.
33+
34+
The grid grows a new row automatically when a widget is placed or resized past the current bottom edge, so you never run out of room while arranging.
35+
36+
## Adding widgets to a container
37+
38+
You can add most widget types to a container — charts, text, AI summaries, controls, spacers, and dividers, as well as other grid containers.
39+
40+
- **From the toolbar** — drag a widget from the **Add Widgets** or **Add Controls** group and drop it directly onto the container, in one step.
41+
- **Charts** — pick a report from the **Charts** picker and drop it onto the container.
42+
- **Move an existing widget in** — drag a widget already on the dashboard into the container to move it inside.
43+
44+
Dropped widgets snap to the container's grid cells, and you can resize and rearrange them afterwards like any other widget.
45+
46+
## Arranging widgets
47+
48+
- **Move the container** — drag the container on the dashboard; its child widgets keep their positions relative to each other.
49+
- **Resize the container** — drag the resize grip on its bottom-right corner. Shrinking the container scales its children down to keep them in view.
50+
- **Resize a child** — drag a child widget's resize grip to change its width or height within the grid.
51+
- **Move a widget out** — drag a child out of the container and onto the dashboard to promote it back to a top-level widget. The dashboard reflows to make room below the drop point.
52+
53+
## Distribute evenly
54+
55+
Turn on **Distribute evenly** in the container's settings to give every child the same width and height, laying them out as an even grid. This is handy when a container holds a set of comparable tiles — for example a row of KPIs — that should all be the same size. With it off, each child keeps the size you gave it.
56+
57+
## Nesting containers
58+
59+
A grid container can hold another grid container. Drop a **Grid** into an existing container the same way you'd add any other widget, then add widgets into the nested grid. Use nesting to build sections within sections — for example, a top-level container per dashboard area, each holding its own arranged set of charts and controls.
60+
61+
## Editing and removing
62+
63+
Every container shows a settings gear on its top-right corner. Click it to open the menu:
64+
65+
- **Edit** — open the settings panel to change the **Columns**, **Rows**, or **Distribute evenly** options.
66+
- **Delete** — remove the container and everything inside it from the dashboard.
67+
68+
[ref-workbooks]: /docs/explore-analyze/workbooks

docs-mintlify/docs/explore-analyze/dashboards/widgets/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ The dashboard builder supports the following widget types:
1414
- [Controls](/docs/explore-analyze/dashboards/widgets/controls) — Let viewers filter the data or switch the time granularity
1515
- [AI summary](/docs/explore-analyze/dashboards/widgets/ai-summary) — Generate narrative summaries of dashboard data on demand
1616
- [Spacer & Divider](/docs/explore-analyze/dashboards/widgets/layout) — Non-data layout elements for whitespace and section breaks (in preview)
17+
- [Grid container](/docs/explore-analyze/dashboards/widgets/container) — Group widgets into a nested grid to arrange, move, and resize them together (in preview)
1718

1819
## Adding widgets
1920

20-
Add widgets from the toolbar at the top of the dashboard builder: pick reports from the **Charts** picker to add charts, use the **Add Widgets** menu for text, AI summaries, and layout elements, or add a **Filter** or **Time Granularity** control from the **Add Controls** group.
21+
Add widgets from the toolbar at the top of the dashboard builder: pick reports from the **Charts** picker to add charts, use the **Add Widgets** menu for text, AI summaries, layout elements, and grid containers, or add a **Filter** or **Time Granularity** control from the **Add Controls** group.
2122

2223
Each toolbar item can be added in two ways:
2324

0 commit comments

Comments
 (0)