Button

Use button for the main actions on a page or form.

Alpha
Not reviewed for accessibility

On this page

This documentation is moving to a new home. Please update any link or bookmark that points to this page. The new content can be found here.

import {Button} from '@primer/react'

Examples

Default button

This is the default variant for the Button component.

<Button>Default</Button>

<Button>Default</Button>

Danger button

The danger variant of Button is used to warn users about potentially destructive actions

<Button variant="danger">Danger</Button>

<Button variant="danger">Danger</Button>

Invisible button

The invisible variant of Button indicates that the action is a low priority one.

<Button variant="invisible">Invisible</Button>

<Button variant="invisible">Invisible</Button>

Different sized buttons

Button component supports three different sizes. small, medium, large.

<>
  <Button size="small">Search</Button>
  <Button sx={{mt: 2}}>Search</Button>
  <Button sx={{mt: 2}} size="large">
    Search
  </Button>
</>

<>
  <Button size="small">Search</Button>
  <Button sx={{mt: 2}}>Search</Button>
  <Button sx={{mt: 2}} size="large">
    Search
  </Button>
</>

Appending an icon

We can place an icon inside the Button in either the leading or the trailing position to enhance the visual context. It is recommended to use an octicon here.

<>
  <Button leadingVisual={SearchIcon}>Search</Button>
  <Button trailingVisual={SearchIcon} sx={{mt: 2}}>
    Search
  </Button>
  <Button leadingVisual={SearchIcon} trailingVisual={CheckIcon} sx={{mt: 2}}>
    Search
  </Button>
</>

<>
  <Button leadingVisual={SearchIcon}>Search</Button>
  <Button trailingVisual={SearchIcon} sx={{mt: 2}}>
    Search
  </Button>
  <Button leadingVisual={SearchIcon} trailingVisual={CheckIcon} sx={{mt: 2}}>
    Search
  </Button>
</>

Icon only button

A separate component called IconButton is used if the action shows only an icon with no text. This button will remain square in shape.

<IconButton aria-label="Search" icon={SearchIcon} />

<IconButton aria-label="Search" icon={SearchIcon} />

Different sized icon buttons

IconButton also supports the three different sizes. small, medium, large.

<>
  <IconButton aria-label="Search" size="small" icon={SearchIcon} />
  <IconButton aria-label="Search" icon={SearchIcon} sx={{ml: 2}} />
  <IconButton aria-label="Search" size="large" icon={SearchIcon} sx={{ml: 2}} />
</>

<>
  <IconButton aria-label="Search" size="small" icon={SearchIcon} />
  <IconButton aria-label="Search" icon={SearchIcon} sx={{ml: 2}} />
  <IconButton aria-label="Search" size="large" icon={SearchIcon} sx={{ml: 2}} />
</>

Button with counter

To show a count value as a trailing visual inside Button, pass a value to the count prop. The counter will match the variant styles of the parent button.

<Button count="1">Watch</Button>

<Button count="1">Watch</Button>

Block button

Use the block prop for full width buttons.

<Button block>Block</Button>

<Button block>Block</Button>

Props

Button

Name	Type	Default	Description
children Required	React.ReactNode		The content of the button.
count	number \| string		For counter buttons, the number to display.
variant	'default' \| 'primary' \| 'danger' \| 'invisible'	'default'	Change the visual style of the button.
size	'small' \| 'medium' \| 'large'	'medium'
leadingIcon Deprecated	React.ComponentType<OcticonProps>		An icon to display before the button text.
leadingVisual	React.ElementType		A visual to display before the button text.
trailingIcon Deprecated	React.ComponentType<OcticonProps>		An icon to display after the button text.
trailingVisual	React.ElementType		A visual to display after the button text.
inactive	boolean		Whether the button looks visually disabled, but can still accept all the same interactions as an enabled button. This is intended to be used when a system error such as an outage prevents the button from performing its usual action. Inactive styles are slightly different from disabled styles because inactive buttons need to have an accessible color contrast ratio. This is because inactive buttons can have tooltips or perform an action such as opening a dialog explaining why it's inactive. If both `disabled` and `inactive` are true, `disabled` takes precedence.
as	React.ElementType	'button'	The underlying element to render — either a HTML element name or a React component.
sx	SystemStyleObject
ref	React.RefObject<HTMLButtonElement>
Additional props are passed to the `<button>` element. See button docs for a list of props accepted by the `<button>` element.

Status

Alpha

Component props and basic example usage of the component are documented on primer.style/react.
Component does not have any unnecessary third-party dependencies.
Component can adapt to different themes.
Component can adapt to different screen sizes.
Component has robust unit test coverage (100% where achievable).
Component has visual regression coverage of its default and interactive states.
Component does not introduce any axe violations.
Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Beta

Component is used in a production application.
Common usage examples are documented on primer.style/react.
Common usage examples are documented in storybook stories.
Component has been reviewed by a systems designer and any resulting issues have been addressed.
Component does not introduce any performance regressions.

Stable

Component API has been stable with no breaking changes for at least one month.
Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
Component has corresponding design guidelines documented in the interface guidelines.
Component has corresponding Figma component in the Primer Web library.
Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.

ButtonGroup