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 user interaction. Use this component for creating interactive elements without the default styling that comes with Button and Link.

Anchor to pressablepropsPressableProps

Anchor to display display Default: 'block': Changes the display of the Pressable.

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.
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 disabled disabled boolean: Disables the button, disallowing any interaction
Anchor to id id string: A unique identifier for the Pressable.
Anchor to loading loading boolean: Disables the button while loading. Unlike Button, no indicator is rendered while loading.
Anchor to onPress onPress () => void: Callback that is run when the button or link is pressed.
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 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 blockAlignment blockAlignment < Extract<, 'start' | 'center' | 'end'> >: Position children along the cross axis
Anchor to inlineAlignment inlineAlignment <>: Position children along the main axis
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 border border <<>>: 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
Anchor to borderWidth borderWidth < <> >: 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
Anchor to cornerRadius cornerRadius < <> >: 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.
Anchor to maxBlockSize maxBlockSize < 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.
Anchor to maxInlineSize maxInlineSize < 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.
Anchor to minInlineSize minInlineSize < 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.
Anchor to minBlockSize minBlockSize < 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.
Anchor to padding padding <<>>: 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
Anchor to overlay overlay RemoteFragment: An overlay component to render when the user interacts with the component.
Anchor to toggles toggles string: The component's identifier whose visibility will be toggled when this component is actioned.
Anchor to background background <> Default: 'transparent': Adjust the background.

PressableProps

display
Changes the display of the Pressable. `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.
```
Display
```
accessibilityLabel
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.
```
string
```
accessibilityRole
The role of the button that will be rendered. `button`: renders a regular button. `submit`: renders a button that submits a form.
```
ButtonAccessibilityRole
```
disabled
Disables the button, disallowing any interaction
```
boolean
```
id
A unique identifier for the Pressable.
```
string
```
loading
Disables the button while loading. Unlike `Button`, no indicator is rendered while loading.
```
boolean
```
onPress
Callback that is run when the button or link is pressed.
```
() => void
```
onBlur
Callback that is run when the button or link focus is removed.
```
() => void
```
onFocus
Callback that is run when the button or link is focused.
```
() => void
```
onPointerDown
Callback that is run when a pointing device button is pressed while the pointer is inside the button or link.
```
() => void
```
onPointerEnter
Callback that is run when the pointing device is over (enters) the button or link.
```
() => void
```
onPointerLeave
Callback that is run when the pointing device has left the button or link.
```
() => void
```
onPointerUp
Callback that is run when a pointing device button is released while the pointer is inside the element button or link.
```
() => void
```
to
Destination URL to link to. If this value is set, If this value is set, the component will render an `<a>` tag.
```
string
```

blockAlignment

Position children along the cross axis

MaybeResponsiveConditionalStyle<
    Extract<BlockAlignment, 'start' | 'center' | 'end'>
  >

inlineAlignment
Position children along the main axis
```
MaybeResponsiveConditionalStyle<InlineAlignment>
```
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.
```
Opacity
```
overflow
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.
```
"hidden" | "visible"
```
border
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`
```
MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>
```
borderWidth
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`
```
MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<BorderWidth>
  >
```

borderRadius

MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >

cornerRadius
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.
```
MaybeResponsiveConditionalStyle<
    MaybeShorthandProperty<CornerRadius>
  >
```
maxBlockSize
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).
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
maxInlineSize
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).
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
minInlineSize
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).
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
minBlockSize
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).
```
MaybeResponsiveConditionalStyle<
    number | `${number}%` | 'fill'
  >
```
padding
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`
```
MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>
```
overlay
An overlay component to render when the user interacts with the component.
```
RemoteFragment
```
toggles
The component's identifier whose visibility will be toggled when this component is actioned.
```
string
```
background
Adjust the background.
```
MaybeConditionalStyle<Background>
```

export interface PressableProps
  extends Pick<BackgroundProps, 'background'>,
    BorderProps,
    CornerProps,
    SizingProps,
    SpacingProps,
    OverlayActivatorProps,
    DisclosureActivatorProps {
  /**
   * Changes the display of the Pressable.
   *
   *
   * `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.
   *
   *
   * @defaultValue 'block'
   */
  display?: Display;

  /**
   * 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.
   */
  accessibilityLabel?: string;

  /**
   * The role of the button that will be rendered.
   *
   * `button`: renders a regular button.
   *
   * `submit`: renders a button that submits a form.
   *
   * @defaultValue 'button'
   */
  accessibilityRole?: ButtonAccessibilityRole;

  /**
   * Disables the button, disallowing any interaction
   */
  disabled?: boolean;

  /**
   * A unique identifier for the Pressable.
   */
  id?: string;

  /**
   * Disables the button while loading. Unlike `Button`, no indicator is rendered while loading.
   */
  loading?: boolean;

  /**
   * Callback that is run when the button or link is pressed.
   */
  onPress?: () => void;

  /**
   * Callback that is run when the button or link focus is removed.
   */
  onBlur?: () => void;

  /**
   * Callback that is run when the button or link is focused.
   */
  onFocus?: () => void;

  /**
   * Callback that is run when a pointing device button is pressed while the pointer is inside the button or link.
   */
  onPointerDown?: () => void;

  /**
   * Callback that is run when the pointing device is over (enters) the button or link.
   */
  onPointerEnter?: () => void;

  /**
   *  Callback that is run when the pointing device has left the button or link.
   */
  onPointerLeave?: () => void;

  /**
   * Callback that is run when a pointing device button is released while the pointer is inside the element button or link.
   */
  onPointerUp?: () => void;

  /**
   * Destination URL to link to. If this value is set, If this value is set, the component will render an `<a>` tag.
   */
  to?: string;

  /**
   * Position children along the cross axis
   */
  blockAlignment?: MaybeResponsiveConditionalStyle<
    Extract<BlockAlignment, 'start' | 'center' | 'end'>
  >;

  /**
   * Position children along the main axis
   */
  inlineAlignment?: MaybeResponsiveConditionalStyle<InlineAlignment>;

  /**
   * 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.
   */
  opacity?: Opacity;

  /**
   * 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.
   *
   * @default 'visible'
   */
  overflow?: 'hidden' | 'visible';
}

Display

'block' | 'inline'

ButtonAccessibilityRole

'button' | 'submit'

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. To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.

T | ConditionalStyle<T, ViewportSizeCondition>

ConditionalStyle

default
The default value applied when none of the conditional values specified in `conditionals` are met.
```
T
```
conditionals
An array of conditional values.
```
ConditionalValue<T, AcceptedConditions>[]
```

export interface ConditionalStyle<
  T,
  AcceptedConditions extends BaseConditions = Conditions,
> {
  /**
   * The default value applied when none of the conditional values
   * specified in `conditionals` are met.
   */
  default?: T;
  /**
   * An array of conditional values.
   */
  conditionals: ConditionalValue<T, AcceptedConditions>[];
}

ConditionalValue

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
```

export interface ConditionalValue<
  T,
  AcceptedConditions extends BaseConditions = Conditions,
> {
  /**
   * The conditions that must be met for the value to be applied. At least one
   * condition must be specified.
   */
  conditions: AcceptedConditions;
  /**
   * The value that will be applied if the conditions are met.
   */
  value: T;
}

ViewportSizeCondition

viewportInlineSize
```
{ min: ViewportInlineSize; }
```

export interface ViewportSizeCondition {
  viewportInlineSize: {min: ViewportInlineSize};
}

ViewportInlineSize

'small' | 'medium' | 'large'

BlockAlignment

Alignment | 'baseline'

Alignment

'start' | 'center' | 'end'

InlineAlignment

'start' | 'center' | 'end'

Opacity

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

MaybeShorthandProperty

T | ShorthandProperty<T>

ShorthandProperty

[T, T] | [T, T, T, T]

BorderStyle

'base' | 'dotted' | 'none'

BorderWidth

'base' | 'medium'

CornerRadius

'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated

CornerRadiusDeprecated

'tight' | 'loose'

Spacing

'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'

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. To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.

T | ConditionalStyle<T, AcceptedConditions>

Background

'transparent' | 'base' | 'subdued'

Was this section helpful?

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>

);

}

examples

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

Pressable

Anchor to pressablepropsPressableProps

PressableProps

Display

ButtonAccessibilityRole

MaybeResponsiveConditionalStyle

ConditionalStyle

ConditionalValue

ViewportSizeCondition

ViewportInlineSize

BlockAlignment

Alignment

InlineAlignment

Opacity

MaybeShorthandProperty

ShorthandProperty

BorderStyle

BorderWidth

CornerRadius

CornerRadiusDeprecated

Spacing

MaybeConditionalStyle

Background

examples

Basic Pressable

React

JS

Preview