Button

Button component is used to trigger an action or event, such as submitting a form, opening a Dialog, canceling an action, or performing a delete operation.

View sourceView theme source@chakra-ui/button

Import

import { Button, ButtonGroup } from '@chakra-ui/react';

• Button: The button component with support for custom icons, spinners, etc.
• ButtonGroup: Used to group buttons whose actions are related, with an option to flush them together.

Usage

<Button colorScheme='blue'>Button</Button>

<Button colorScheme='blue'>Button</Button>

Button Sizes

Use the size prop to change the size of the button. You can set the value to xs, sm, md, or lg.

<Stack spacing={4} direction='row' align='center'> <Button colorScheme='teal' size='xs'> Button </Button> <Button colorScheme='teal' size='sm'> Button </Button> <Button colorScheme='teal' size='md'> Button </Button> <Button colorScheme='teal' size='lg'> Button </Button> </Stack>

<Stack spacing={4} direction='row' align='center'>
  <Button colorScheme='teal' size='xs'>
    Button
  </Button>
  <Button colorScheme='teal' size='sm'>
    Button
  </Button>
  <Button colorScheme='teal' size='md'>
    Button
  </Button>
  <Button colorScheme='teal' size='lg'>
    Button
  </Button>
</Stack>

Button variants

Use the variant prop to change the visual style of the Button. You can set the value to solid, ghost, outline, or link.

<Stack direction='row' spacing={4} align='center'> <Button colorScheme='teal' variant='solid'> Button </Button> <Button colorScheme='teal' variant='outline'> Button </Button> <Button colorScheme='teal' variant='ghost'> Button </Button> <Button colorScheme='teal' variant='link'> Button </Button> </Stack>

<Stack direction='row' spacing={4} align='center'>
  <Button colorScheme='teal' variant='solid'>
    Button
  </Button>
  <Button colorScheme='teal' variant='outline'>
    Button
  </Button>
  <Button colorScheme='teal' variant='ghost'>
    Button
  </Button>
  <Button colorScheme='teal' variant='link'>
    Button
  </Button>
</Stack>

Button Colors

Use the colorScheme prop to change the color scheme of the Button. You can set the value to any of the color scales from your design system, like whiteAlpha, blackAlpha, gray, red, blue, or your custom color scale.

<Stack direction='column'> <Box display='flex' alignItems='center' justifyContent='center' width='100%' py={12} bgImage="url('https://bit.ly/2Z4KKcF')" bgPosition='center' bgRepeat='no-repeat' mb={2} > <ButtonGroup gap='4'> <Button colorScheme='whiteAlpha'>WhiteAlpha</Button> <Button colorScheme='blackAlpha'>BlackAlpha</Button> </ButtonGroup> </Box> <Wrap spacing={4}> <WrapItem> <Button colorScheme='gray'>Gray</Button> </WrapItem> <WrapItem> <Button colorScheme='red'>Red</Button> </WrapItem> <WrapItem> <Button colorScheme='orange'>Orange</Button> </WrapItem> <WrapItem> <Button colorScheme='yellow'>Yellow</Button> </WrapItem> <WrapItem> <Button colorScheme='green'>Green</Button> </WrapItem> <WrapItem> <Button colorScheme='teal'>Teal</Button> </WrapItem> <WrapItem> <Button colorScheme='blue'>Blue</Button> </WrapItem> <WrapItem> <Button colorScheme='cyan'>Cyan</Button> </WrapItem> <WrapItem> <Button colorScheme='purple'>Purple</Button> </WrapItem> <WrapItem> <Button colorScheme='pink'>Pink</Button> </WrapItem> <WrapItem> <Button colorScheme='linkedin'>Linkedin</Button> </WrapItem> <WrapItem> <Button colorScheme='facebook'>Facebook</Button> </WrapItem> <WrapItem> <Button colorScheme='messenger'>Messenger</Button> </WrapItem> <WrapItem> <Button colorScheme='whatsapp'>Whatsapp</Button> </WrapItem> <WrapItem> <Button colorScheme='twitter'>Twitter</Button> </WrapItem> <WrapItem> <Button colorScheme='telegram'>Telegram</Button> </WrapItem> </Wrap> </Stack>

<Stack direction='column'>
  <Box
    display='flex'
    alignItems='center'
    justifyContent='center'
    width='100%'
    py={12}
    bgImage="url('https://bit.ly/2Z4KKcF')"
    bgPosition='center'
    bgRepeat='no-repeat'
    mb={2}
  >
    <ButtonGroup gap='4'>
      <Button colorScheme='whiteAlpha'>WhiteAlpha</Button>
      <Button colorScheme='blackAlpha'>BlackAlpha</Button>
    </ButtonGroup>
  </Box>

  <Wrap spacing={4}>
    <WrapItem>
      <Button colorScheme='gray'>Gray</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='red'>Red</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='orange'>Orange</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='yellow'>Yellow</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='green'>Green</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='teal'>Teal</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='blue'>Blue</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='cyan'>Cyan</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='purple'>Purple</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='pink'>Pink</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='linkedin'>Linkedin</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='facebook'>Facebook</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='messenger'>Messenger</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='whatsapp'>Whatsapp</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='twitter'>Twitter</Button>
    </WrapItem>
    <WrapItem>
      <Button colorScheme='telegram'>Telegram</Button>
    </WrapItem>
  </Wrap>
</Stack>

Button with icon

You can add left and right icons to the Button component using the leftIcon and rightIcon props respectively.

Note: The leftIcon and rightIcon prop values should be react elements NOT strings.

<Stack direction='row' spacing={4}> <Button leftIcon={<EmailIcon />} colorScheme='teal' variant='solid'> Email </Button> <Button rightIcon={<ArrowForwardIcon />} colorScheme='teal' variant='outline'> Call us </Button> </Stack>

<Stack direction='row' spacing={4}>
  <Button leftIcon={<EmailIcon />} colorScheme='teal' variant='solid'>
    Email
  </Button>
  <Button rightIcon={<ArrowForwardIcon />} colorScheme='teal' variant='outline'>
    Call us
  </Button>
</Stack>

You can also use icons from popular libraries like react-icons and pass it into the button.

// import { MdBuild , MdCall } from "react-icons/md" <Stack direction='row' spacing={4}> <Button leftIcon={<MdBuild />} colorScheme='pink' variant='solid'> Settings </Button> <Button rightIcon={<MdCall />} colorScheme='blue' variant='outline'> Call us </Button> </Stack>

// import { MdBuild , MdCall } from "react-icons/md"

<Stack direction='row' spacing={4}>
  <Button leftIcon={<MdBuild />} colorScheme='pink' variant='solid'>
    Settings
  </Button>
  <Button rightIcon={<MdCall />} colorScheme='blue' variant='outline'>
    Call us
  </Button>
</Stack>

Button loading state

Pass the isLoading prop to show its loading state. By default, the button will show a spinner and leave the button's width unchanged.

You can also pass the loadingText prop to show a spinner and the loading text.

<Stack direction='row' spacing={4}> <Button isLoading colorScheme='teal' variant='solid'> Email </Button> <Button isLoading loadingText='Submitting' colorScheme='teal' variant='outline' > Submit </Button> </Stack>

<Stack direction='row' spacing={4}>
  <Button isLoading colorScheme='teal' variant='solid'>
    Email
  </Button>
  <Button
    isLoading
    loadingText='Submitting'
    colorScheme='teal'
    variant='outline'
  >
    Submit
  </Button>
</Stack>

You can change the spinner element to use custom loaders as per your design requirements. Pass the spinner prop and set it to a custom react element.

<Button isLoading colorScheme='blue' spinner={<BeatLoader size={8} color='white' />} > Click me </Button>

<Button
  isLoading
  colorScheme='blue'
  spinner={<BeatLoader size={8} color='white' />}
>
  Click me
</Button>

When a loadingText is present, you can change the placement of the spinner element to either start or end. It is start by default.

<Stack direction='row' spacing={4} align='center'> <Button isLoading loadingText='Loading' colorScheme='teal' variant='outline' spinnerPlacement='start' > Submit </Button> <Button isLoading loadingText='Loading' colorScheme='teal' variant='outline' spinnerPlacement='end' > Continue </Button> </Stack>

<Stack direction='row' spacing={4} align='center'>
  <Button
    isLoading
    loadingText='Loading'
    colorScheme='teal'
    variant='outline'
    spinnerPlacement='start'
  >
    Submit
  </Button>
  <Button
    isLoading
    loadingText='Loading'
    colorScheme='teal'
    variant='outline'
    spinnerPlacement='end'
  >
    Continue
  </Button>
</Stack>

Social Buttons

We've included the colors for common social media platforms, and you can simply use their buttons via the colorScheme prop.

<HStack> <Button colorScheme='facebook' leftIcon={<FaFacebook />}> Facebook </Button> <Button colorScheme='twitter' leftIcon={<FaTwitter />}> Twitter </Button> </HStack>

<HStack>
  <Button colorScheme='facebook' leftIcon={<FaFacebook />}>
    Facebook
  </Button>
  <Button colorScheme='twitter' leftIcon={<FaTwitter />}>
    Twitter
  </Button>
</HStack>

The Facebook and Twitter icons in the above example are available from react-icons as FaFacebook and FaTwitter, found in the react-icons/fa import.

Grouping Buttons

You can use the Stack or ButtonGroup component to group buttons. When you use the ButtonGroup component, it allows you to:

• Set the size and variant of all buttons within it.
• Add spacing between the buttons.
• Flush the buttons together by removing the border radius of their children as needed.

<ButtonGroup variant='outline' spacing='6'> <Button colorScheme='blue'>Save</Button> <Button>Cancel</Button> </ButtonGroup>

<ButtonGroup variant='outline' spacing='6'>
  <Button colorScheme='blue'>Save</Button>
  <Button>Cancel</Button>
</ButtonGroup>

To flush the buttons, pass the isAttached prop.

<ButtonGroup size='sm' isAttached variant='outline'> <Button>Save</Button> <IconButton aria-label='Add to friends' icon={<AddIcon />} /> </ButtonGroup>

<ButtonGroup size='sm' isAttached variant='outline'>
  <Button>Save</Button>
  <IconButton aria-label='Add to friends' icon={<AddIcon />} />
</ButtonGroup>

Accessibility

• Button has role of button.
• When Button has focus, Space or Enter activates it.

Composition

All props you pass (variant, colorScheme, etc.) are converted to style props. This means you can override any style of the Button via props.

// The size prop affects the height of the button
// It can still be overridden by passing a custom height
<Button
  size='md'
  height='48px'
  width='200px'
  border='2px'
  borderColor='green.500'
>
  Button
</Button>

---

Custom Button

In the event that you need to make your own custom button, you can leverage the Box component. It provides the hover, focus, active and disabled style props to style the button.

// Button from facebook.com
<Box
  as='button'
  height='24px'
  lineHeight='1.2'
  transition='all 0.2s cubic-bezier(.08,.52,.52,1)'
  border='1px'
  px='8px'
  borderRadius='2px'
  fontSize='14px'
  fontWeight='semibold'
  bg='#f5f6f7'
  borderColor='#ccd0d5'
  color='#4b4f56'
  _hover={{ bg: '#ebedf0' }}
  _active={{
    bg: '#dddfe2',
    transform: 'scale(0.98)',
    borderColor: '#bec3c9',
  }}
  _focus={{
    boxShadow:
      '0 0 1px 2px rgba(88, 144, 255, .75), 0 1px 1px rgba(0, 0, 0, .15)',
  }}
>
  Join Group
</Box>

Props

Button Props

Button composes the Box component, so you can pass all its props. These are props specific to the Button component:

colorScheme

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"

Default

"gray"

iconSpacing

Description

The space between the button icon and label.

Type

SystemProps["marginRight"]

isActive

Description

If true, the button will be styled in its active state.

Type

boolean

isDisabled

Description

If true, the button will be disabled.

Type

boolean

isLoading

Description

If true, the button will show a spinner.

Type

boolean

leftIcon

Description

If added, the button will show an icon before the button's label.

Type

React.ReactElement

loadingText

Description

The label to show in the button when isLoading is true If no text is passed, it only shows the spinner

Type

string

rightIcon

Description

If added, the button will show an icon after the button's label.

Type

React.ReactElement

size

Type

"lg" | "md" | "sm" | "xs"

Default

"md"

spinner

Description

Replace the spinner component when isLoading is set to true

Type

React.ReactElement

spinnerPlacement

Description

It determines the placement of the spinner when isLoading is true

Type

"end" | "start"

Default

"start"

variant

Type

"ghost" | "outline" | "solid" | "link" | "unstyled"

Default

"solid"

Button Group Props

ButtonGroup composes the Box component, so you can pass all its props. These are props specific to the ButtonGroup component:

colorScheme

Description

Color Schemes for ButtonGroup are not implemented in the default theme. You can extend the theme to implement them.

Type

string

isAttached

Description

If true, the borderRadius of button that are direct children will be altered to look flushed together

Type

boolean

isDisabled

Description

If true, all wrapped button will be disabled

Type

boolean

size

Description

Sizes for ButtonGroup are not implemented in the default theme. You can extend the theme to implement them.

Type

string

spacing

Description

The spacing between the buttons

Type

SystemProps["marginRight"]

Default

'0.5rem'

variant

Description

Variants for ButtonGroup are not implemented in the default theme. You can extend the theme to implement them.

Type

string