Grid
Use s-grid
to organize your content in a matrix of rows and columns and make responsive layouts for pages. Grid follows the same pattern as the CSS grid layout.
Anchor to propertiesProperties
- Anchor to accessibilityLabelaccessibilityLabelstring
A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.
Only use this when the element's content is not enough context for users using assistive technologies.
- Anchor to accessibilityRoleaccessibilityRoleAccessibilityRoleDefault: 'generic'
Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.
- Anchor to accessibilityVisibilityaccessibilityVisibility'visible' | 'hidden' | 'exclusive'Default: 'visible'
Changes the visibility of the element.
visible
: the element is visible to all users.hidden
: the element is removed from the accessibility tree but remains visible.exclusive
: the element is visually hidden but remains in the accessibility tree.
- Anchor to alignContentalignContentMaybeResponsive<ReducedAlignContentKeyword | ''>
Aligns the grid along the block (column) axis.
This overrides the block value of
.
- Anchor to alignItemsalignItemsMaybeResponsive<ReducedAlignItemsKeyword | ''>
Aligns the grid items along the block (column) axis.
This overrides the block value of
.
- Anchor to backgroundbackground'base' | 'subdued' | 'transparent'
Adjust the background of the element.
- Anchor to blockSizeblockSizeMaybeResponsive<SizeUnitsOrAuto>Default: 'auto'
Adjust the block size.
- Anchor to borderborderBorderShorthand
Set the border via the shorthand property.
This can be a size, optionally followed by a color, optionally followed by a style.
If the color is not specified, it will be
base
.If the style is not specified, it will be
auto
.Values can be overridden by
,
, and
.
- Anchor to borderColorborderColor'' | 'base'
Set the color of the border.
If set, it takes precedence over the
border
property's color.- Anchor to borderRadiusborderRadiusMaybeAllValuesShorthandProperty<Extract<GridProps$1['borderRadius'], 'none' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'max'>>
Set the radius of the border.
1-to-4-value syntax is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
- 4 values:
start-start start-end end-end end-start
- 3 values:
start-start (start-end & end-start) start-end
- 2 values:
(start-start & end-end) (start-end & end-start)
For example:
small-100
means start-start, start-end, end-end and end-start border radii aresmall-100
.small-100 none
means start-start and end-end border radii aresmall-100
, start-end and end-start border radii arenone
.small-100 none large-100
means start-start border radius issmall-100
, start-end border radius isnone
, end-end border radius islarge-100
and end-start border radius isnone
.small-100 none large-100 small-100
means start-start border radius issmall-100
, start-end border radius isnone
, end-end border radius islarge-100
and end-start border radius issmall-100
.
- 4 values:
- Anchor to borderStyleborderStyleMaybeAllValuesShorthandProperty<BorderStyleKeyword> | ""Default: '' - meaning no override
Set the style of the border.
If set, it takes precedence over the
border
property's style.Like CSS, up to 4 values can be specified.
If one value is specified, it applies to all sides.
If two values are specified, they apply to the block sides and inline sides respectively.
If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
- Anchor to borderWidthborderWidthMaybeAllValuesShorthandProperty<ReducedBorderSizeKeyword> | ''
Set the width of the border.
If set, it takes precedence over the
border
property's width.Like CSS, up to 4 values can be specified.
If one value is specified, it applies to all sides.
If two values are specified, they apply to the block sides and inline sides respectively.
If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
- Anchor to columnGapcolumnGapMaybeResponsive<SpacingKeyword | "">Default: '' - meaning no override
Adjust spacing between elements in the inline axis.
This overrides the column value of
gap
.- Anchor to displaydisplayMaybeResponsive<"auto" | "none">Default: 'auto'
Sets the outer display type of the component. The outer type sets a component’s participation in flow layout.
auto
: the component’s initial value. The actual value depends on the component and context.none
: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
- MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>Default: 'none'
Adjust spacing between elements.
A single value applies to both axes. A pair of values (eg
large-100 large-500
) can be used to set the inline and block axes respectively.- Anchor to gridTemplateColumnsgridTemplateColumnsMaybeResponsive<string>Default: 'none'
Define columns and specify their size.
- Anchor to gridTemplateRowsgridTemplateRowsMaybeResponsive<string>Default: 'none'
Define rows and specify their size.
- string
A unique identifier for the element.
- Anchor to inlineSizeinlineSizeMaybeResponsive<SizeUnitsOrAuto>Default: 'auto'
Adjust the inline size.
- Anchor to justifyContentjustifyContentMaybeResponsive<ReducedJustifyContentKeyword | ''>
Aligns the grid along the inline (row) axis.
This overrides the inline value of
.
- Anchor to justifyItemsjustifyItemsMaybeResponsive<ReducedJustifyItemsKeyword | ''>
Aligns the grid items along the inline (row) axis.
This overrides the inline value of
.
- Anchor to maxBlockSizemaxBlockSizeMaybeResponsive<SizeUnitsOrNone>Default: 'none'
Adjust the maximum block size.
- Anchor to maxInlineSizemaxInlineSizeMaybeResponsive<SizeUnitsOrNone>Default: 'none'
Adjust the maximum inline size.
- Anchor to minBlockSizeminBlockSizeMaybeResponsive<SizeUnits>Default: '0'
Adjust the minimum block size.
- Anchor to minInlineSizeminInlineSizeMaybeResponsive<SizeUnits>Default: '0'
Adjust the minimum inline size.
- Anchor to overflowoverflow'hidden' | 'visible'Default: 'visible'
Sets the overflow behavior of the element.
hidden
: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.visible
: the content that extends beyond the element’s container is visible.
- Anchor to paddingpaddingMaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>Default: 'none'
Adjust the padding of all edges.
1-to-4-value syntax is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
- 4 values:
block-start inline-end block-end inline-start
- 3 values:
block-start inline block-end
- 2 values:
block inline
For example:
large
means block-start, inline-end, block-end and inline-start paddings arelarge
.large none
means block-start and block-end paddings arelarge
, inline-start and inline-end paddings arenone
.large none large
means block-start padding islarge
, inline-end padding isnone
, block-end padding islarge
and inline-start padding isnone
.large none large small
means block-start padding islarge
, inline-end padding isnone
, block-end padding islarge
and inline-start padding issmall
.
A padding value of
auto
will use the default padding for the closest container that has had its usual padding removed.- 4 values:
- Anchor to paddingBlockpaddingBlockMaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">Default: '' - meaning no override
Adjust the block-padding.
large none
means block-start padding islarge
, block-end padding isnone
.
This overrides the block value of
padding
.- Anchor to paddingBlockEndpaddingBlockEndMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the block-end padding.
This overrides the block-end value of
.
- Anchor to paddingBlockStartpaddingBlockStartMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the block-start padding.
This overrides the block-start value of
.
- Anchor to paddingInlinepaddingInlineMaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">Default: '' - meaning no override
Adjust the inline padding.
large none
means inline-start padding islarge
, inline-end padding isnone
.
This overrides the inline value of
padding
.- Anchor to paddingInlineEndpaddingInlineEndMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the inline-end padding.
This overrides the inline-end value of
.
- Anchor to paddingInlineStartpaddingInlineStartMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the inline-start padding.
This overrides the inline-start value of
.
- Anchor to placeContentplaceContentMaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>
A shorthand property for
justify-content
andalign-content
.- Anchor to placeItemsplaceItemsMaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>
A shorthand property for
justify-items
andalign-items
.- Anchor to rowGaprowGapMaybeResponsive<SpacingKeyword | "">Default: '' - meaning no override
Adjust spacing between elements in the block axis.
This overrides the row value of
gap
.
AccessibilityRole
"main" | "header" | "footer" | "section" | "aside" | "navigation" | "ordered-list" | "list-item" | "list-item-separator" | "unordered-list" | "separator" | "status" | "alert" | "generic" | "presentation" | "none"
MaybeResponsive
T | `@container${string}`
ReducedAlignContentKeyword
'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'
ReducedAlignItemsKeyword
'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'
SizeUnitsOrAuto
SizeUnits | "auto"
SizeUnits
`${number}px` | `${number}%` | `0`
BorderShorthand
ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`
ReducedBorderSizeKeyword
'large' | 'base' | 'large-100' | 'large-200' | 'none'
ReducedColorKeyword
'base'
BorderStyleKeyword
"none" | "solid" | "dashed" | "dotted" | "auto"
MaybeAllValuesShorthandProperty
T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`
SpacingKeyword
SizeKeyword | "none"
SizeKeyword
"small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500"
MaybeTwoValuesShorthandProperty
T | `${T} ${T}`
ReducedJustifyContentKeyword
'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'
ReducedJustifyItemsKeyword
'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'
SizeUnitsOrNone
SizeUnits | "none"
PaddingKeyword
SizeKeyword | "none"
Anchor to griditemGridItem
Display content within a single item of a grid layout.
- Anchor to accessibilityLabelaccessibilityLabelstring
A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.
Only use this when the element's content is not enough context for users using assistive technologies.
- Anchor to accessibilityRoleaccessibilityRoleAccessibilityRoleDefault: 'generic'
Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.
- Anchor to accessibilityVisibilityaccessibilityVisibility'visible' | 'hidden' | 'exclusive'Default: 'visible'
Changes the visibility of the element.
visible
: the element is visible to all users.hidden
: the element is removed from the accessibility tree but remains visible.exclusive
: the element is visually hidden but remains in the accessibility tree.
- Anchor to backgroundbackground'base' | 'subdued' | 'transparent'
Adjust the background of the element.
- Anchor to blockSizeblockSizeMaybeResponsive<SizeUnitsOrAuto>Default: 'auto'
Adjust the block size.
- Anchor to borderborderBorderShorthand
Set the border via the shorthand property.
This can be a size, optionally followed by a color, optionally followed by a style.
If the color is not specified, it will be
base
.If the style is not specified, it will be
auto
.Values can be overridden by
,
, and
.
- Anchor to borderColorborderColor'' | 'base'
Set the color of the border.
If set, it takes precedence over the
border
property's color.- Anchor to borderRadiusborderRadiusMaybeAllValuesShorthandProperty<Extract<GridItemProps$1['borderRadius'], 'none' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'max'>>
Set the radius of the border.
1-to-4-value syntax is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
- 4 values:
start-start start-end end-end end-start
- 3 values:
start-start (start-end & end-start) start-end
- 2 values:
(start-start & end-end) (start-end & end-start)
For example:
small-100
means start-start, start-end, end-end and end-start border radii aresmall-100
.small-100 none
means start-start and end-end border radii aresmall-100
, start-end and end-start border radii arenone
.small-100 none large-100
means start-start border radius issmall-100
, start-end border radius isnone
, end-end border radius islarge-100
and end-start border radius isnone
.small-100 none large-100 small-100
means start-start border radius issmall-100
, start-end border radius isnone
, end-end border radius islarge-100
and end-start border radius issmall-100
.
- 4 values:
- Anchor to borderStyleborderStyleMaybeAllValuesShorthandProperty<BorderStyleKeyword> | ""Default: '' - meaning no override
Set the style of the border.
If set, it takes precedence over the
border
property's style.Like CSS, up to 4 values can be specified.
If one value is specified, it applies to all sides.
If two values are specified, they apply to the block sides and inline sides respectively.
If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
- Anchor to borderWidthborderWidthMaybeAllValuesShorthandProperty<ReducedBorderSizeKeyword> | ''
Set the width of the border.
If set, it takes precedence over the
border
property's width.Like CSS, up to 4 values can be specified.
If one value is specified, it applies to all sides.
If two values are specified, they apply to the block sides and inline sides respectively.
If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
- Anchor to displaydisplayMaybeResponsive<"auto" | "none">Default: 'auto'
Sets the outer display type of the component. The outer type sets a component’s participation in flow layout.
auto
: the component’s initial value. The actual value depends on the component and context.none
: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
- Anchor to gridColumngridColumn`span ${number}` | "auto"Default: 'auto'
Number of columns the item will span across
- Anchor to gridRowgridRow`span ${number}` | "auto"Default: 'auto'
Number of rows the item will span across
- string
A unique identifier for the element.
- Anchor to inlineSizeinlineSizeMaybeResponsive<SizeUnitsOrAuto>Default: 'auto'
Adjust the inline size.
- Anchor to maxBlockSizemaxBlockSizeMaybeResponsive<SizeUnitsOrNone>Default: 'none'
Adjust the maximum block size.
- Anchor to maxInlineSizemaxInlineSizeMaybeResponsive<SizeUnitsOrNone>Default: 'none'
Adjust the maximum inline size.
- Anchor to minBlockSizeminBlockSizeMaybeResponsive<SizeUnits>Default: '0'
Adjust the minimum block size.
- Anchor to minInlineSizeminInlineSizeMaybeResponsive<SizeUnits>Default: '0'
Adjust the minimum inline size.
- Anchor to overflowoverflow'hidden' | 'visible'Default: 'visible'
Sets the overflow behavior of the element.
hidden
: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.visible
: the content that extends beyond the element’s container is visible.
- Anchor to paddingpaddingMaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>Default: 'none'
Adjust the padding of all edges.
1-to-4-value syntax is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
- 4 values:
block-start inline-end block-end inline-start
- 3 values:
block-start inline block-end
- 2 values:
block inline
For example:
large
means block-start, inline-end, block-end and inline-start paddings arelarge
.large none
means block-start and block-end paddings arelarge
, inline-start and inline-end paddings arenone
.large none large
means block-start padding islarge
, inline-end padding isnone
, block-end padding islarge
and inline-start padding isnone
.large none large small
means block-start padding islarge
, inline-end padding isnone
, block-end padding islarge
and inline-start padding issmall
.
A padding value of
auto
will use the default padding for the closest container that has had its usual padding removed.- 4 values:
- Anchor to paddingBlockpaddingBlockMaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">Default: '' - meaning no override
Adjust the block-padding.
large none
means block-start padding islarge
, block-end padding isnone
.
This overrides the block value of
padding
.- Anchor to paddingBlockEndpaddingBlockEndMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the block-end padding.
This overrides the block-end value of
.
- Anchor to paddingBlockStartpaddingBlockStartMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the block-start padding.
This overrides the block-start value of
.
- Anchor to paddingInlinepaddingInlineMaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">Default: '' - meaning no override
Adjust the inline padding.
large none
means inline-start padding islarge
, inline-end padding isnone
.
This overrides the inline value of
padding
.- Anchor to paddingInlineEndpaddingInlineEndMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the inline-end padding.
This overrides the inline-end value of
.
- Anchor to paddingInlineStartpaddingInlineStartMaybeResponsive<PaddingKeyword | "">Default: '' - meaning no override
Adjust the inline-start padding.
This overrides the inline-start value of
.
AccessibilityRole
"main" | "header" | "footer" | "section" | "aside" | "navigation" | "ordered-list" | "list-item" | "list-item-separator" | "unordered-list" | "separator" | "status" | "alert" | "generic" | "presentation" | "none"
MaybeResponsive
T | `@container${string}`
SizeUnitsOrAuto
SizeUnits | "auto"
SizeUnits
`${number}px` | `${number}%` | `0`
BorderShorthand
ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`
ReducedBorderSizeKeyword
'large' | 'base' | 'large-100' | 'large-200' | 'none'
ReducedColorKeyword
'base'
BorderStyleKeyword
"none" | "solid" | "dashed" | "dotted" | "auto"
MaybeAllValuesShorthandProperty
T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`
SizeUnitsOrNone
SizeUnits | "none"
PaddingKeyword
SizeKeyword | "none"
SizeKeyword
"small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500"
MaybeTwoValuesShorthandProperty
T | `${T} ${T}`
Code
Examples
Code
Default
<s-grid gridTemplateColumns="1fr auto" gap="base"> <s-grid-item gridColumn="span 2" border="base" borderStyle="dashed"> Plants for sale </s-grid-item> <s-grid-item border="base" borderStyle="dashed"> Pothos </s-grid-item> <s-grid-item border="base" borderStyle="dashed"> $25.00 </s-grid-item> </s-grid>
Preview
