Skip to main content
Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

BlockLayout

BlockLayout is used to lay out content over multiple rows.

By default, all rows fill the available block space, sharing it equally.

Support
Targets (50)

Supported targets

Anchor to BlockLayoutPropsBlockLayoutProps

BlockLayout is used to lay out content over multiple rows.

By default, all rows fill the available block space, sharing it equally.

Anchor to accessibilityLabel
accessibilityLabel
string

A label that describes the purpose or contents of the element. When set, it will be announced to buyers using assistive technologies and will provide them with more context.

Anchor to accessibilityRole
accessibilityRole

Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.

For example:

  • In an HTML host a ['listItem', 'separator'] tuple will render: <li role='separator'>

  • In an HTML host a listItem string will render: <li>

Anchor to background
background
<>
Default: 'transparent'

The background color of the element, set using a design-system keyword.

  • transparent: No background; the parent's background shows through.
  • base: The standard surface background color.
  • subdued: A muted background for de-emphasized or secondary content.
Anchor to blockAlignment
blockAlignment
<>

Position children along the cross axis.

Anchor to border
border
<<>>

The border style of the element.

To shorten the code, it is possible to specify all the border style properties in one property.

For example:

  • base means blockStart, inlineEnd, blockEnd and inlineStart border styles are base

  • ['base', 'none'] means blockStart and blockEnd border styles are base, inlineStart and inlineEnd border styles are none

  • ['base', 'none', 'dotted', 'base'] means blockStart border style is base, inlineEnd border style is none, blockEnd border style is dotted and blockStart border style is base

Anchor to borderWidth
borderWidth
< <> >

The border width of the element.

To shorten the code, it is possible to specify all the border width properties in one property.

For example:

  • base means blockStart, inlineEnd, blockEnd and inlineStart border widths are base

  • ['base', 'medium'] means blockStart and blockEnd border widths are base, inlineStart and inlineEnd border widths are medium

  • ['base', 'medium', 'medium', 'base'] means blockStart border width is base, inlineEnd border width is medium, blockEnd border width is medium and blockStart border width is base

Anchor to cornerRadius
cornerRadius
< <> >

The corner radius of the element.

Provide a single value to apply the same corner radius to all four corners, two values to apply different corner radii to opposing corners, or four values to apply different corner radii to each individual corner.

For example:

  • base means all 4 corner radii are base

  • ['base', 'none'] means the StartStart and EndEnd corner radii are base, StartEnd and EndStart corner radii are none. When the context’s language direction is left to right, StartStart and EndEnd corners are the top left and bottom right corners while StartEnd and EndStart corners are the top right and bottom left corners.

  • ['base', 'none', 'small', 'base'] means StartStart corner radius is base, StartEnd corner radius is none, EndEnd corner radius is small and EndStart corner radius is base

A borderRadius alias is available for this property. When both are specified, cornerRadius takes precedence.

Anchor to display
display
<'auto' | 'none'>
Default: 'auto'

Changes the display of the component.

auto the component's initial value. The actual value depends on the component and context.

none hides the component and removes it from the accessibility tree, making it invisible to screen readers.

Anchor to id
id
string

A unique identifier for the component.

Anchor to inlineAlignment
inlineAlignment
<>

Position children along the main axis.

Anchor to maxBlockSize
maxBlockSize
< number | `${number}%` | 'fill' >

The maximum block size (maximum height in horizontal writing modes). The element won't grow taller than this value even if its content is longer.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's block size.
  • 'fill': Takes all the available space.

Learn more about the max-block-size property.

Anchor to maxInlineSize
maxInlineSize
< number | `${number}%` | 'fill' >

The maximum inline size (maximum width in horizontal writing modes). The element won't grow wider than this value.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's inline size.
  • 'fill': Takes all the available space.

Learn more about the max-inline-size property.

Anchor to minBlockSize
minBlockSize
< number | `${number}%` | 'fill' >

The minimum block size (minimum height in horizontal writing modes). The element won't shrink smaller than this value even if its content is shorter.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's block size.
  • 'fill': Takes all the available space.

Learn more about the min-block-size property.

Anchor to minInlineSize
minInlineSize
< number | `${number}%` | 'fill' >

The minimum inline size (minimum width in horizontal writing modes). The element won't shrink narrower than this value.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's inline size.
  • 'fill': Takes all the available space.

Learn more about the min-inline-size property.

Anchor to overflow
overflow
'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.

visible: the content that extends beyond the element’s container is visible.

Anchor to padding
padding
<<>>

The padding on all edges of the element, using a shorthand syntax. You can specify one, two, or four values following the CSS shorthand convention.

  • T: A single value applied uniformly to all edges.
  • [T, T]: The first value applies to block-start and block-end, the second to inline-start and inline-end.
  • [T, T, T, T]: Values apply to block-start, inline-end, block-end, and inline-start respectively.
Anchor to rows
rows
<>
Default: 'fill'

Sizes for each row of the layout.

auto: intrinsic size of the element.

fill: fills the remaining available space. When multiple elements are set to fill, the remaining space is shared equally.

`${number}%`: size in percentages.

`${number}fr`: size in fractions.

number: size in pixels.

  • When the sum of the defined sizes is larger than the available space, elements will shrink to avoid overflow.

  • When the size of an element is not explicitly set, it will fill the remaining space available.

  • When only one size is set and outside of an array, all elements of the layout will take that size.

Anchor to spacing
spacing
< | [, ]>
Default: 'none'

Adjust spacing between children.

  • base means the space between rows and columns is base.

  • [base, none] means the space between rows is base, space between columns is none.

Anchor to borderRadius
borderRadius
< <> >
Deprecated

Use cornerRadius instead.

The corner radius of the element. Accepts a single value for all corners or a shorthand tuple for per-corner control.

Anchor to ExamplesExamples

Anchor to Basic BlockLayoutBasic BlockLayout

Basic BlockLayout

Example

Basic BlockLayout

import {
reactExtension,
BlockLayout,
View,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);

function Extension() {
return (
<BlockLayout rows={[60, 'fill']}>
<View border="base" padding="base">
60
</View>
<View border="base" padding="base">
fill
</View>
</BlockLayout>
);
}
import {extension, BlockLayout, View} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
const blockLayout = root.createComponent(
BlockLayout,
{
rows: [60, 'fill'],
},
[
root.createComponent(View, {border: 'base', padding: 'base'}, '60'),
root.createComponent(View, {border: 'base', padding: 'base'}, 'fill'),
],
);

root.appendChild(blockLayout);
});

Anchor to Accessibility rolesAccessibility roles

ValueDescription
"main"Used to indicate the primary content.
"header"Used to indicate the component is a header.
"footer"Used to display information such as copyright information, navigation links, and privacy statements.
"section"Used to indicate a generic section.
"complementary"Used to designate a supporting section that relates to the main content.
"navigation"Used to identify major groups of links used for navigating.
"orderedList"Used to identify a list of ordered items.
"listItem"Used to identify an item inside a list of items.
"unorderedList"Used to identify a list of unordered items.
"separator"Used to indicates the component acts as a divider that separates and distinguishes sections of content.
"status"Used to define a live region containing advisory information for the user that is not important enough to be an alert.
"alert"Used for important, and usually time-sensitive, information.

Anchor to RelatedRelated

UtilityStyleHelper
Was this page helpful?