# 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.
```tsx
import {
reactExtension,
View,
} from '@shopify/ui-extensions-react/checkout';
export default reactExtension(
'purchase.checkout.block.render',
() => ,
);
function Extension() {
return (
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);
});
```
## ViewProps
### ViewProps
### 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.
### accessibilityRole
value: `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: `
`
- In an HTML host a `listItem` string will render: ``
### accessibilityVisibility
value: `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
value: `MaybeConditionalStyle`
Adjust the background.
### blockAlignment
value: `MaybeResponsiveConditionalStyle<
Extract
>`
Position children along the cross axis
### border
value: `MaybeResponsiveConditionalStyle>`
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
>`
### borderWidth
value: `MaybeResponsiveConditionalStyle<
MaybeShorthandProperty
>`
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
value: `MaybeResponsiveConditionalStyle<
MaybeShorthandProperty
>`
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`
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
value: `string`
A unique identifier for the component.
### inlineAlignment
value: `MaybeResponsiveConditionalStyle`
Position children along the main axis
### inlineSize
value: `MaybeResponsiveConditionalStyle<'fill'>`
Adjust the inline size.
`fill`: takes all the available space.
### maxBlockSize
value: `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
value: `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
value: `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
value: `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
value: `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
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>`
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
value: `MaybeResponsiveConditionalStyle`
Changes how the `View` is positioned. When setting `position`, set each axis only once.
``` // Allowed; sets the `block` and `inline` axes once each ```
``` // Allowed; sets the `inline` and `block` axes once each ```
``` // Not allowed; sets the `block` axis twice ```
``` // Not allowed; sets the `inline` axis twice ```
### translate
value: `MaybeResponsiveConditionalStyle`
Specifies a two-dimensional translation of the View.
### visibility
value: `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;
### ConditionalStyle
### conditionals
value: `ConditionalValue[]`
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; }`
### PositionBlockStartInlineStart
### blockEnd
value: `undefined`
### blockStart
value: `Coordinate`
Adjust the block start offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### inlineEnd
value: `undefined`
### inlineStart
value: `Coordinate`
Adjust the inline start offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### type
value: `PositionType`
Changes how the `View` is positioned.
### PositionBlockStartInlineEnd
### blockEnd
value: `undefined`
### blockStart
value: `Coordinate`
Adjust the block start offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### inlineEnd
value: `Coordinate`
Adjust the inline end offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### inlineStart
value: `undefined`
### type
value: `PositionType`
Changes how the `View` is positioned.
### PositionBlockEndInlineStart
### blockEnd
value: `Coordinate`
Adjust the block end offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### blockStart
value: `undefined`
### inlineEnd
value: `undefined`
### inlineStart
value: `Coordinate`
Adjust the inline start offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### type
value: `PositionType`
Changes how the `View` is positioned.
### PositionBlockEndInlineEnd
### blockEnd
value: `Coordinate`
Adjust the block end offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### blockStart
value: `undefined`
### inlineEnd
value: `Coordinate`
Adjust the inline end offset.
`number`: size in pixels.
`` `${number}%` ``: size in percentages. It refers to the block size of the parent component.
### inlineStart
value: `undefined`
### type
value: `PositionType`
Changes how the `View` is positioned.
### Translate
### block
value: `number | `${number}%``
Adjust the translation on the cross axis.
A percentage value refers to the block size of the View.
### inline
value: `number | `${number}%``
Adjust the translation on the main axis.
A percentage value refers to the inline size of the View.
## Related
- [StyleHelper](https://shopify.dev/docs/api/checkout-ui-extensions/2024-10/components/utilities/stylehelper)