Usage
import { CloseButton } from "@chakra-ui/react"<CloseButton />Examples
Sizes
Use the size prop to change the size of the close button.
Variants
Use the variant prop to change the appearance of the close button.
Custom Icon
Pass the custom icon to the children of the CloseButton component.
Props
| Prop | Default | Type |
|---|---|---|
spinnerPlacement | start | 'start' | 'end' | undefinedThe placement of the spinner |
colorPalette | gray | 'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink'The color palette of the component |
size | md | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'The size of the component |
variant | solid | 'solid' | 'subtle' | 'surface' | 'outline' | 'ghost' | 'plain'The variant of the component |
loading | boolean | undefinedIf `true`, the button will show a loading spinner. | |
loadingText | React.ReactNode | undefinedThe text to show while loading. | |
spinner | React.ReactNode | undefinedThe spinner to show while loading. | |
as | React.ElementTypeThe underlying element to render. | |
asChild | booleanUse the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide. |