Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.
Pressable
Pressable is a generic interactive component. It shares the same styling properties as View but also adds pressable behavior, meaning that you can execute some logic in response to buyer interaction. Use this component for creating interactive elements without the default styling that comes with Button and Link.
Supported targets
- Checkout::Actions::Render
Before - Checkout::Cart
Line Details::Render After - Checkout::Cart
Lines::Render After - Checkout::Contact::Render
After - Checkout::Customer
Information::Render After - Checkout::Delivery
Address::Render Before - Checkout::Dynamic::Render
- Checkout::Pickup
Locations::Render After - Checkout::Pickup
Locations::Render Before - Checkout::Pickup
Points::Render After - Checkout::Pickup
Points::Render Before - Checkout::Reductions::Render
After - Checkout::Reductions::Render
Before - Checkout::Shipping
Method Details::Render After - Checkout::Shipping
Method Details::Render Expanded - Checkout::Shipping
Methods::Render After - Checkout::Shipping
Methods::Render Before - Checkout::Thank
You::Cart Line Details::Render After - Checkout::Thank
You::Cart Lines::Render After - Checkout::Thank
You::Customer Information::Render After - Checkout::Thank
You::Dynamic::Render - purchase.
checkout. actions. render-before - purchase.
checkout. block. render - purchase.
checkout. cart-line-item. render-after - purchase.
checkout. cart-line-list. render-after - purchase.
checkout. contact. render-after - purchase.
checkout. delivery-address. render-after - purchase.
checkout. delivery-address. render-before - purchase.
checkout. footer. render-after - purchase.
checkout. header. render-after - purchase.
checkout. payment-method-list. render-after - purchase.
checkout. payment-method-list. render-before - purchase.
checkout. pickup-location-list. render-after - purchase.
checkout. pickup-location-list. render-before - purchase.
checkout. pickup-location-option-item. render-after - purchase.
checkout. pickup-point-list. render-after - purchase.
checkout. pickup-point-list. render-before - purchase.
checkout. reductions. render-after - purchase.
checkout. reductions. render-before - purchase.
checkout. shipping-option-item. details. render - purchase.
checkout. shipping-option-item. render-after - purchase.
checkout. shipping-option-list. render-after - purchase.
checkout. shipping-option-list. render-before - purchase.
thank-you. announcement. render - purchase.
thank-you. block. render - purchase.
thank-you. cart-line-item. render-after - purchase.
thank-you. cart-line-list. render-after - purchase.
thank-you. customer-information. render-after - purchase.
thank-you. footer. render-after - purchase.
thank-you. header. render-after
Supported targets
- Checkout::Actions::Render
Before - Checkout::Cart
Line Details::Render After - Checkout::Cart
Lines::Render After - Checkout::Contact::Render
After - Checkout::Customer
Information::Render After - Checkout::Delivery
Address::Render Before - Checkout::Dynamic::Render
- Checkout::Pickup
Locations::Render After - Checkout::Pickup
Locations::Render Before - Checkout::Pickup
Points::Render After - Checkout::Pickup
Points::Render Before - Checkout::Reductions::Render
After - Checkout::Reductions::Render
Before - Checkout::Shipping
Method Details::Render After - Checkout::Shipping
Method Details::Render Expanded - Checkout::Shipping
Methods::Render After - Checkout::Shipping
Methods::Render Before - Checkout::Thank
You::Cart Line Details::Render After - Checkout::Thank
You::Cart Lines::Render After - Checkout::Thank
You::Customer Information::Render After - Checkout::Thank
You::Dynamic::Render - purchase.
checkout. actions. render-before - purchase.
checkout. block. render - purchase.
checkout. cart-line-item. render-after - purchase.
checkout. cart-line-list. render-after - purchase.
checkout. contact. render-after - purchase.
checkout. delivery-address. render-after - purchase.
checkout. delivery-address. render-before - purchase.
checkout. footer. render-after - purchase.
checkout. header. render-after - purchase.
checkout. payment-method-list. render-after - purchase.
checkout. payment-method-list. render-before - purchase.
checkout. pickup-location-list. render-after - purchase.
checkout. pickup-location-list. render-before - purchase.
checkout. pickup-location-option-item. render-after - purchase.
checkout. pickup-point-list. render-after - purchase.
checkout. pickup-point-list. render-before - purchase.
checkout. reductions. render-after - purchase.
checkout. reductions. render-before - purchase.
checkout. shipping-option-item. details. render - purchase.
checkout. shipping-option-item. render-after - purchase.
checkout. shipping-option-list. render-after - purchase.
checkout. shipping-option-list. render-before - purchase.
thank-you. announcement. render - purchase.
thank-you. block. render - purchase.
thank-you. cart-line-item. render-after - purchase.
thank-you. cart-line-list. render-after - purchase.
thank-you. customer-information. render-after - purchase.
thank-you. footer. render-after - purchase.
thank-you. header. render-after
Anchor to PressablePropsPressable Props
Pressable is a generic interactive component. It shares the same styling properties as View but also adds pressable behavior, meaning that you can execute some logic in response to user interaction. Use this component for creating interactive elements without the default styling that comes with Button and Link.
- Anchor to accessibilityLabelaccessibilityLabelaccessibilityLabelstringstring
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 accessibilityRoleaccessibilityRoleaccessibilityRoleButtonAccessibilityRoleButtonAccessibilityRoleDefault: 'button'Default: 'button'
The role of the button that will be rendered.
button: renders a regular button.submit: renders a button that submits a form.- Anchor to activateActionactivateActionactivateAction'auto' | 'copy''auto' | 'copy'Default: 'auto' - a default action for the target component.Default: 'auto' - a default action for the target component.
- Anchor to activateTargetactivateTargetactivateTargetstringstring
The ID of the component to control when this component is activated. Pair with the
property to specify what action to perform on the target component.- Anchor to backgroundbackgroundbackgroundMaybeConditionalStyle<Background>MaybeConditionalStyle<Background>Default: 'transparent'Default: 'transparent'
The background color of the element, set using a design-system keyword.
transparent: No background; the parent's background shows through.base: The standard surface background color.subdued: A muted background for de-emphasized or secondary content.
- Anchor to blockAlignmentblockAlignmentblockAlignmentMaybeResponsiveConditionalStyle< Extract<BlockAlignment, 'start' | 'center' | 'end'> >MaybeResponsiveConditionalStyle< Extract<BlockAlignment, 'start' | 'center' | 'end'> >
Position children along the cross axis
- Anchor to borderborderborderMaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>
The border style of the element.
To shorten the code, it is possible to specify all the border style properties in one property.
For example:
basemeans blockStart, inlineEnd, blockEnd and inlineStart border styles arebase['base', 'none']means blockStart and blockEnd border styles arebase, inlineStart and inlineEnd border styles arenone['base', 'none', 'dotted', 'base']means blockStart border style isbase, inlineEnd border style isnone, blockEnd border style isdottedand blockStart border style isbase
- Anchor to borderWidthborderWidthborderWidthMaybeResponsiveConditionalStyle< MaybeShorthandProperty<BorderWidth> >MaybeResponsiveConditionalStyle< MaybeShorthandProperty<BorderWidth> >
The border width of the element.
To shorten the code, it is possible to specify all the border width properties in one property.
For example:
basemeans blockStart, inlineEnd, blockEnd and inlineStart border widths arebase['base', 'medium']means blockStart and blockEnd border widths arebase, inlineStart and inlineEnd border widths aremedium['base', 'medium', 'medium', 'base']means blockStart border width isbase, inlineEnd border width ismedium, blockEnd border width ismediumand blockStart border width isbase
- Anchor to cornerRadiuscornerRadiuscornerRadiusMaybeResponsiveConditionalStyle< MaybeShorthandProperty<CornerRadius> >MaybeResponsiveConditionalStyle< MaybeShorthandProperty<CornerRadius> >
The corner radius of the element.
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:
basemeans all 4 corner radii arebase['base', 'none']means the StartStart and EndEnd corner radii arebase, StartEnd and EndStart corner radii arenone. 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 isbase, StartEnd corner radius isnone, EndEnd corner radius issmalland EndStart corner radius isbase
A
alias is available for this property. When both are specified,takes precedence.- Anchor to disableddisableddisabledbooleanboolean
Whether the element is disabled, preventing it from being activated or receiving focus
- Anchor to displaydisplaydisplayMaybeResponsiveConditionalStyle<Display>MaybeResponsiveConditionalStyle<Display>Default: 'auto'Default: 'auto'
Changes the display of the component.
inlinethe component starts on the same line as preceding inline content and allows subsequent content to continue on the same line.blockthe component starts on its own new line and fills its parent.autoresets the component to its initial value. The actual value depends on the component and context.nonehides the component and removes it from the accessibility tree, making it invisible to screen readers.- Anchor to idididstringstring
A unique identifier for the component.
- Anchor to inlineAlignmentinlineAlignmentinlineAlignmentMaybeResponsiveConditionalStyle<InlineAlignment>MaybeResponsiveConditionalStyle<InlineAlignment>
Position children along the main axis
- Anchor to loadingloadingloadingbooleanboolean
Whether the element is in a loading state. Unlike
Button, no loading indicator is rendered.- Anchor to maxBlockSizemaxBlockSizemaxBlockSizeMaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >
The maximum block size (maximum height in horizontal writing modes). The element won't grow taller than this value even if its content is longer.
number: The size in pixels.`${number}%`: The size as a percentage of the parent container's block size.'fill': Takes all the available space.
Learn more about the max-block-size property.
- Anchor to maxInlineSizemaxInlineSizemaxInlineSizeMaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >
The maximum inline size (maximum width in horizontal writing modes). The element won't grow wider than this value.
number: The size in pixels.`${number}%`: The size as a percentage of the parent container's inline size.'fill': Takes all the available space.
Learn more about the max-inline-size property.
- Anchor to minBlockSizeminBlockSizeminBlockSizeMaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >
The minimum block size (minimum height in horizontal writing modes). The element won't shrink smaller than this value even if its content is shorter.
number: The size in pixels.`${number}%`: The size as a percentage of the parent container's block size.'fill': Takes all the available space.
Learn more about the min-block-size property.
- Anchor to minInlineSizeminInlineSizeminInlineSizeMaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >
The minimum inline size (minimum width in horizontal writing modes). The element won't shrink narrower than this value.
number: The size in pixels.`${number}%`: The size as a percentage of the parent container's inline size.'fill': Takes all the available space.
Learn more about the min-inline-size property.
- Anchor to onBluronBluronBlur() => void() => void
A callback fired when the element loses focus.
- Anchor to onFocusonFocusonFocus() => void() => void
A callback fired when the element receives focus.
- Anchor to onPointerDownonPointerDownonPointerDown() => void() => void
A callback fired when a pointing device button is pressed while the pointer is inside the element.
- Anchor to onPointerEnteronPointerEnteronPointerEnter() => void() => void
A callback fired when the pointing device enters the element.
- Anchor to onPointerLeaveonPointerLeaveonPointerLeave() => void() => void
A callback fired when the pointing device leaves the element.
- Anchor to onPointerUponPointerUponPointerUp() => void() => void
A callback fired when a pointing device button is released while the pointer is inside the element.
- Anchor to onPressonPressonPress() => void() => void
A callback fired when the element is activated by the user.
- Anchor to opacityopacityopacityOpacityOpacity
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 overflowoverflowoverflow'hidden' | 'visible''hidden' | 'visible'Default: '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 overlayoverlayoverlayRemoteFragmentRemoteFragment
An overlay component to render when the user interacts with the component.
- Anchor to paddingpaddingpaddingMaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>
The padding on all edges of the element, using a shorthand syntax. You can specify one, two, or four values following the CSS shorthand convention.
T: A single value applied uniformly to all edges.[T, T]: The first value applies to block-start and block-end, the second to inline-start and inline-end.[T, T, T, T]: Values apply to block-start, inline-end, block-end, and inline-start respectively.
- Anchor to tototostringstring
The URL to navigate to when the element is activated. When set, the component renders as an anchor element.
- Anchor to togglestogglestogglesstringstring
The component's identifier whose visibility will be toggled when this component is actioned.
- Anchor to borderRadiusborderRadiusborderRadiusMaybeResponsiveConditionalStyle< MaybeShorthandProperty<CornerRadius> >MaybeResponsiveConditionalStyle< MaybeShorthandProperty<CornerRadius> >deprecateddeprecated
- Deprecated
Use
instead.The corner radius of the element. Accepts a single value for all corners or a shorthand tuple for per-corner control.
Deprecated:Use
instead.The corner radius of the element. Accepts a single value for all corners or a shorthand tuple for per-corner control.
ButtonAccessibilityRole
'button' | 'submit'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.
T | ConditionalStyle<T, AcceptedConditions>ConditionalStyle
A conditional style definition that maps one or more conditions to different values. The `default` value is used as a fallback when none of the conditions in `conditionals` are satisfied.
- conditionals
An array of conditional values.
ConditionalValue<T, AcceptedConditions>[] - default
The default value applied when none of the conditional values specified in `conditionals` are met.
T
ConditionalValue
A single conditional branch that pairs a set of conditions with the value to apply when those conditions are met.
- 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
Background
A keyword that maps to a predefined background color from the design system. - `transparent`: No background color; the parent's background shows through. - `base`: The standard surface background color. - `subdued`: A muted background color, typically used to de-emphasize content or distinguish secondary areas from the primary surface.
'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.
T | ConditionalStyle<T, ViewportSizeCondition>ViewportSizeCondition
A condition that targets layouts based on the inline size (width in horizontal writing modes) of the viewport.
- viewportInlineSize
The minimum viewport inline size that the condition must match.
{ min: T; }
BlockAlignment
Controls how content is aligned along the block axis (vertical in standard writing modes). - `'start'`: Aligns content to the block start of the container. - `'center'`: Centers content along the block axis. - `'end'`: Aligns content to the block end of the container. - `'baseline'`: Aligns content so their text baselines line up.
Alignment | 'baseline'Alignment
Controls how content is aligned along the cross axis. - `'start'`: Aligns content to the start of the container. - `'center'`: Centers content within the container. - `'end'`: Aligns content to the end of the container.
'start' | 'center' | 'end'MaybeShorthandProperty
A type that accepts either a single value applied to all edges or a shorthand tuple for per-edge control. - `T`: A single value applied uniformly to all edges. - `[T, T]`: The first value applies to block-start and block-end, the second to inline-start and inline-end. - `[T, T, T, T]`: Values apply to block-start, inline-end, block-end, and inline-start respectively.
T | ShorthandProperty<T>ShorthandProperty
A tuple type that accepts two or four values following the CSS shorthand convention for box edges. - `[T, T]`: The first value applies to block-start and block-end, the second to inline-start and inline-end. - `[T, T, T, T]`: Values apply to block-start, inline-end, block-end, and inline-start respectively.
[T, T] | [T, T, T, T]BorderStyle
A keyword that maps to a predefined border style from the design system. - `base`: A solid border line, suitable for most use cases. - `dashed`: A dashed border line, often used for drop zones or placeholder boundaries. - `dotted`: A dotted border line. - `none`: No border is rendered.
'base' | 'dashed' | 'dotted' | 'none'CornerRadius
A keyword that maps to a predefined corner radius from the design system. - `base`: The default corner radius. - `small`: A subtle corner radius, smaller than `base`. - `large`: A pronounced corner radius, larger than `base`. - `fullyRounded`: Fully rounds the corners into a pill or circle shape. - `none`: No corner rounding; sharp square corners.
'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecatedCornerRadiusDeprecated
'tight' | 'loose'BorderWidth
A keyword that maps to a predefined border width from the design system. - `base`: The default border width. - `medium`: A medium border width, thicker than `base`. - `thick`: The thickest available border width.
'base' | 'medium' | 'thick'Display
'none' | 'auto' | 'inline' | 'block'InlineAlignment
Controls how content is aligned along the inline axis (horizontal in standard writing modes). - `'start'`: Aligns content to the inline start of the container. - `'center'`: Centers content along the inline axis. - `'end'`: Aligns content to the inline end of the container.
'start' | 'center' | 'end'Opacity
10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90Spacing
A keyword that maps to a predefined spacing value from the design system. Use these instead of pixel values to ensure consistent spacing throughout the UI. - `none`: No spacing (0px). - `extraTight`: The smallest amount of spacing. - `tight`: A compact amount of spacing, suitable for tight layouts. - `base`: The default spacing, appropriate for most layouts. - `loose`: A generous amount of spacing, used to create visual separation. - `extraLoose`: The largest amount of spacing.
'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'Anchor to ExamplesExamples
Anchor to Basic PressableBasic Pressable
Basic Pressable

Basic Pressable
React
import {
reactExtension,
Icon,
InlineLayout,
Pressable,
Text,
} from '@shopify/ui-extensions-react/checkout';
export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);
function Extension() {
return (
<Pressable
border="base"
cornerRadius="base"
padding="base"
>
<InlineLayout columns={['fill', 'auto']}>
<Text>Details</Text>
<Icon source="chevronDown" size="small" />
</InlineLayout>
</Pressable>
);
}JS
import {
extension,
Icon,
InlineLayout,
Pressable,
Text,
} from '@shopify/ui-extensions/checkout';
export default extension('purchase.checkout.block.render', (root) => {
const pressable = root.createComponent(
Pressable,
{
border: 'base',
cornerRadius: 'base',
padding: 'base',
onPress: () => console.log('onPress event'),
},
[
root.createComponent(InlineLayout, {columns: ['fill', 'auto']}, [
root.createComponent(Text, {}, 'Details'),
root.createComponent(Icon, {source: 'chevronDown', size: 'small'}),
]),
],
);
root.appendChild(pressable);
});