Checkmark
A visual indicator used to show checked, unchecked, or indeterminate states
Usage
import { Checkmark } from "@chakra-ui/react"<Checkmark checked />Examples
Indeterminate
Use the indeterminate prop to show an indeterminate state.
States
The Checkmark component supports three states: unchecked (default), checked, and indeterminate.
Variants
Use the variant prop to change the visual style of the checkmark.
Sizes
Use the size prop to change the size of the checkmark.
Colors
Use the colorPalette prop to change the color scheme of the checkmark.
Filled
Use the filled prop with the outline variant to add a background color to
the checkmark.
Props
| Prop | Default | Type |
|---|---|---|
colorPalette | gray | 'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink'The color palette of the component |
size | md | 'xs' | 'sm' | 'md' | 'lg'The size of the component |
variant | solid | 'solid' | 'outline' | 'subtle' | 'plain' | 'inverted'The variant of the component |
checked | boolean | undefinedWhether the checkmark is checked | |
indeterminate | boolean | undefinedWhether the checkmark is indeterminate | |
disabled | boolean | undefinedWhether the checkmark is disabled | |
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. |