Close Button

CloseButton is essentially a button with a close icon. It is used to trigger close functionality in components.

Props#

The CloseButton composes Box component.

`colorScheme`

Description

The visual color appearance of the component

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink"

`isDisabled`

Description

If true, the close button will be disabled.

Type

boolean

Default

false

`size`

Description

The size of the CloseButton

Type

"lg" | "md" | "sm"

Default

md

`variant`

Description

The variant of the CloseButton

Type

string

The CloseButton 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 closeButtonTheme = 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 { closeButtonTheme } from './components/closeButton'

export const theme = extendTheme({
  components: { CloseButton: closeButtonTheme },
})

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 close 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 closeButtonTheme = defineStyleConfig({
  sizes: { xl },
})

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

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 closeButtonTheme = defineStyleConfig({
  variants: { brandPrimary },
})

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

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:

<CloseButton colorScheme='brand' />

Changing the default properties#

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

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

export const closeButtonTheme = 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:
<CloseButton size="lg" variant="outline" colorScheme="brand" />

Showcase#

import { Box, HStack, IconButton, CloseButton, 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">
      <HStack gap={12} p={12}>
        <CloseButton />
        <CloseButton variant="outline" />
        <CloseButton variant="custom" />
        <CloseButton size="xl" />
      </HStack>

      <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