Pressable

Use this component when you need to capture click or press events on its child elements without adding any additional visual styling. It subtly enhances user interaction by changing the cursor when hovering over the child elements, providing a clear indication of interactivity.

import {
  reactExtension,
  Icon,
  InlineStack,
  Pressable,
  Text,
} from '@shopify/ui-extensions-react/admin';

reactExtension('Playground', () => <Extension />);

function Extension() {
  return (
    <Pressable padding="base">
      <InlineStack>
        <Text>Go to Apps Dashboard</Text>
        <Icon name="AppsMajor" />
      </InlineStack>
    </Pressable>
  );
}

import {
  extension,
  Icon,
  InlineStack,
  Pressable,
  Text,
} from '@shopify/ui-extensions/admin';

extension('Playground', (root) => {
  const pressable = root.createComponent(
    Pressable,
    {
      padding: 'base',
      onPress: () => console.log('onPress event'),
    },
    [
      root.createComponent(InlineStack, {}, [
        root.createComponent(Text, {}, 'Go to App Dashboard'),
        root.createComponent(Icon, {name: 'AppsMajor'}),
      ]),
    ],
  );

  root.appendChild(pressable);
});

PressableProps

PressableProps

accessibilityLabel

A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. When set, any children or `label` supplied will not be announced to screen readers.

accessibilityRole

Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.

blockSize

Adjust the block size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

display

The display property sets the display behavior of an element.

href

The URL to link to. If set, it will navigate to the location specified by `href` after executing the `onClick` callback.

id

A unique identifier for the link.

inlineSize

Adjust the inline size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

lang

Alias for `language`

language

Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)

maxBlockSize

Adjust the maximum block size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

maxInlineSize

Adjust the maximum inline size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

minBlockSize

Adjust the minimum block size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

minInlineSize

Adjust the minimum inline size. - `number`: size in pixels. - `` `${number}%` ``: size in percentages of the available space.

onClick

Callback when a link is pressed. If `href` is set, it will execute the callback and then navigate to the location specified by `href`.

onPress

Alias for `onClick` Callback when a link is pressed. If `href` is set, it will execute the callback and then navigate to the location specified by `href`.

padding

Adjust the padding. To shorten the code, it is possible to specify all the padding for all edges of the box in one property. - `base` means block-start, inline-end, block-end and inline-start paddings are `base`. - `base none` means block-start and block-end paddings are `base`, inline-start and inline-end paddings are `none`. - `base none large` means block-start padding is `base`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`. - `base none large small` means block-start padding is `base`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`. - `true` applies a default padding that is appropriate for the component. Learn more about the 1-to-4-value syntax at https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box

paddingBlock

Adjust the block-padding. - `base none` means block-start padding is `base`, block-end padding is `none`.

paddingBlockEnd

Adjust the block-end padding.

paddingBlockStart

Adjust the block-start padding.

paddingInline

Adjust the inline padding. - `base none` means inline-start padding is `base`, inline-end padding is `none`.

paddingInlineEnd

Adjust the inline-end padding.

paddingInlineStart

Adjust the inline-start padding.

target

Specifies where to display the linked URL

to

Alias for `href` If set, it will navigate to the location specified by `to` after executing the `onClick` callback.

tone

Sets the link color. - `inherit` will take the color value from its parent, giving the link a monochrome appearance. In some cases, its important to pair this property with another stylistic treatment, like an underline, to differentiate the link from a normal text.

AccessibilityRole

'main' | 'header' | 'footer' | 'section' | 'aside' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'status' | 'alert' | 'generic'

MaybeAllBoxEdgesShorthandProperty

T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`

SpacingKeyword

'none' | 'small' | 'base' | 'large'

MaybeTwoBoxEdgesShorthandProperty

T | `${T} ${T}`

Related

• Button