CheckboxCard

CheckboxCard is a component used for allowing users to select multiple values from multiple options.

ビアンカパパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。フローラ大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。ルドマンなんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。

<CheckboxCardGroup.Root>
  <CheckboxCardGroup.Item.Root value="1">
    <CheckboxCardGroup.Item.Label>ビアンカ</CheckboxCardGroup.Item.Label>
    <CheckboxCardGroup.Item.Description>
      パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。
    </CheckboxCardGroup.Item.Description>
  </CheckboxCardGroup.Item.Root>
  <CheckboxCardGroup.Item.Root value="2">
    <CheckboxCardGroup.Item.Label>フローラ</CheckboxCardGroup.Item.Label>
    <CheckboxCardGroup.Item.Description>
      大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。
    </CheckboxCardGroup.Item.Description>
  </CheckboxCardGroup.Item.Root>
  <CheckboxCardGroup.Item.Root value="3">
    <CheckboxCardGroup.Item.Label>ルドマン</CheckboxCardGroup.Item.Label>
    <CheckboxCardGroup.Item.Description>
      なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。
    </CheckboxCardGroup.Item.Description>
  </CheckboxCardGroup.Item.Root>
</CheckboxCardGroup.Root>

Usage

import { CheckboxCard, CheckboxCardGroup } from "@yamada-ui/react"

import { CheckboxCard, CheckboxCardGroup } from "@/components/ui"

import { CheckboxCard, CheckboxCardGroup } from "@workspaces/ui"

<CheckboxCardGroup.Root>
  <CheckboxCardGroup.Item.Root>
    <CheckboxCardGroup.Item.Label />
    <CheckboxCardGroup.Item.Description />
    <CheckboxCardGroup.Item.Addon />
  </CheckboxCardGroup.Item.Root>
</CheckboxCardGroup.Root>

Use Items

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root items={items} />

Change Variant

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    { label: "Checked", value: "1" },
    { label: "Unchecked", value: "2" },
  ],
  [],
)

return (
  <VStack>
    <For each={["subtle", "surface", "outline"]}>
      {(variant) => (
        <CheckboxCardGroup.Root
          key={variant}
          variant={variant}
          defaultValue={["1"]}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Change Size

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    { label: "Checked", value: "1" },
    { label: "Unchecked", value: "2" },
  ],
  [],
)

return (
  <VStack>
    <For each={["sm", "md", "lg"]}>
      {(size) => (
        <CheckboxCardGroup.Root
          key={size}
          size={size}
          defaultValue={["1"]}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Change Color Scheme

CheckedUnchecked

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    { label: "Checked", value: "1" },
    { label: "Unchecked", value: "2" },
  ],
  [],
)

return (
  <VStack>
    <For each={["success", "warning"]}>
      {(colorScheme) => (
        <CheckboxCardGroup.Root
          key={colorScheme}
          colorScheme={colorScheme}
          defaultValue={["1"]}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Set Default Value

To set a default value, set the value to defaultValue.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root defaultValue={["1", "2"]} items={items} />

Limit the Number of Selections

To limit the number of selections, set a number to max.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root items={items} max={2} />

Change Orientation

To change the orientation, set orientation to "horizontal" or "vertical". By default, "horizontal" is set.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root items={items} orientation="vertical" />

Change Shape

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <For each={["rounded", "square"]}>
      {(shape) => (
        <CheckboxCardGroup.Root
          key={shape}
          shape={shape}
          defaultValue={["1"]}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Change Alignment

To change the alignment, set justify to "start" or "end", etc. By default, "start" is set.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <For each={["start", "end"]}>
      {(justify) => (
        <CheckboxCardGroup.Root
          key={justify}
          justify={justify}
          defaultValue={["1"]}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Add Addon

To add an addon, set ReactNode to addon.

ビアンカパパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。ドラゴンクエストV 天空の花嫁フローラ大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。ドラゴンクエストV 天空の花嫁ルドマンなんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。ドラゴンクエストV 天空の花嫁

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      addon: "ドラゴンクエストV 天空の花嫁",
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      addon: "ドラゴンクエストV 天空の花嫁",
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      addon: "ドラゴンクエストV 天空の花嫁",
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root items={items} orientation="vertical" />

Hide Indicator

To hide the indicator, set withIndicator to false.

ウサギカタツムリリス

<CheckboxCardGroup.Root withIndicator={false}>
  <CheckboxCardGroup.Item.Root flexDirection="row" gap="sm" value="1" w="auto">
    <RabbitIcon fontSize="2xl" />
    <Text as="span">ウサギ</Text>
  </CheckboxCardGroup.Item.Root>
  <CheckboxCardGroup.Item.Root flexDirection="row" gap="sm" value="2" w="auto">
    <SnailIcon fontSize="2xl" />
    <Text as="span">カタツムリ</Text>
  </CheckboxCardGroup.Item.Root>
  <CheckboxCardGroup.Item.Root flexDirection="row" gap="sm" value="3" w="auto">
    <SquirrelIcon fontSize="2xl" />
    <Text as="span">リス</Text>
  </CheckboxCardGroup.Item.Root>
</CheckboxCardGroup.Root>

Disable

To disable, set disabled to true.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <For each={["subtle", "surface", "outline"]}>
      {(variant) => (
        <CheckboxCardGroup.Root
          key={variant}
          variant={variant}
          defaultValue={["1"]}
          disabled
          items={items}
        />
      )}
    </For>
  </VStack>
)

Read-Only

To make read-only, set readOnly to true.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <For each={["subtle", "surface", "outline"]}>
      {(variant) => (
        <CheckboxCardGroup.Root
          key={variant}
          variant={variant}
          defaultValue={["1"]}
          readOnly
          items={items}
        />
      )}
    </For>
  </VStack>
)

Invalid

To make the input invalid, set invalid to true.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <For each={["subtle", "surface", "outline"]}>
      {(variant) => (
        <CheckboxCardGroup.Root
          key={variant}
          variant={variant}
          defaultValue={["1"]}
          invalid
          items={items}
        />
      )}
    </For>
  </VStack>
)

Customize Border Color

To customize the border color, set a value to focusBorderColor or errorBorderColor.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <VStack>
    <CheckboxCardGroup.Root focusBorderColor="green.500" items={items} />
    <CheckboxCardGroup.Root
      defaultValue={["1"]}
      errorBorderColor="orange.500"
      invalid
      items={items}
    />
  </VStack>
)

Customize Icon

To customize the icon, set ReactNode to checkedIcon.

const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return <CheckboxCardGroup.Root checkedIcon={<PlusIcon />} items={items} />

Control

const [value, setValue] = useState(["1"])
const items = useMemo<CheckboxCardGroup.RootProps["items"]>(
  () => [
    {
      description:
        "パパスの息子より、ふたつ年上のしっかり者の幼なじみ。彼と一緒に、レヌール城のお化け退治に繰り出した。",
      label: "ビアンカ",
      value: "1",
    },
    {
      description:
        "大富豪ルドマンの娘で、デボラの妹。ちょっぴり天然なところもある、清楚で可憐なお嬢様。",
      label: "フローラ",
      value: "2",
    },
    {
      description:
        "なんと、この私が、好きと申すか！？そ、それはいかん！もう１度、考えてみなさい。",
      label: "ルドマン",
      value: "3",
    },
  ],
  [],
)

return (
  <CheckboxCardGroup.Root items={items} value={value} onChange={setValue} />
)

If you use this code, you need to add "use client" to the top of the file.

Props

CheckboxCard.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"lg" \| "md" \| "sm" \| "xl"` The size of the component.
`variant`	`"surface"`	`"outline" \| "subtle" \| "surface"` The variant of the component.
`addon`	-	`ReactNode` The addon of the checkbox card.
`addonProps`	-	`CheckboxCardAddonProps` Props for the addon component.
`checked`	-	`boolean` If `true`, the checkbox will be checked.
`checkedIcon`	-	`ReactNode` The icon to display in the checkbox when it is checked.
`defaultChecked`	`false`	`boolean` If `true`, the checkbox will be initially checked.
`description`	-	`ReactNode` The description of the checkbox card.
`descriptionProps`	-	`CheckboxCardDescriptionProps` Props for the description component.
`disabled`	`false`	`boolean` If `true`, the field will be disabled.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`id`	-	`string` id assigned to input.
`indeterminate`	`false`	`boolean` If `true`, the checkbox will be indeterminate.
`indeterminateIcon`	-	`ReactNode` The icon to display in the checkbox when it is indeterminate.
`indicatorProps`	-	`CheckboxCardIndicatorProps` Props for the indicator component.
`inputProps`	-	`HTMLStyledProps<"input">` Props for the input element.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`justify`	`"start"`	`"end" \| "start"` The justify indicator of the component
`label`	-	`ReactNode` The label of the checkbox card.
`labelProps`	-	`CheckboxCardLabelProps` Props for the label component.
`name`	-	`string` The name of the input field in a checkbox.
`onBlur`	-	`FocusEventHandler<HTMLInputElement>` The callback invoked when the checkbox is blurred.
`onChange`	-	`ChangeEventHandler<HTMLInputElement>` The callback invoked when the checked state changes.
`onFocus`	-	`FocusEventHandler<HTMLInputElement>` The callback invoked when the checkbox is focused.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`rootProps`	-	`HTMLStyledProps<"label">` Props for the label element.
`shape`	`"circle"`	`"rounded" \| "square"` The shape of the component
`value`	-	`Y` The value of the checkbox.
`withIndicator`	`true`	`boolean` If `true`, the indicator will be displayed.

CheckboxCard.Addon

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

CheckboxCard.Description

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

CheckboxCard.Label

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

CheckboxCardGroup.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"lg" \| "md" \| "sm" \| "xl"` The size of the component.
`variant`	`"surface"`	`"outline" \| "subtle" \| "surface"` The variant of the component.
`align`	-	`"-moz-initial" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" \| "revert-layer" ...` The CSS `align-items` property.
`attached`	`false`	`boolean` If `true`, the borderRadius of button that are direct children will be altered to look flushed together.
`basis`	-	`"-moz-fit-content" \| "-moz-initial" \| "-moz-max-content" \| "-moz-min-content" \| "-webkit-auto" \| "0.5" \| "1.5" \| "1" \| "1/12" \| "1/2" ...` The CSS `flex-basis` property.
`checkedIcon`	-	`string \| number \| bigint \| boolean \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<...>` The icon to display in the checkbox when it is checked.
`defaultValue`	`[]`	`Y[]` The initial value of the checkbox group.
`direction`	-	`"-moz-initial" \| "column-reverse" \| "column" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "row-reverse" \| "row" \| "unset" ...` The CSS `flex-direction` property.
`disabled`	`false`	`boolean` If `true`, the field will be disabled.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`grow`	`false`	`boolean` If `true`, the children will grow to fill the available space.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`items`	`[]`	`CheckboxCardItem<Y>[]` If provided, generate options based on items.
`justify`	`"start"`	`"end" \| "start"` The justify indicator of the component
`max`	-	`number` The maximum number of checkboxes that can be checked.
`onChange`	-	`(value: Y[]) => void` The callback fired when any children checkbox is checked or unchecked.
`orientation`	`"horizontal"`	`"horizontal" \| "vertical"` The orientation of the group.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`shape`	`"circle"`	`"rounded" \| "square"` The shape of the component
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| number & {} ...` The CSS `flex-shrink` property.
`stacking`	-	`"first-on-top" \| "last-on-top"` The stacking order of the group.
`value`	-	`Y[]` The value of the checkbox group.
`withIndicator`	`true`	`boolean` If `true`, the indicator will be displayed.
`wrap`	-	`"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" ...` The CSS `flex-wrap` property.

CheckboxCardGroup.Item.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"lg" \| "md" \| "sm" \| "xl"` The size of the component.
`variant`	`"surface"`	`"outline" \| "subtle" \| "surface"` The variant of the component.
`addon`	-	`ReactNode` The addon of the checkbox card.
`addonProps`	-	`CheckboxCardAddonProps` Props for the addon component.
`checked`	-	`boolean` If `true`, the checkbox will be checked.
`checkedIcon`	-	`ReactNode` The icon to display in the checkbox when it is checked.
`defaultChecked`	`false`	`boolean` If `true`, the checkbox will be initially checked.
`description`	-	`ReactNode` The description of the checkbox card.
`descriptionProps`	-	`CheckboxCardDescriptionProps` Props for the description component.
`disabled`	`false`	`boolean` If `true`, the field will be disabled.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`id`	-	`string` id assigned to input.
`indeterminate`	`false`	`boolean` If `true`, the checkbox will be indeterminate.
`indeterminateIcon`	-	`ReactNode` The icon to display in the checkbox when it is indeterminate.
`indicatorProps`	-	`CheckboxCardIndicatorProps` Props for the indicator component.
`inputProps`	-	`HTMLStyledProps<"input">` Props for the input element.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`justify`	`"start"`	`"end" \| "start"` The justify indicator of the component
`label`	-	`ReactNode` The label of the checkbox card.
`labelProps`	-	`CheckboxCardLabelProps` Props for the label component.
`name`	-	`string` The name of the input field in a checkbox.
`onBlur`	-	`FocusEventHandler<HTMLInputElement>` The callback invoked when the checkbox is blurred.
`onChange`	-	`ChangeEventHandler<HTMLInputElement>` The callback invoked when the checked state changes.
`onFocus`	-	`FocusEventHandler<HTMLInputElement>` The callback invoked when the checkbox is focused.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`rootProps`	-	`HTMLStyledProps<"label">` Props for the label element.
`shape`	`"circle"`	`"rounded" \| "square"` The shape of the component
`value`	-	`Y` The value of the checkbox.
`withIndicator`	`true`	`boolean` If `true`, the indicator will be displayed.

CheckboxCardGroup.Item.Addon

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

CheckboxCardGroup.Item.Description

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

CheckboxCardGroup.Item.Label

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

Accessibility

Currently, this section is being updated due to the migration of v2.