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.

Source Theme Source @chakra-ui/button

Import#

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

Usage#

<Button colorPalette='teal'>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 gap={4} direction='row' align='center'>
  <Button colorPalette='teal' size='xs'>
    Button
  </Button>
  <Button colorPalette='teal' size='sm'>
    Button
  </Button>
  <Button colorPalette='teal' size='md'>
    Button
  </Button>
  <Button colorPalette='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, outline, or ghost

<Stack direction='row' gap={4} align='center'>
  <Button colorPalette='teal' variant='solid'>
    Button
  </Button>
  <Button colorPalette='teal' variant='outline'>
    Button
  </Button>
  <Button colorPalette='teal' variant='ghost'>
    Button
  </Button>
</Stack>

Changing the color palette#

Use the colorPalette prop to change the color palette 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.

<Wrap gap={4}>
  <Button colorPalette='gray'>Gray</Button>
  <Button colorPalette='red'>Red</Button>
  <Button colorPalette='orange'>Orange</Button>
  <Button colorPalette='yellow'>Yellow</Button>
  <Button colorPalette='green'>Green</Button>
  <Button colorPalette='teal'>Teal</Button>
</Wrap>

Using icons#

<Stack direction='row' gap={4}>
  <Button colorPalette='teal'>
    <FiMail />
    Email
  </Button>
  <Button colorPalette='teal' variant='outline'>
    Call us
    <MdArrowForward />
  </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' gap={4}>
  <Button colorPalette='pink'>
    <MdBuild />
    Settings
  </Button>
  <Button colorPalette='blue' variant='outline'>
    Call us
    <MdCall />
  </Button>
</Stack>

Showing loading state#

To show a loading state, set the disabled prop to true and use the Spinner component.

<Button disabled colorPalette='teal'>
  <Spinner size='sm' /> Loading
</Button>

To ensure the width of the button does not change when the loading state is active, use the AbsoluteCenter component.

<Button disabled colorPalette='teal'>
  <AbsoluteCenter>
    <BeatLoader size={8} color='white' />
  </AbsoluteCenter>
  <Span opacity='0'>Submitting</Span>
</Button>

Accessibility#

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

The Button component is a single part component. All of the styling is applied directly to the button element.

To learn more about styling single part components, visit the Component Style page.

Theming properties#

The properties that affect the theming of the Button component are:

variant: The visual variant of the button. Defaults to solid.
colorScheme: The color scheme of the button. Defaults to gray.
size: The size of the button. Defaults to md.

Theming utilities#

defineStyle: a function used to create style objects.
defineStyleConfig: a function used to define the style configuration for a single part component.

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

Customizing the default theme#

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const outline = defineStyle({
  border: '2px dashed', // change the appearance of the border
  borderRadius: 0, // remove the border radius
  fontWeight: 'semibold', // change the font weight
})

export const buttonTheme = defineStyleConfig({
  variants: { outline },
})

After customizing the button theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { buttonTheme } from './components/button'

export const theme = extendTheme({
  components: { Button: buttonTheme },
})

This is a crucial step to make sure that any changes that we make to the button theme are applied.

Adding a custom size#

Let's assume we want to include an extra large button size. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const xl = defineStyle({
  fontSize: 'xl',
  px: '6',
  h: '16',
  borderRadius: 'md',
})

export const buttonTheme = defineStyleConfig({
  sizes: { xl },
})

// Now we can use the new `xl` size
<Button size="xl">...</Button>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom branded variant. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const brandPrimary = defineStyle({
  background: 'orange.500',
  color: 'white',
  fontFamily: 'serif',
  fontWeight: 'normal',

  // let's also provide dark mode alternatives
  _dark: {
    background: 'orange.300',
    color: 'orange.800',
  }
})

export const buttonTheme = defineStyleConfig({
  variants: { brandPrimary },
})

// Now we can use the new `brandPrimary` variant
<Button variant="brandPrimary">...</Button>

Using a custom color scheme#

Let's assume we want to use our own custom color scale based on our brand. We'd need to define the color scale first in the main theme file:

import { extendTheme } from '@chakra-ui/react'

export const theme = extendTheme({
  colors: {
    brand: {
      50: '#f7fafc',
      ...
      500: '#718096',
      ...
      900: '#171923',
    }
  }
})

Then, we can use the custom color scale as the color scheme for the button:

<Button colorPalette='brand'>...</Button>

Changing the default properties#

Let's assume we want to change the default size, variant or color scheme of every button in our app. Here's how we can do that:

import { defineStyleConfig } from '@chakra-ui/react'

export const buttonTheme = defineStyleConfig({
  defaultProps: {
    size: 'lg',
    variant: 'outline',
    colorScheme: 'brand',
  },
})

// This saves you time, instead of manually setting the size,
// variant and color scheme every time you use a button:
<Button size="lg" variant="outline" colorPalette="brand">...</Button>

Showcase#

import { Box, SimpleGrid, IconButton, Button, useColorMode } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  return (
    <Box position="relative" h="100vh">
      <SimpleGrid gap={12} p={12} columns={2}>
        <Button>
          Themed solid button
        </Button>
        <Button variant="custom">
          Themed custom button
        </Button>
        <Button variant="ghost">
          Themed ghost button
        </Button>
        <Button variant="outline">
          Themed outline button
        </Button>
        <Button variant="link">
          Themed link button
        </Button>
      </SimpleGrid>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}

Open Sandbox

Edit this page on GitHub