Skip to main content

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.

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.

Default: 'button'

The role of the button that will be rendered.

button: renders a regular button.

submit: renders a button that submits a form.

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

ComponentSupported ActionsDefault ('auto')
ClipboardItem'copy''copy'
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.

<>
Default: 'transparent'

Adjust the background.

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

Position children along the cross axis

<<>>

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.

boolean

Disables the button, disallowing any interaction

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

string

A unique identifier for the component.

<>

Position children along the main axis

boolean

Disables the button while loading. Unlike Button, no indicator is rendered while loading.

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

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

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

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

() => void

Callback that is run when the button or link focus is removed.

() => void

Callback that is run when the button or link is focused.

() => void

Callback that is run when a pointing device button is pressed while the pointer is inside the button or link.

() => void

Callback that is run when the pointing device is over (enters) the button or link.

() => void

Callback that is run when the pointing device has left the button or link.

() => void

Callback that is run when a pointing device button is released while the pointer is inside the element button or link.

() => void

Callback that is run when the button or link is pressed.

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.

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

RemoteFragment

An overlay component to render when the user interacts with the component.

<<>>

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

string

Destination URL to link to. If this value is set, If this value is set, the component will render an <a> tag.

string

The component's identifier whose visibility will be toggled when this component is actioned.

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"
>
<InlineLayout columns={['fill', 'auto']}>
<Text>Details</Text>
<Icon source="chevronDown" size="small" />
</InlineLayout>
</Pressable>
);
}

Preview