---
title: BlockLayout
description: |-
BlockLayout is used to lay out content over multiple rows.
By default, all rows fill the available block space, sharing it equally.
api_version: 2025-07
api_name: customer-account-ui-extensions
source_url:
html: >-
https://shopify.dev/docs/api/customer-account-ui-extensions/2025-07/ui-components/layout-and-structure/blocklayout
md: >-
https://shopify.dev/docs/api/customer-account-ui-extensions/2025-07/ui-components/layout-and-structure/blocklayout.md
---
Migrate to Polaris
Version 2025-07 is the last API version to support React-based UI components. Later versions use [web components](https://shopify.dev/docs/api/customer-account-ui-extensions/latest/polaris-web-components), native UI elements with built-in accessibility, better performance, and consistent styling with [Shopify's design system](https://shopify.dev/docs/apps/design). Check out the [migration guide](https://shopify.dev/docs/apps/build/customer-accounts/migrate-to-web-components) 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 (25)
### Supported targets
* CustomerAccount::KitchenSink
* customer-account.footer.render-after
* customer-account.order-index.announcement.render
* customer-account.order-index.block.render
* customer-account.order-status.announcement.render
* customer-account.order-status.block.render
* customer-account.order-status.cart-line-item.render-after
* customer-account.order-status.cart-line-list.render-after
* customer-account.order-status.customer-information.render-after
* customer-account.order-status.fulfillment-details.render-after
* customer-account.order-status.payment-details.render-after
* customer-account.order-status.return-details.render-after
* customer-account.order-status.unfulfilled-items.render-after
* customer-account.order.action.menu-item.render
* customer-account.order.action.render
* customer-account.order.page.render
* customer-account.page.render
* customer-account.profile.addresses.render-after
* customer-account.profile.announcement.render
* customer-account.profile.block.render
* customer-account.profile.company-details.render-after
* customer-account.profile.company-location-addresses.render-after
* customer-account.profile.company-location-payment.render-after
* customer-account.profile.company-location-staff.render-after
* customer-account.profile.payment.render-after
## BlockLayoutProps
* **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.
* **accessibilityRole**
**ViewLikeAccessibilityRole**
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: ``
* In an HTML host a `listItem` string will render: ``
* **blockAlignment**
**MaybeResponsiveConditionalStyle\**
Position children along the cross axis.
* **border**
**MaybeResponsiveConditionalStyle\>**
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`
* **borderWidth**
**MaybeResponsiveConditionalStyle< MaybeShorthandProperty\ >**
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`
* **cornerRadius**
**MaybeResponsiveConditionalStyle< MaybeShorthandProperty\ >**
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.
* **display**
**MaybeResponsiveConditionalStyle<'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.
* **id**
**string**
A unique identifier for the component.
* **inlineAlignment**
**MaybeResponsiveConditionalStyle\**
Position children along the main axis.
* **maxBlockSize**
**MaybeResponsiveConditionalStyle< 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](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) property.
* **maxInlineSize**
**MaybeResponsiveConditionalStyle< 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](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) property.
* **minBlockSize**
**MaybeResponsiveConditionalStyle< 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](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) property.
* **minInlineSize**
**MaybeResponsiveConditionalStyle< 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](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) property.
* **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.
* **padding**
**MaybeResponsiveConditionalStyle\>**
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.
* **rows**
**MaybeResponsiveConditionalStyle\**
**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.
* **spacing**
**MaybeResponsiveConditionalStyle\**
**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`.
* **borderRadius**
**MaybeResponsiveConditionalStyle< MaybeShorthandProperty\ >**
**deprecated**
**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.
### ViewLikeAccessibilityRole
```ts
NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]
```
### NonPresentationalAccessibilityRole
```ts
'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert'
```
### MaybeResponsiveConditionalStyle
A type that represents a value that can be a conditional style. The conditions are based on the viewport size. We highly recommend using the \`Style\` helper which simplifies the creation of conditional styles.
```ts
T | ConditionalStyle
```
### ConditionalStyle
A conditional style definition that maps one or more conditions to different values. The \`default\` value is used as a fallback when none of the conditions in \`conditionals\` are satisfied.
* conditionals
An array of conditional values.
```ts
ConditionalValue[]
```
* default
The default value applied when none of the conditional values specified in \`conditionals\` are met.
```ts
T
```
### ConditionalValue
A single conditional branch that pairs a set of conditions with the value to apply when those conditions are met.
* conditions
The conditions that must be met for the value to be applied. At least one condition must be specified.
```ts
AcceptedConditions
```
* value
The value that will be applied if the conditions are met.
```ts
T
```
### ViewportSizeCondition
A condition that targets layouts based on the inline size (width in horizontal writing modes) of the viewport.
* viewportInlineSize
The minimum viewport inline size that the condition must match.
```ts
{ min: T; }
```
### BlockAlignment
Controls how content is aligned along the block axis (vertical in standard writing modes). - \`'start'\`: Aligns content to the block start of the container. - \`'center'\`: Centers content along the block axis. - \`'end'\`: Aligns content to the block end of the container. - \`'baseline'\`: Aligns content so their text baselines line up.
```ts
Alignment | 'baseline'
```
### Alignment
Controls how content is aligned along the cross axis. - \`'start'\`: Aligns content to the start of the container. - \`'center'\`: Centers content within the container. - \`'end'\`: Aligns content to the end of the container.
```ts
'start' | 'center' | 'end'
```
### MaybeShorthandProperty
A type that accepts either a single value applied to all edges or a shorthand tuple for per-edge control. - \`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.
```ts
T | ShorthandProperty
```
### ShorthandProperty
A tuple type that accepts two or four values following the CSS shorthand convention for box 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.
```ts
[T, T] | [T, T, T, T]
```
### BorderStyle
A keyword that maps to a predefined border style from the design system. - \`base\`: A solid border line, suitable for most use cases. - \`dashed\`: A dashed border line, often used for drop zones or placeholder boundaries. - \`dotted\`: A dotted border line. - \`none\`: No border is rendered.
```ts
'base' | 'dashed' | 'dotted' | 'none'
```
### CornerRadius
A keyword that maps to a predefined corner radius from the design system. - \`base\`: The default corner radius. - \`small\`: A subtle corner radius, smaller than \`base\`. - \`large\`: A pronounced corner radius, larger than \`base\`. - \`fullyRounded\`: Fully rounds the corners into a pill or circle shape. - \`none\`: No corner rounding; sharp square corners.
```ts
'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
```
### CornerRadiusDeprecated
```ts
'tight' | 'loose'
```
### BorderWidth
A keyword that maps to a predefined border width from the design system. - \`base\`: The default border width. - \`medium\`: A medium border width, thicker than \`base\`. - \`thick\`: The thickest available border width.
```ts
'base' | 'medium' | 'thick'
```
### InlineAlignment
Controls how content is aligned along the inline axis (horizontal in standard writing modes). - \`'start'\`: Aligns content to the inline start of the container. - \`'center'\`: Centers content along the inline axis. - \`'end'\`: Aligns content to the inline end of the container.
```ts
'start' | 'center' | 'end'
```
### Spacing
A keyword that maps to a predefined spacing value from the design system. Use these instead of pixel values to ensure consistent spacing throughout the UI. - \`none\`: No spacing (0px). - \`extraTight\`: The smallest amount of spacing. - \`tight\`: A compact amount of spacing, suitable for tight layouts. - \`base\`: The default spacing, appropriate for most layouts. - \`loose\`: A generous amount of spacing, used to create visual separation. - \`extraLoose\`: The largest amount of spacing.
```ts
'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'
```
### Rows
```ts
GridItemSize[] | GridItemSize
```
### GridItemSize
```ts
'auto' | 'fill' | number | `${number}fr` | `${number}%`
```
Examples
## Preview
### Examples
* #### Basic BlockLayout
##### React
```tsx
import {
reactExtension,
BlockLayout,
View,
} from '@shopify/ui-extensions-react/customer-account';
export default reactExtension(
'customer-account.page.render',
() => ,
);
function Extension() {
return (
60
fill
);
}
```
##### JS
```js
import {extension, BlockLayout, View} from '@shopify/ui-extensions/customer-account';
export default extension('customer-account.page.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);
});
```
## Accessibility roles
| Value | Description |
| - | - |
| `"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. |
## Related
[Utility - StyleHelper](https://shopify.dev/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper)