Migrate to Polaris

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.

Choose a version:

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.

Support

Targets (50)

Supported targets

Checkout::Actions::RenderBefore
Checkout::CartLineDetails::RenderAfter
Checkout::CartLines::RenderAfter
Checkout::Contact::RenderAfter
Checkout::CustomerInformation::RenderAfter
Checkout::DeliveryAddress::RenderBefore
Checkout::Dynamic::Render
Checkout::PickupLocations::RenderAfter
Checkout::PickupLocations::RenderBefore
Checkout::PickupPoints::RenderAfter
Checkout::PickupPoints::RenderBefore
Checkout::Reductions::RenderAfter
Checkout::Reductions::RenderBefore
Checkout::ShippingMethodDetails::RenderAfter
Checkout::ShippingMethodDetails::RenderExpanded
Checkout::ShippingMethods::RenderAfter
Checkout::ShippingMethods::RenderBefore
Checkout::ThankYou::CartLineDetails::RenderAfter
Checkout::ThankYou::CartLines::RenderAfter
Checkout::ThankYou::CustomerInformation::RenderAfter
Checkout::ThankYou::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 PressablePropsPressableProps

Anchor to accessibilityLabel accessibilityLabel string: A label that describes the purpose or content of the element for users of assistive technologies such as screen readers. When set, it provides additional context beyond the visible content.
Anchor to accessibilityRole accessibilityRole 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 activateAction activateAction 'auto' | 'copy' Default: 'auto' - a default action for the target component.: Sets the action the activateTarget should take when this component is activated.

Supported actions by component:

Component Supported Actions Default ('auto')
ClipboardItem 'copy' 'copy'
Anchor to activateTarget activateTarget string: The ID of the component to control when this component is activated. Pair with the activateAction property to specify what action to perform on the target component.
Anchor to background background <> Default: 'transparent': The background color of the element, set using a design-system keyword.
Anchor to blockAlignment blockAlignment < Extract<, 'start' | 'center' | 'end'> >: Position children along the cross axis
Anchor to border border <<>>: The border style of the element. Accepts a single value for all four edges, or a shorthand tuple for per-edge control:

'base': Applies base to all edges.

['base', 'none']: Block edges get base, inline edges get none.

['base', 'none', 'dotted', 'base']: Values apply to block-start, inline-end, block-end, and inline-start respectively.
Anchor to borderWidth borderWidth < <> >: The border width of the element. Accepts a single value for all four edges, or a shorthand tuple for per-edge control:

'base': Applies base to all edges.

['base', 'medium']: Block edges get base, inline edges get medium.

['base', 'medium', 'medium', 'base']: Values apply to block-start, inline-end, block-end, and inline-start respectively.
Anchor to cornerRadius cornerRadius < <> >: The corner radius of the element. Accepts a single value for all four corners, or a shorthand tuple for per-corner control using logical (writing-mode-aware) corners:

'base': All four corners get base radius.

['base', 'none']: StartStart/EndEnd get base, StartEnd/EndStart get none. In left-to-right mode, StartStart and EndEnd are the top-left and bottom-right corners.

['base', 'none', 'small', 'base']: Values apply to StartStart, StartEnd, EndEnd, and EndStart respectively.

A borderRadius alias is available. When both are set, cornerRadius takes precedence.
Anchor to disabled disabled boolean: Whether the element is disabled, preventing it from being activated or receiving focus.
Anchor to display 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.

Learn more about the display property.
Anchor to id id string: A unique identifier for the component. Use this to target the component in scripts or stylesheets, or to distinguish it from other instances of the same component.
Anchor to inlineAlignment inlineAlignment <>: Position children along the main axis
Anchor to loading loading boolean: Whether the element is in a loading state. Unlike Button, no loading indicator is rendered.
Anchor to maxBlockSize maxBlockSize < 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 maxInlineSize maxInlineSize < 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 minBlockSize minBlockSize < 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 minInlineSize minInlineSize < 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 onBlur onBlur () => void: A callback fired when the element loses focus.
Anchor to onFocus onFocus () => void: A callback fired when the element receives focus.
Anchor to onPointerDown onPointerDown () => void: A callback fired when a pointing device button is pressed while the pointer is inside the element.
Anchor to onPointerEnter onPointerEnter () => void: A callback fired when the pointing device enters the element.
Anchor to onPointerLeave onPointerLeave () => void: A callback fired when the pointing device leaves the element.
Anchor to onPointerUp onPointerUp () => void: A callback fired when a pointing device button is released while the pointer is inside the element.
Anchor to onPress onPress () => void: A callback fired when the element is activated by the user.
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 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 overlay overlay RemoteFragment: An overlay component to render when the user interacts with the component, such as a popover, modal, or tooltip.
Anchor to padding padding <<>>: 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 to to string: The URL to navigate to when the element is activated. When set, the component renders as an anchor element.
Anchor to toggles toggles string: The ID of the component whose visibility will be toggled when this component is activated. Use this to show or hide related content like a disclosure panel.
Anchor to borderRadius borderRadius < <> >: The corner radius of the element. Accepts a single value for all four corners, or a shorthand tuple for per-corner control:

'base': All four corners get base radius.

['base', 'none']: StartStart/EndEnd get base, StartEnd/EndStart get none.

['base', 'none', 'small', 'base']: Values apply to StartStart, StartEnd, EndEnd, and EndStart respectively.

Deprecated
Use cornerRadius instead.

Component	Supported Actions	Default ('auto')
`ClipboardItem`	'copy'	'copy'

ButtonAccessibilityRole

The accessibility role for button-like components. - `button`: A generic button that triggers an action. - `submit`: A button that submits a form.

'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' | CornerRadiusDeprecated

CornerRadiusDeprecated

'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

The display mode for a component. Learn more about [`display`](https://developer.mozilla.org/en-US/docs/Web/CSS/display). - `auto`: The initial value; the actual behavior depends on the component and context. - `block`: The component starts on its own new line and fills its parent. - `inline`: The component flows inline with preceding and subsequent content. - `none`: Hides the component and removes it from the accessibility tree.

'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

A percentage-based opacity value from 10 (nearly transparent) to 90 (nearly opaque). Use carefully as reduced opacity can decrease contrast ratios, making text difficult to read.

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

Spacing

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

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"

<Text>Details</Text>

</InlineLayout>

</Pressable>

);

}

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

});

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

Anchor to RelatedRelated

UtilityStyleHelper

Was this page helpful?