# BlockLayout

BlockLayout is used to lay out content over multiple rows.

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

```tsx
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>
  );
}

```

```js
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);
});

```

## BlockLayoutProps

### BlockLayoutProps

### rows

value: `MaybeResponsiveConditionalStyle<Rows>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - Rows: GridItemSize[] | GridItemSize
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

value: `MaybeResponsiveConditionalStyle<Spacing | [Spacing, Spacing]>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - Spacing: 'none' | 'small500' | 'small400' | 'small300' | 'small200' | 'small100' | 'base' | 'large100' | 'large200' | 'large300' | 'large400' | 'large500' | SpacingDeprecated
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`.

### blockAlignment

value: `MaybeResponsiveConditionalStyle<BlockAlignment>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - BlockAlignment: Alignment | 'baseline'
  - Alignment: 'start' | 'center' | 'end'
Position children along the cross axis.

### inlineAlignment

value: `MaybeResponsiveConditionalStyle<InlineAlignment>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - Alignment: 'start' | 'center' | 'end'
  - InlineAlignment: 'start' | 'center' | 'end'
Position children along the main axis.

### accessibilityRole

value: `ViewLikeAccessibilityRole`

  - ViewLikeAccessibilityRole: NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]
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>`

### accessibilityLabel

value: `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.

### id

value: `string`

A unique identifier for the component.

### overflow

value: `"hidden" | "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.

### border

value: `MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
  - BorderStyle: 'base' | 'dotted' | 'none'
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`

### borderWidth

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<BorderWidth>
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
  - BorderWidth: 'base' | 'medium'
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`

### borderRadius

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
  - CornerRadius: 'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated

### cornerRadius

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
  - CornerRadius: 'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
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.

### maxBlockSize

value: `MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
Adjust the maximum block size.

`number`: size in pixels.

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

`fill`: takes all the available space.

### maxInlineSize

value: `MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
Adjust the maximum inline size.

`number`: size in pixels.

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

`fill`: takes all the available space.

### minInlineSize

value: `MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
Adjust the minimum inline size.

`number`: size in pixels.

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

`fill`: takes all the available space.

### minBlockSize

value: `MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
Adjust the block size.

`number`: size in pixels.

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

`fill`: takes all the available space.

### padding

value: `MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>`

  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - ConditionalStyle: 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>[];
}
  - Spacing: 'none' | 'small500' | 'small400' | 'small300' | 'small200' | 'small100' | 'base' | 'large100' | 'large200' | 'large300' | 'large400' | 'large500' | SpacingDeprecated
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
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`, `large200`, `small200`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `large200` and  blockStart padding is `small200`

### ConditionalStyle

### default

value: `T`

The default value applied when none of the conditional values
specified in `conditionals` are met.

### conditionals

value: `ConditionalValue<T, AcceptedConditions>[]`

  - ConditionalValue: 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;
}
An array of conditional values.

### ConditionalValue

### conditions

value: `AcceptedConditions`

The conditions that must be met for the value to be applied. At least one
condition must be specified.

### value

value: `T`

The value that will be applied if the conditions are met.

### ViewportSizeCondition

### viewportInlineSize

value: `{ min: ViewportInlineSize; }`

  - ViewportInlineSize: 'small' | 'medium' | 'large'