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.
import {render, View} from '@shopify/checkout-ui-extensions-react';
render('Checkout::Dynamic::Render', () =>
View
);
}
import {extend, View} from '@shopify/checkout-ui-extensions';
extend('Checkout::Dynamic::Render', (root) => {
const view = root.createComponent(
View,
{border: 'base', padding: 'base'},
'View',
);
root.appendChild(view);
});
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.
A unique identifier for the View.
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.
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.
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>`
Changes how the View is positioned.
Specifies a two-dimensional translation of the View.
Position children along the cross axis
Position children along the main axis
Adjust the inline size. `fill`: takes all the available space.
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.
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`
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`
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.
Adjust the maximum block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
Adjust the maximum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
Adjust the minimum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
Adjust the block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.
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`
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;
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.
'block' | 'inline'
10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90
NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]
'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert'
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>
The default value applied when none of the conditional values specified in `conditionals` are met.
An array of conditional values.
The conditions that must be met for the value to be applied. At least one condition must be specified.
The value that will be applied if the conditions are met.
'small' | 'medium' | 'large'
{ /** * 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
'absolute' | 'relative' | 'sticky'
({ inlineStart?: Coordinate; blockStart?: Coordinate; } & { inlineEnd?: never; blockEnd?: never; }) | ({ inlineEnd?: Coordinate; blockStart?: Coordinate; } & { ...; }) | ... 5 more ... | ({ ...; } & { ...; })
number | `${number}%`
Adjust the translation on the cross axis. A percentage value refers to the block size of the View.
Adjust the translation on the main axis. A percentage value refers to the inline size of the View.
Alignment | 'baseline'
'start' | 'center' | 'end'
'start' | 'center' | 'end'
T | ShorthandProperty<T>
[T, T] | [T, T, T, T]
'base' | 'dotted' | 'none'
'base' | 'medium'
'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
'tight' | 'loose'
'none' | 'base' | 'extraTight' | 'tight' | 'loose' | 'extraLoose'
'hidden'
'hidden'