---
title: GridItem
description: |-
  GridItem can be used as children of Grid.

  It offers a way to span the element across a number of columns and rows.
api_version: 2025-01
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-01/components/structure/griditem
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-01/components/structure/griditem.md
---

# Grid​Item

GridItem can be used as children of Grid.

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

## GridItemProps

* **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: `<li role='separator'>`

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

* **background**

  **MaybeConditionalStyle\<Background>**

  **Default: 'transparent'**

  Adjust the background.

* **border**

  **MaybeResponsiveConditionalStyle\<MaybeShorthandProperty\<BorderStyle>>**

  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**

  **MaybeResponsiveConditionalStyle< MaybeShorthandProperty\<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`

* **columnSpan**

  **MaybeResponsiveConditionalStyle\<number>**

  Number of columns the item will span across

* **cornerRadius**

  **MaybeResponsiveConditionalStyle< MaybeShorthandProperty\<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.

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

* **maxBlockSize**

  **MaybeResponsiveConditionalStyle< number | \`${number}%\` | 'fill' >**

  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**

  **MaybeResponsiveConditionalStyle< number | \`${number}%\` | 'fill' >**

  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**

  **MaybeResponsiveConditionalStyle< number | \`${number}%\` | 'fill' >**

  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**

  **MaybeResponsiveConditionalStyle< number | \`${number}%\` | 'fill' >**

  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**

  **'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\<MaybeShorthandProperty\<Spacing>>**

  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**

  **MaybeResponsiveConditionalStyle\<number>**

  Number of rows the item will span across

### ViewLikeAccessibilityRole

```ts
NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]
```

### NonPresentationalAccessibilityRole

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

### MaybeConditionalStyle

A type that represents a value that can be a conditional style. 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.

```ts
T | ConditionalStyle<T, AcceptedConditions>
```

### ConditionalStyle

* conditionals

  An array of conditional values.

  ```ts
  ConditionalValue<T, AcceptedConditions>[]
  ```

* default

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

  ```ts
  T
  ```

### ConditionalValue

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

### Background

```ts
'transparent' | 'base' | 'subdued'
```

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

```ts
T | ConditionalStyle<T, ViewportSizeCondition>
```

### ViewportSizeCondition

* viewportInlineSize

  ```ts
  { min: T; }
  ```

### MaybeShorthandProperty

```ts
T | ShorthandProperty<T>
```

### ShorthandProperty

```ts
[T, T] | [T, T, T, T]
```

### BorderStyle

```ts
'base' | 'dashed' | 'dotted' | 'none'
```

### BorderWidth

```ts
'base' | 'medium' | 'thick'
```

### CornerRadius

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

### CornerRadiusDeprecated

```ts
'tight' | 'loose'
```

### Spacing

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

Examples

## Preview

![](https://cdn.shopify.com/shopifycloud/shopify-dev/development/assets/assets/images/templated-apis-screenshots/checkout-ui-extensions/2023-04/griditem-default-BfrfedSa.png)

### Examples

* #### Basic GridItem

  ##### React

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

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

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

[Component - Grid](grid)

[Utility - StyleHelper](https://shopify.dev/docs/api/checkout-ui-extensions/2025-01/components/utilities/stylehelper)