Design

Interface guidelines Octicons Presentations Command line Mobile Desktop

Build

CSS React ViewComponents

Contribute About

On this page

Button

Alpha

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

View source View storybook

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}} />
</>

Counter component

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>

Styling a button

A button can be styled in an appropriate manner using the sx prop. This may be to change width, or to add margins etc. Here's an example of a block button which takes 100% of available width. Checkout styled-system to see what you can send in an sx prop.

<Button sx={{width: '100%'}}>Block</Button>

<Button sx={{width: '100%'}}>Block</Button>

Props

Native <button> HTML attributes are forwarded to the underlying React button component and are not listed below.

Button

Name	Type	Default	Description
children Required	React.ReactNode		Button description along with other components like Counter could be used here.
variant	'default' \| 'primary' \| 'danger' \| 'outline' \| 'invisible'		Changes the look and feel of the button which is different for each variant
size	'small' \| 'medium' \| 'large'		Changes the size of the button component
leadingIcon	Component		provide an octicon. It will be placed before the button text
trailingIcon	Component		provide an octicon. It will be placed 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.
Additional props are passed to the `<button>` element. See MDN for a list of props accepted by the `<button>` element. If an `as` prop is specified, the accepted props will change accordingly.

Button.Counter

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

Status

Alpha

Component props 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 100% test coverage.

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 has been manually reviewed by the accessibility team and any resulting issues have been addressed.

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.