Button

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

Alpha
Not reviewed for accessibility

On this page

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>

Outline button

The outline variant of Button is typically used as a secondary button

<Button variant="outline">Outline</Button>

<Button variant="outline">Outline</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 leadingIcon={SearchIcon}>Search</Button>
  <Button trailingIcon={SearchIcon} sx={{mt: 2}}>
    Search
  </Button>
  <Button leadingIcon={SearchIcon} trailingIcon={CheckIcon} sx={{mt: 2}}>
    Search
  </Button>
</>

<>
  <Button leadingIcon={SearchIcon}>Search</Button>
  <Button trailingIcon={SearchIcon} sx={{mt: 2}}>
    Search
  </Button>
  <Button leadingIcon={SearchIcon} trailingIcon={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}} />
</>

A common use case for primer is a button with a counter component which shows the child count value. We provide Button.Counter as a composite component which requires you to provide a number as child. The counter will match the variant styles of the parent button.

<Button>
  Watch
  <Button.Counter>1</Button.Counter>
</Button>

<Button>
  Watch
  <Button.Counter>1</Button.Counter>
</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.
variant	\| 'default' \| 'primary' \| 'danger' \| 'outline' \| 'invisible' \| 'link'	'default'	Change the visual style of the button.
size	\| 'small' \| 'medium' \| 'large'	'medium'
leadingIcon	React.ComponentType<OcticonProps>		An icon to display before the button text.
trailingIcon	React.ComponentType<OcticonProps>		An icon to display after the button text.
as	React.ElementType	'button'	The underlying element to render — either a HTML element name or a React component.
sx	SystemStyleObject		Style overrides to apply to the component. See also overriding styles.
ref	React.RefObject<HTMLButtonElement>		A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the `as` prop.
Additional props are passed to the `<button>` element. See button docs for a list of props accepted by the `<button>` element.

Button.Counter

Name	Type	Default	Description
children Required	number		The counter value.
sx	SystemStyleObject		Style overrides to apply to the component. See also overriding styles.

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