Sponsor

Button

The 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.

Import#

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

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>

Editable Example

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>

Editable Example

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>

Editable Example

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>

Editable Example

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>

Editable Example

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>

Editable Example

You can also change the spinner itself 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>

Editable Example

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>

Editable Example

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 the its 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>

Editable Example

To flush the buttons, pass the isAttached prop.

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

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

Editable Example

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 overriden by passing a custom height
<Button
  size="md"
  height="48px"
  width="200px"
  border="2px"
  borderColor="green.500"
>
  Button
</Button>

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

Editable Example

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>

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

Editable Example

Props#

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

Name	Type	Description	Default
colorScheme	`string`		-
css	`Interpolation<{}>`	The emotion's css style object	-
iconSpacing	`SystemProps["marginRight"]`	The space between the button icon and label.	-
isActive	`boolean`	If `true`, the button will be styled in its active state.	-
isDisabled	`boolean`	If `true`, the button will be disabled.	-
isFullWidth	`boolean`	If `true`, the button will take up the full width of its container.	-
isLoading	`boolean`	If `true`, the button will show a spinner.	-
leftIcon	`React.ReactElement`	If added, the button will show an icon before the button's label.	-
loadingText	`string`	The label to show in the button when `isLoading` is true If no text is passed, it only shows the spinner	-
orientation	`"horizontal" \| "vertical"`		-
rightIcon	`React.ReactElement`	If added, the button will show an icon after the button's label.	-
size	`string`		-
spinner	`React.ReactElement`	Replace the spinner component when `isLoading` is set to `true`	-
styleConfig	`Record<string, any>`		-
variant	`string`		-

Edit this page

Button

.css-12m0k8p{pointer-events:auto;}Import.css-1l2j62r{color:#319795;font-weight:400;outline:none;opacity:0;margin-left:0.375rem;}.css-1l2j62r:focus,.css-1l2j62r[data-focus]{opacity:1;box-shadow:0 0 0 3px rgba(66, 153, 225, 0.6);}#

Usage#

Button Sizes#

Button variants#

Button with icon#

Button loading state#

Social Buttons#

Grouping Buttons#

Accessibility#

Composition#

Custom Button#

Props#

Import#