Skip to main content

Button

Use this component when you want to provide users the ability to perform specific actions, like saving data.

string
required

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

string

A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.

Use this when using only an icon or the button text is not enough context for users using assistive technologies.

boolean

Disables the button, disallowing any interaction.

boolean | string

Tells browsers to download the linked resource instead of navigating to it. Optionally accepts filename value to rename file.

string

A unique identifier for the button.

string

Alias for language

string

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 ("subtag" label)

() => void

Callback when focus is removed.

() => void

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

() => void

Callback when input is focused.

() => void

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.

'_blank' | '_self'
Default: '_self'

Specifies where to display the linked URL

string

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

'default' | 'critical'

Sets the color treatment of the Button.

'primary' | 'secondary' | 'tertiary'

Changes the visual appearance of the Button.

string

A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.

Use this when using only an icon or the button text is not enough context for users using assistive technologies.

Extract<, 'submit' | 'button' | 'reset'>

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.

boolean

Disables the button, disallowing any interaction.

string

A unique identifier for the button.

string

Alias for language

string

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 ("subtag" label)

() => void

Callback when focus is removed.

() => void

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

() => void

Callback when input is focused.

() => void

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

'default' | 'critical'

Sets the color treatment of the Button.

'primary' | 'secondary' | 'tertiary'

Changes the visual appearance of the Button.

Was this section helpful?

Add a simple button to your app.

import {render, Button} from '@shopify/ui-extensions-react/admin';

render('Playground', () => <App />);

function App() {
return (
<Button
onPress={() => {
console.log('onPress event');
}}
>
Click here
</Button>
);
}

Preview