Choose a version:

BlockLayout

BlockLayout is used to lay out content over multiple rows.

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

Anchor to blocklayoutpropsBlockLayoutProps

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 blockAlignment blockAlignment <>: Position children along the cross axis.
Anchor to inlineAlignment inlineAlignment <>: Position children along the main axis.
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 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 id id string: A unique identifier for the component.
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 border border <<>>: Adjust the border style.

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 < <> >: Adjust the border width.

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 < <> >: Adjust the corner radius.

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 maxBlockSize maxBlockSize < number | `${number}%` | 'fill' >: Adjust the maximum block size.

number: size in pixels.

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

fill: takes all the available space.
Anchor to maxInlineSize maxInlineSize < number | `${number}%` | 'fill' >: Adjust the maximum inline size.

number: size in pixels.

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

fill: takes all the available space.
Anchor to minInlineSize minInlineSize < number | `${number}%` | 'fill' >: Adjust the minimum inline size.

number: size in pixels.

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

fill: takes all the available space.
Anchor to minBlockSize minBlockSize < number | `${number}%` | 'fill' >: Adjust the block size.

number: size in pixels.

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

fill: takes all the available space.
Anchor to padding padding <<>>: Adjust the padding.

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

Examples:

base means blockStart, inlineEnd, blockEnd and inlineStart paddings are base

[base, none] means blockStart and blockEnd paddings are base, inlineStart and inlineEnd paddings are none

[base, none, loose, tight] means blockStart padding is base, inlineEnd padding is none, blockEnd padding is loose and blockStart padding is tight

BlockLayoutProps

rows
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.
```
MaybeResponsiveConditionalStyle<Rows>
```
spacing
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`.
```
MaybeResponsiveConditionalStyle<Spacing | [Spacing, Spacing]>
```
blockAlignment
Position children along the cross axis.
```
MaybeResponsiveConditionalStyle<BlockAlignment>
```
inlineAlignment
Position children along the main axis.
```
MaybeResponsiveConditionalStyle<InlineAlignment>
```
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>`
```
ViewLikeAccessibilityRole
```
accessibilityLabel
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.
```
string
```
id
A unique identifier for the component.
```
string
```
overflow
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.
```
"hidden" | "visible"
```
border
Adjust the border style. 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`
```
MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>
```
borderWidth
Adjust the border width. 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`
```
MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<BorderWidth>
  >
```

borderRadius

MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >

cornerRadius
Adjust the corner radius. 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.
```
MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >
```
maxBlockSize
Adjust the maximum block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
maxInlineSize
Adjust the maximum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
minInlineSize
Adjust the minimum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
minBlockSize
Adjust the block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
padding
Adjust the padding. To shorten the code, it is possible to specify all the padding properties in one property. Examples: - `base` means blockStart, inlineEnd, blockEnd and inlineStart paddings are `base` - [`base`, `none`] means blockStart and blockEnd paddings are `base`, inlineStart and inlineEnd paddings are `none` - [`base`, `none`, `loose`, `tight`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `loose` and blockStart padding is `tight`
```
MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>
```

export interface BlockLayoutProps extends Omit<GridProps, 'columns' | 'rows'> {
  /**
   * 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.
   *
   *
   * @defaultValue 'fill'
   */
  rows?: MaybeResponsiveConditionalStyle<Rows>;
}

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. To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.

T | ConditionalStyle<T, ViewportSizeCondition>

ConditionalStyle

default
The default value applied when none of the conditional values specified in `conditionals` are met.
```
T
```
conditionals
An array of conditional values.
```
ConditionalValue<T, AcceptedConditions>[]
```

export interface ConditionalStyle<
  T,
  AcceptedConditions extends BaseConditions = Conditions,
> {
  /**
   * The default value applied when none of the conditional values
   * specified in `conditionals` are met.
   */
  default?: T;
  /**
   * An array of conditional values.
   */
  conditionals: ConditionalValue<T, AcceptedConditions>[];
}

ConditionalValue

conditions
The conditions that must be met for the value to be applied. At least one condition must be specified.
```
AcceptedConditions
```
value
The value that will be applied if the conditions are met.
```
T
```

export interface ConditionalValue<
  T,
  AcceptedConditions extends BaseConditions = Conditions,
> {
  /**
   * The conditions that must be met for the value to be applied. At least one
   * condition must be specified.
   */
  conditions: AcceptedConditions;
  /**
   * The value that will be applied if the conditions are met.
   */
  value: T;
}

ViewportSizeCondition

viewportInlineSize
```
{ min: ViewportInlineSize; }
```

export interface ViewportSizeCondition {
  viewportInlineSize: {min: ViewportInlineSize};
}

ViewportInlineSize

'small' | 'medium' | 'large'

Rows

GridItemSize[] | GridItemSize

GridItemSize

'auto' | 'fill' | number | `${number}fr` | `${number}%`

Spacing

'none' | 'base' | 'extraTight' | 'tight' | 'loose' | 'extraLoose'

BlockAlignment

Alignment | 'baseline'

Alignment

'start' | 'center' | 'end'

InlineAlignment

'start' | 'center' | 'end'

ViewLikeAccessibilityRole

NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]

NonPresentationalAccessibilityRole

'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert'

MaybeShorthandProperty

T | ShorthandProperty<T>

ShorthandProperty

[T, T] | [T, T, T, T]

BorderStyle

'base' | 'dotted' | 'none'

BorderWidth

'base' | 'medium'

CornerRadius

'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated

CornerRadiusDeprecated

'tight' | 'loose'

Was this section helpful?

Basic BlockLayout

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

render('Checkout::Dynamic::Render', () => <Extension />);

function Extension() {

return (

</View>

fill

</View>

</BlockLayout>

);

}

examples

Basic BlockLayout

React

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

render('Checkout::Dynamic::Render', () => <Extension />);

function Extension() {
  return (
    <BlockLayout rows={[60, 'fill']}>
      <View border="base" padding="base">
        60
      </View>
      <View border="base" padding="base">
        fill
      </View>
    </BlockLayout>
  );
}

JS

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

extend('Checkout::Dynamic::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);
});

Preview

Anchor to accessibility-rolesAccessibility 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.

Was this section helpful?