# 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`.
```tsx
import {
reactExtension,
Icon,
InlineLayout,
Pressable,
Text,
} from '@shopify/ui-extensions-react/checkout';
export default reactExtension(
'purchase.checkout.block.render',
() => ,
);
function Extension() {
return (
Details
);
}
```
```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);
});
```
## PressableProps
### PressableProps
### accessibilityLabel
value: `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.
### accessibilityRole
value: `ButtonAccessibilityRole`
- ButtonAccessibilityRole: 'button' | 'submit'
The role of the button that will be rendered.
`button`: renders a regular button.
`submit`: renders a button that submits a form.
### activateAction
value: `'auto' | 'copy'`
Sets the action the `activateTarget` should take when this pressable is activated.
Supported actions by component:
| Component | Supported Actions | Default ('auto') |
|---------------|-------------------|-------------------|
| [`ClipboardItem`](https://shopify.dev/docs/api/checkout-ui-extensions/latest/clipboarditem) | 'copy' | 'copy' |
### activateTarget
value: `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.
### background
value: `MaybeConditionalStyle`
- MaybeConditionalStyle: T | ConditionalStyle
- ConditionalStyle: 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[];
}
- Background: 'transparent' | 'base' | 'subdued'
Adjust the background.
### blockAlignment
value: `MaybeResponsiveConditionalStyle<
Extract
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- BlockAlignment: Alignment | 'baseline'
- Alignment: 'start' | 'center' | 'end'
Position children along the cross axis
### border
value: `MaybeResponsiveConditionalStyle>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- MaybeShorthandProperty: T | ShorthandProperty
- ShorthandProperty: [T, T] | [T, T, T, T]
- BorderStyle: 'base' | 'dashed' | 'dotted' | 'none'
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`
### borderRadius
value: `MaybeResponsiveConditionalStyle<
MaybeShorthandProperty
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- MaybeShorthandProperty: T | ShorthandProperty
- ShorthandProperty: [T, T] | [T, T, T, T]
- CornerRadius: 'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
### borderWidth
value: `MaybeResponsiveConditionalStyle<
MaybeShorthandProperty
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- MaybeShorthandProperty: T | ShorthandProperty
- ShorthandProperty: [T, T] | [T, T, T, T]
- BorderWidth: 'base' | 'medium' | 'thick'
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`
### cornerRadius
value: `MaybeResponsiveConditionalStyle<
MaybeShorthandProperty
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- MaybeShorthandProperty: T | ShorthandProperty
- ShorthandProperty: [T, T] | [T, T, T, T]
- CornerRadius: 'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
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.
### disabled
value: `boolean`
Disables the button, disallowing any interaction
### display
value: `MaybeResponsiveConditionalStyle`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- Display: 'none' | 'auto' | 'inline' | 'block'
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.
### id
value: `string`
A unique identifier for the component.
### inlineAlignment
value: `MaybeResponsiveConditionalStyle`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- Alignment: 'start' | 'center' | 'end'
- InlineAlignment: 'start' | 'center' | 'end'
Position children along the main axis
### loading
value: `boolean`
Disables the button while loading. Unlike `Button`, no indicator is rendered while loading.
### maxBlockSize
value: `MaybeResponsiveConditionalStyle<
number | `${number}%` | 'fill'
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
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).
### maxInlineSize
value: `MaybeResponsiveConditionalStyle<
number | `${number}%` | 'fill'
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
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).
### minBlockSize
value: `MaybeResponsiveConditionalStyle<
number | `${number}%` | 'fill'
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
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).
### minInlineSize
value: `MaybeResponsiveConditionalStyle<
number | `${number}%` | 'fill'
>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
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).
### onBlur
value: `() => void`
Callback that is run when the button or link focus is removed.
### onFocus
value: `() => void`
Callback that is run when the button or link is focused.
### onPointerDown
value: `() => void`
Callback that is run when a pointing device button is pressed while the pointer is inside the button or link.
### onPointerEnter
value: `() => void`
Callback that is run when the pointing device is over (enters) the button or link.
### onPointerLeave
value: `() => void`
Callback that is run when the pointing device has left the button or link.
### onPointerUp
value: `() => void`
Callback that is run when a pointing device button is released while the pointer is inside the element button or link.
### onPress
value: `() => void`
Callback that is run when the button or link is pressed.
### opacity
value: `Opacity`
- Opacity: 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90
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.
### overflow
value: `'hidden' | '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.
### overlay
value: `RemoteFragment`
An overlay component to render when the user interacts with the component.
### padding
value: `MaybeResponsiveConditionalStyle>`
- ConditionalStyle: 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[];
}
- MaybeResponsiveConditionalStyle: T | ConditionalStyle
- MaybeShorthandProperty: T | ShorthandProperty
- ShorthandProperty: [T, T] | [T, T, T, T]
- Spacing: 'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'
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`
### to
value: `string`
Destination URL to link to. If this value is set, If this value is set, the component will render an `` tag.
### toggles
value: `string`
The component's identifier whose visibility will be toggled when this component is actioned.
### ConditionalStyle
### conditionals
value: `ConditionalValue[]`
- ConditionalValue: 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;
}
An array of conditional values.
### default
value: `T`
The default value applied when none of the conditional values specified in `conditionals` are met.
### ConditionalValue
### conditions
value: `AcceptedConditions`
The conditions that must be met for the value to be applied. At least one condition must be specified.
### value
value: `T`
The value that will be applied if the conditions are met.
### ViewportSizeCondition
### viewportInlineSize
value: `{ min: T; }`
## Related
- [StyleHelper](https://shopify.dev/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper)