(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Grid Container

Overview

Example Grid Container

Specs

Tokens

Token Description
displayName Display name in the structure panel
elements Components rendered inside the grid container
gridLayout Configuration object for CSS grid properties
gridTemplateColumns Defines column layout using CSS grid syntax
gridTemplateRows Defines row layout using CSS grid syntax
gridGap Sets spacing between grid items
fullHeight Expands grid to fill parent height
events Configurable component events
ON_INIT (Events) Event triggered on initialization
ON_DESTROY (Events) Event triggered on removal
dataTestId Testing hook ID for automated testing
visibilityPolicySetId Controls visibility based on policy sets
displayConditions Conditions for showing the component

Structure

(Configured in General Properties)

Lables structure of the Grid Container

(Configured in Visibility)

Styling

(Configured in Visual Properties)

Example Layout Configurations

Actions & Variants

(Configured in Events)

Tests

(Configured in Testing Hooks)

Authorization

(Configured in Authorization)

Links

Guidelines

Usage

Sizing & Layout

Visibility & Authorization

Dos & Don’ts

Do Don’t Article setting(s)
Use gridTemplateColumns to define a consistent track system (e.g., 1fr 1fr 1fr). Mix arbitrary widths across items without defining tracks, causing misalignment. gridTemplateColumns
Set gridGap once to establish uniform spacing rhythm. Depend on inconsistent child spacing to fake gutters. gridGap
Combine auto/fixed rows for headers/footers with a flexible middle (1fr). Force all rows to fixed heights, causing clipping or overflow. gridTemplateRows
Enable fullHeight when the layout must fill the viewport/panel. Leave vertical space unused when full-height composition is required. fullHeight
Initialize track strings during ON_INIT to keep the layout stable. Recompute tracks repeatedly during interaction, causing jumps. ON_INIT, gridTemplateColumns, gridTemplateRows
Hide the grid when its data/prereqs are absent. Show an empty grid that implies missing content without context. displayConditions
Restrict visibility by role/policy. Show sensitive layout regions to everyone and rely on content to block use. visibilityPolicySetId
Expose a stable test hook. Select the grid by brittle DOM paths or nth-child selectors. dataTestId

Accessibility