Choose a version:

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.

Anchor to viewpropsViewProps

Anchor to display display Default: 'block': Changes the display of the View.

inline follows the direction of words in a sentence based on the document’s writing mode.

block follows the direction of paragraphs based on the document’s writing mode.
Anchor to id id string: A unique identifier for the View.
Anchor to 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.
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 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 position position <>: Changes how the View is positioned.
Anchor to translate translate <>: Specifies a two-dimensional translation of the View.
Anchor to blockAlignment blockAlignment < Extract<, 'start' | 'center' | 'end'> >: Position children along the cross axis
Anchor to inlineAlignment inlineAlignment <>: Position children along the main axis
Anchor to inlineSize inlineSize <'fill'>: Adjust the inline size.

fill: takes all the available space.
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, large200, small200] means blockStart padding is base, inlineEnd padding is none, blockEnd padding is large200 and blockStart padding is small200
Anchor to 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;
Anchor to 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.

Display

'block' | 'inline'

Opacity

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

ViewLikeAccessibilityRole

NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]

NonPresentationalAccessibilityRole

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

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

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

ViewportSizeCondition

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

ViewportInlineSize

'small' | 'medium' | 'large'

Position

{
  /**
   * Changes how the View is positioned. For setting the position, only properties
   * that set the offset on a different axis can be set simultaneously. This means
   * that these combinations are not allowed:
   *
   * ```
   * { blockStart, blockEnd }
   * ```
   *
   * ```
   * { inlineStart, inlineEnd }
   * ```
   *
   * @defaultValue 'relative'
   */
  type?: PositionType;
} & PositionCoordinates

PositionType

'absolute' | 'relative' | 'sticky'

PositionCoordinates

({ inlineStart?: Coordinate; blockStart?: Coordinate; } & { inlineEnd?: never; blockEnd?: never; }) | ({ inlineEnd?: Coordinate; blockStart?: Coordinate; } & { ...; }) | ... 5 more ... | ({ ...; } & { ...; })

Coordinate

number | `${number}%`

Translate

block
Adjust the translation on the cross axis. A percentage value refers to the block size of the View.
```
number | `${number}%`
```
inline
Adjust the translation on the main axis. A percentage value refers to the inline size of the View.
```
number | `${number}%`
```

BlockAlignment

Alignment | 'baseline'

Alignment

'start' | 'center' | 'end'

InlineAlignment

'start' | 'center' | 'end'

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'

Spacing

'none' | 'small500' | 'small400' | 'small300' | 'small200' | 'small100' | 'base' | 'large100' | 'large200' | 'large300' | 'large400' | 'large500' | SpacingDeprecated

SpacingDeprecated

'extraTight' | 'tight' | 'loose' | 'extraLoose'

Visibility

'hidden'

AccessibilityVisibility

'hidden'

Examples

import {

reactExtension,

View,

} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(

'purchase.checkout.block.render',

() => <Extension />,

);

function Extension() {

return (

View

</View>

);

}

Preview

Examples

Basic View

React

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

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

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 page helpful?