# GridItem

GridItem can be used as children of Grid.

It offers a way to span the element across a number of columns and rows.

```tsx
import {
  reactExtension,
  Grid,
  GridItem,
  View,
} from '@shopify/ui-extensions-react/checkout';

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

function Extension() {
  return (
    <Grid
      columns={['20%', 'fill', 'auto']}
      rows={[300, 'auto']}
      spacing="loose"
    >
      <View border="base" padding="base">
        20% / 300
      </View>
      <View border="base" padding="base">
        fill / 300
      </View>
      <View border="base" padding="base">
        auto / 300
      </View>
      <GridItem columnSpan={2}>
        <View border="base" padding="base">
          20% + fill / auto
        </View>
      </GridItem>
      <View border="base" padding="base">
        auto / auto
      </View>
    </Grid>
  );
}

```

```js
import {extension, Grid, GridItem, View} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const grid = root.createComponent(
    Grid,
    {
      columns: ['20%', 'fill', 'auto'],
      rows: [300, 'auto'],
    },
    [
      root.createComponent(
        View,
        {border: 'base', padding: 'base'},
        '20% / 300',
      ),
      root.createComponent(
        View,
        {border: 'base', padding: 'base'},
        'fill / 300',
      ),
      root.createComponent(
        View,
        {border: 'base', padding: 'base'},
        'auto / 300',
      ),
      root.createComponent(GridItem, {columnSpan: 2}, [
        root.createComponent(
          View,
          {border: 'base', padding: 'base'},
          '20% + fill / auto',
        ),
      ]),
      root.createComponent(
        View,
        {border: 'base', padding: 'base'},
        'auto / auto',
      ),
    ],
  );

  root.appendChild(grid);
});

```

## GridItemProps

### GridItemProps

### 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>`

### background

value: `MaybeConditionalStyle<Background>`

  - MaybeConditionalStyle: T | ConditionalStyle<T, AcceptedConditions>
  - 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>[];
}
  - Background: 'transparent' | 'base' | 'subdued'
Adjust the background.

### border

value: `MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>`

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

### borderRadius

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >`

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

### borderWidth

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<BorderWidth>
  >`

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

### columnSpan

value: `MaybeResponsiveConditionalStyle<number>`

  - 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>[];
}
  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
Number of columns the item will span across

### cornerRadius

value: `MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >`

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

### display

value: `MaybeResponsiveConditionalStyle<'auto' | 'none'>`

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

value: `string`

A unique identifier for the component.

### maxBlockSize

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

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

`number`: size in pixels.

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

`fill`: takes all the available space.

See [MDN explanation of maxBlockSize](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).

### maxInlineSize

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

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

`number`: size in pixels.

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

`fill`: takes all the available space.

See [MDN explanation of maxInlineSize](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).

### minBlockSize

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

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

`number`: size in pixels.

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

`fill`: takes all the available space.

See [MDN explanation of minBlockSize](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).

### minInlineSize

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

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

`number`: size in pixels.

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

`fill`: takes all the available space.\

See [MDN explanation of minInlineSize](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).

### 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.

### padding

value: `MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>`

  - 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>[];
}
  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
  - MaybeShorthandProperty: T | ShorthandProperty<T>
  - ShorthandProperty: [T, T] | [T, T, T, T]
  - Spacing: 'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'
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`

### rowSpan

value: `MaybeResponsiveConditionalStyle<number>`

  - 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>[];
}
  - MaybeResponsiveConditionalStyle: T | ConditionalStyle<T, ViewportSizeCondition>
Number of rows the item will span across

### ConditionalStyle

### 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.

### default

value: `T`

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

### 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: T; }`


## Related

- [Grid](grid)
- [StyleHelper](https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/components/utilities/stylehelper)