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

The Pressable component wraps content to make it interactive and pressable. Use it when you need more styling control than Button or Link provide, such as custom backgrounds, padding, or borders around your pressable content.

Pressable shares the same styling properties as View but adds pressable behavior, so you can execute logic in response to user interaction.

Support

Targets (25)

Supported targets

Anchor to PropertiesProperties

Configure the following properties on the Pressable component.

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 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 pressable is activated.

Supported actions by component:

Component Supported Actions Default ('auto')
ClipboardItem 'copy' 'copy'
Anchor to activateTarget activateTarget string: ID of a component that should respond to activations (e.g. clicks) on this pressable.

See activateAction for how to control the behavior of the target.
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: Disables the button, disallowing any interaction
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.
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: Disables the button while loading. Unlike Button, no indicator is rendered while loading.
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: Callback that is run when the button or link focus is removed.
Anchor to onFocus onFocus () => void: Callback that is run when the button or link is focused.
Anchor to onPointerDown onPointerDown () => void: Callback that is run when a pointing device button is pressed while the pointer is inside the button or link.
Anchor to onPointerEnter onPointerEnter () => void: Callback that is run when the pointing device is over (enters) the button or link.
Anchor to onPointerLeave onPointerLeave () => void: Callback that is run when the pointing device has left the button or link.
Anchor to onPointerUp onPointerUp () => void: Callback that is run when a pointing device button is released while the pointer is inside the element button or link.
Anchor to onPress onPress () => void: Callback that is run when the button or link is pressed.
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.
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: Destination URL to link to. If this value is set, If this value is set, the component will render an <a> tag.
Anchor to toggles toggles string: The component's identifier whose visibility will be toggled when this component is actioned.
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 Make a custom interactive areaMake a custom interactive area

Create a custom interactive area with borders and padding. This example shows a Pressable with custom styling containing text and an icon.

Make a custom interactive area

A pressable container with a Details label and chevron icon

Make a custom interactive area

import {

reactExtension,

Icon,

InlineLayout,

Pressable,

Text,

} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(

'customer-account.page.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/customer-account';

export default extension('customer-account.page.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/customer-account';

export default reactExtension(
  'customer-account.page.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/customer-account';

export default extension('customer-account.page.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 Best practicesBest practices

Provide accessibility labels: Set accessibilityLabel when the wrapped content doesn't include visible text that describes the action.
Use for custom layouts only: If a standard button or link meets your needs, prefer those components for consistent styling and accessibility.
Avoid nesting interactive elements: Don't place buttons or links inside a pressable area, as this creates conflicting interaction targets.

Anchor to LimitationsLimitations

No variant or tone props are available. All visual styling must be applied manually through border, background, and padding props.

Was this page helpful?