CheckboxCard

CheckboxCardは、ユーザーが複数の選択肢の中から複数の値を選択するために使用されるコンポーネントです。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

<CheckboxCardGroup.Root>
  <CheckboxCardGroup.Item.Root value="1">
    <CheckboxCardGroup.Item.Label>ドラえもん</CheckboxCardGroup.Item.Label>
    <CheckboxCardGroup.Item.Description>
      22世紀の未来から来たネコ型ロボット。
    </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>

使い方

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>

itemsを使う

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

バリアントを変更する

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    { 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>
)

サイズを変更する

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    { 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>
)

カラースキームを変更する

CheckedUnchecked

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    { 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>
)

デフォルトの値を設定する

デフォルトの値を設定する場合は、defaultValueに値を設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

選択数を制限する

選択数を制限する場合は、maxに数値を設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

方向を変更する

方向を変更する場合は、orientationに"horizontal"または"vertical"を設定します。デフォルトでは、"horizontal"が設定されています。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

形を変更する

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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>
)

配置を変更する

配置を変更する場合は、justifyに"start"または"end"などを設定します。デフォルトでは、"start"が設定されています。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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>
)

アドオンを追加する

アドオンを追加する場合は、addonにReactNodeを設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。藤子・F・不二雄ドラミドラえもんの妹のロボット。藤子・F・不二雄ガチャ子アヒル型のロボット。藤子・F・不二雄

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      addon: "藤子・F・不二雄",
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      addon: "藤子・F・不二雄",
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      addon: "藤子・F・不二雄",
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

インジケーターを非表示にする

インジケーターを非表示にする場合は、withIndicatorを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>

無効にする

無効にする場合は、disabledをtrueに設定します。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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>

    <Field.Root disabled label="お気に入りのキャラクターは誰ですか？">
      <CheckboxCardGroup.Root defaultValue={["1"]} items={items} />
    </Field.Root>
  </VStack>
)

読み取り専用にする

読み取り専用にする場合は、readOnlyをtrueに設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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をtrueに設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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>
)

ボーダーの色を変更する

ボーダーの色を変更する場合は、focusBorderColorまたはerrorBorderColorに値を設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      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>
)

アイコンをカスタマイズする

カスタムアイコンを使う場合は、checkedIconにReactNodeを設定します。

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

制御する

ドラえもん22世紀の未来から来たネコ型ロボット。ドラミドラえもんの妹のロボット。ガチャ子アヒル型のロボット。

const [value, setValue] = useState(["1"])
const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    {
      description: "22世紀の未来から来たネコ型ロボット。",
      label: "ドラえもん",
      value: "1",
    },
    {
      description: "ドラえもんの妹のロボット。",
      label: "ドラミ",
      value: "2",
    },
    {
      description: "アヒル型のロボット。",
      label: "ガチャ子",
      value: "3",
    },
  ],
  [],
)

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

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

Props

CheckboxCard.Root

Prop	デフォルト	型 / 説明
`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" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` 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.
`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.
`value`	-	`Y` The value of the checkbox.
`withIndicator`	`true`	`boolean` If `true`, the indicator will be displayed.

CheckboxCard.Addon

Prop	デフォルト	型 / 説明
`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	デフォルト	型 / 説明
`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	デフォルト	型 / 説明
`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	デフォルト	型 / 説明
`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" \| "anchor-center" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" ...` The CSS `align-items` property.
`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" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is focused.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`items`	`[]`	`CheckboxCardGroupItem<Y>[]` If provided, generate options based on items.
`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.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| number & {} ...` The CSS `flex-shrink` property.
`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	デフォルト	型 / 説明
`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" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` 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.
`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.
`value`	-	`Y` The value of the checkbox.
`withIndicator`	`true`	`boolean` If `true`, the indicator will be displayed.

CheckboxCardGroup.Item.Addon

Prop	デフォルト	型 / 説明
`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	デフォルト	型 / 説明
`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	デフォルト	型 / 説明
`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は、アクセシビリティに関してWAI-ARIA - Checkbox Patternに従います。

Field.Rootを使用しない場合は、CheckboxCardGroup.Rootにaria-labelまたはaria-labelledbyを設定します。

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    { label: "ドラえもん", value: "1" },
    { label: "ドラミ", value: "2" },
    { label: "ガチャ子", value: "3" },
  ],
  [],
)

return <CheckboxCardGroup.Root aria-label="キャラクター" items={items} />

const items = useMemo<CheckboxCardGroup.ItemType[]>(
  () => [
    { label: "ドラえもん", value: "1" },
    { label: "ドラミ", value: "2" },
    { label: "ガチャ子", value: "3" },
  ],
  [],
)

return (
  <VStack gap="sm">
    <Text as="h3" id="label">
      キャラクター
    </Text>

    <CheckboxCardGroup.Root aria-labelledby="label" items={items} />
  </VStack>
)

キー	説明	状態
`Space`	チェックボックスのチェックの状態を切り替えます。	-

ARIAロールと属性

コンポーネント	ロールと属性	使い方
`CheckboxCardGroup.Root`	`role="group"`	グループであることを示します。
	`aria-labelledby`	`CheckboxCardGroup.Root`が`Field.Root`内にあり、`Field.Root`に`label`または`Field.Label`がある場合、その`id`を設定します。
	`aria-describedby`	`CheckboxCardGroup.Root`が`Field.Root`内にあり、`Field.Root`に`errorMessage`、`helperMessage`、または`Field.ErrorMessage`、`Field.HelperMessage`がある場合、その`id`を設定します。
`input`	`aria-checked`	`indeterminate`が設定されている場合は`"mixed"`を設定し、チェックされている場合は`"true"`、されていない場合は`"false"`を設定します。
	`aria-disabled`	`readOnly`が設定されている場合、またはグループで`max`に達した場合は`"true"`を設定します。
	`aria-invalid`	`invalid`が設定されている場合は`"true"`を設定します。
	`aria-required`	`required`が設定されている場合は`"true"`を設定します。
`CheckboxCardIndicator`	`aria-hidden`	要素をアクセシビリティツリーから除外します。

類似のコンポーネント

RadioCardは、ユーザーが複数の選択肢の中から1つを選択するために使用されるコンポーネントです。

Switchは、オンとオフの状態を切り替えるために使用されるコンポーネントです。

SegmentedControlは、ユーザーが複数の選択肢の中から1つを選択するために使用されるコンポーネントです。

Radioは、ユーザーが複数の選択肢の中から1つの値を選択するために使用されるコンポーネントです。

Ratingは、ユーザーが評価を行うために使用させるコンポーネントです。

NativeSelectは、ユーザーがオプションのリストから1つの値を選択するために使用されるコンポーネントです。ブラウザ（ユーザーエージェント）によって提供されるネイティブなドロップダウンリストを表示します。

Checkboxは、ユーザーが複数の選択肢の中から複数の値を選択するために使用されるコンポーネントです。

Toggleは、オンまたはオフの２つの状態を持つコンポーネントです。

使用しているコンポーネント・フック

Checkboxは、ユーザーが複数の選択肢の中から複数の値を選択するために使用されるコンポーネントです。

Groupは、複数の要素をまとめて扱うためのコンポーネントです。

Inputは、ユーザーからのテキスト入力を取得するために使用されるコンポーネントです。

Iconは、プロジェクトに使用できる一般的なアイコンコンポーネントです。