---
title: View
description: >-
  View is a generic container component. Its contents will always be their
  “natural” size, so this component can be useful in layout components (like
  `Grid`, `BlockStack`, `InlineStack`) that would otherwise stretch their
  children to fit.
api_version: 2025-01
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-01/components/structure/view
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-01/components/structure/view.md
---

# View

View is a generic container component. Its contents will always be their “natural” size, so this component can be useful in layout components (like `Grid`, `BlockStack`, `InlineStack`) that would otherwise stretch their children to fit.

## ViewProps

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

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

* accessibilityVisibility

  AccessibilityVisibility

  Changes the visibility of the element to assistive technologies.

  `hidden` hides the component from assistive technology (for example, a screen reader) but remains visually visible.

* background

  MaybeConditionalStyle\<Background>

  Default: 'transparent'

  Adjust the background.

* blockAlignment

  MaybeResponsiveConditionalStyle< Extract\<BlockAlignment, 'start' | 'center' | 'end'> >

  Position children along the cross axis

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

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

  Default: 'auto'

  Changes the display of the component.

  `inline` the component starts on the same line as preceding inline content and allows subsequent content to continue on the same line.

  `block` the component starts on its own new line and fills its parent.

  `auto` resets the component to its 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\<InlineAlignment>

  Position children along the main axis

* inlineSize

  MaybeResponsiveConditionalStyle<'fill'>

  Adjust the inline size.

  `fill`: takes all the available space.

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

* opacity

  Opacity

  Sets the opacity of the View. The opacity will be applied to the background as well as all the children of the View. Use carefully as this could decrease the contrast ratio between the background and foreground elements, resulting in unreadable and inaccessible text.

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

* position

  MaybeResponsiveConditionalStyle\<Position>

  Changes how the `View` is positioned. When setting `position`, set each axis only once.

  ``<View position={{blockStart, inlineEnd}} /> // Allowed; sets the `block` and `inline` axes once each``

  ``<View position={{inlineStart, blockEnd}} /> // Allowed; sets the `inline` and `block` axes once each``

  ``<View position={{blockStart, blockEnd}} /> // Not allowed; sets the `block` axis twice``

  ``<View position={{inlineStart, inlineEnd}} /> // Not allowed; sets the `inline` axis twice``

* translate

  MaybeResponsiveConditionalStyle\<Translate>

  Specifies a two-dimensional translation of the View.

* visibility

  Visibility

  Changes the visibility of the element.

  `hidden` visually hides the component while keeping it accessible to assistive technology, such as screen readers. Hidden elements don't take any visual space contrary to CSS visibility: hidden;

### ViewLikeAccessibilityRole

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

### NonPresentationalAccessibilityRole

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

### AccessibilityVisibility

```ts
'hidden'
```

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

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

  ```ts
  AcceptedConditions
  ```

* value

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

  ```ts
  T
  ```

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

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

```ts
export interface ViewportSizeCondition<T = ViewportInlineSize> {
  viewportInlineSize: {min: T};
}
```

### BlockAlignment

```ts
Alignment | 'baseline'
```

### Alignment

```ts
'start' | 'center' | 'end'
```

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

### Display

```ts
'none' | 'auto' | 'inline' | 'block'
```

### InlineAlignment

```ts
'start' | 'center' | 'end'
```

### Opacity

```ts
10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90
```

### Spacing

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

### Position

```ts
PositionBlockStartInlineStart | PositionBlockStartInlineEnd | PositionBlockEndInlineStart | PositionBlockEndInlineEnd
```

### PositionBlockStartInlineStart

* blockEnd

  ```ts
  undefined
  ```

* blockStart

  Adjust the block start offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* inlineEnd

  ```ts
  undefined
  ```

* inlineStart

  Adjust the inline start offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* type

  Changes how the \`View\` is positioned.

  ```ts
  PositionType
  ```

```ts
interface PositionBlockStartInlineStart
  extends PositionBlockStart,
    PositionInlineStart,
    PositionTypeProperty {
  blockEnd?: undefined;
  inlineEnd?: undefined;
}
```

### Coordinate

```ts
number | `${number}%`
```

### PositionType

```ts
'absolute' | 'relative' | 'sticky'
```

### PositionBlockStartInlineEnd

* blockEnd

  ```ts
  undefined
  ```

* blockStart

  Adjust the block start offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* inlineEnd

  Adjust the inline end offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* inlineStart

  ```ts
  undefined
  ```

* type

  Changes how the \`View\` is positioned.

  ```ts
  PositionType
  ```

```ts
interface PositionBlockStartInlineEnd
  extends PositionBlockStart,
    PositionInlineEnd,
    PositionTypeProperty {
  blockEnd?: undefined;
  inlineStart?: undefined;
}
```

### PositionBlockEndInlineStart

* blockEnd

  Adjust the block end offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* blockStart

  ```ts
  undefined
  ```

* inlineEnd

  ```ts
  undefined
  ```

* inlineStart

  Adjust the inline start offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* type

  Changes how the \`View\` is positioned.

  ```ts
  PositionType
  ```

```ts
interface PositionBlockEndInlineStart
  extends PositionBlockEnd,
    PositionInlineStart,
    PositionTypeProperty {
  blockStart?: undefined;
  inlineEnd?: undefined;
}
```

### PositionBlockEndInlineEnd

* blockEnd

  Adjust the block end offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* blockStart

  ```ts
  undefined
  ```

* inlineEnd

  Adjust the inline end offset. \`number\`: size in pixels. \`\` \`${number}%\` \`\`: size in percentages. It refers to the block size of the parent component.

  ```ts
  Coordinate
  ```

* inlineStart

  ```ts
  undefined
  ```

* type

  Changes how the \`View\` is positioned.

  ```ts
  PositionType
  ```

```ts
interface PositionBlockEndInlineEnd
  extends PositionBlockEnd,
    PositionInlineEnd,
    PositionTypeProperty {
  blockStart?: undefined;
  inlineStart?: undefined;
}
```

### Translate

* block

  Adjust the translation on the cross axis. A percentage value refers to the block size of the View.

  ```ts
  number | `${number}%`
  ```

* inline

  Adjust the translation on the main axis. A percentage value refers to the inline size of the View.

  ```ts
  number | `${number}%`
  ```

```ts
export interface Translate {
  /**
   * Adjust the translation on the cross axis.
   *
   * A percentage value refers to the block size of the View.
   */
  block?: number | `${number}%`;
  /**
   * Adjust the translation on the main axis.
   *
   * A percentage value refers to the inline size of the View.
   */
  inline?: number | `${number}%`;
}
```

### Visibility

```ts
'hidden'
```

### Examples

* #### Basic View

  ##### React

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

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

  function Extension() {
    return (
      <View padding="base" border="base">
        View
      </View>
    );
  }
  ```

  ##### JS

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

  export default extension('purchase.checkout.block.render', (root) => {
    const view = root.createComponent(
      View,
      {border: 'base', padding: 'base'},
      'View',
    );

    root.appendChild(view);
  });
  ```

## Preview

![](https://shopify.dev/images/templated-apis-screenshots/checkout-ui-extensions/2025-01/view-default.png)

## 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/2025-01/components/utilities/stylehelper)