Yamada UIにスターをあげる

スター
Yamada UIYamada UIv1.7.2

CheckboxCard

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

ソース@yamada-ui/checkbox

Props

CheckboxCardProps

addon

説明

The addon of the checkbox card.

タイプ

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

addonProps

説明

Props for the footer of the checkbox card.

タイプ

CheckboxCardAddonProps

checked

説明

If true, the checkbox will be checked.

タイプ

boolean

デフォルト

false

colorScheme

説明

The visual color appearance of the component.

タイプ

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

デフォルト

"primary"

defaultChecked

説明

If true, the checkbox will be initially checked.

タイプ

boolean

デフォルト

false

defaultIsChecked

非推奨

説明

If true, the checkbox will be initially checked.

非推奨

Use defaultChecked instead.

タイプ

boolean

デフォルト

false

description

説明

The body of the checkbox card.

タイプ

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

descriptionProps

説明

Props for the description of the checkbox card.

タイプ

CheckboxCardDescriptionProps

disabled

説明

If true, the form control will be disabled.

タイプ

boolean

デフォルト

false

iconProps

説明

Props for the icon of the checkbox card.

タイプ

{ children: ReactElement<any, string | JSXElementConstructor<any>> } & Omit<HTMLUIProps, "children">

id

説明

id assigned to input.

タイプ

string

indeterminate

説明

If true, the checkbox will be indeterminate.

タイプ

boolean

デフォルト

false

inputProps

説明

Props for input element.

タイプ

InputHTMLAttributes<HTMLInputElement>

invalid

説明

If true, the form control will be invalid.

タイプ

boolean

デフォルト

false

isChecked

非推奨

説明

If true, the checkbox will be checked.

非推奨

Use checked instead.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the form control will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isIndeterminate

非推奨

説明

If true, the checkbox will be indeterminate.

非推奨

Use indeterminate instead.

タイプ

boolean

デフォルト

false

isInvalid

非推奨

説明

If true, the form control will be invalid.

非推奨

Use invalid instead.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, the form control will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

isRequired

非推奨

説明

If true, the form control will be required.

非推奨

Use required instead.

タイプ

boolean

デフォルト

false

label

説明

The label of the checkbox card.

タイプ

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

labelProps

説明

Props for the label of the checkbox card.

タイプ

CheckboxCardLabelProps

name

説明

The HTML name attribute used for forms.

タイプ

string

onBlur

説明

The callback invoked when the checkbox is blurred.

タイプ

FocusEventHandler<HTMLInputElement>

onChange

説明

The callback invoked when the checked state changes.

タイプ

ChangeEventHandler<HTMLInputElement>

onFocus

説明

The callback invoked when the checkbox is focused.

タイプ

FocusEventHandler<HTMLInputElement>

readOnly

説明

If true, the form control will be readonly.

タイプ

boolean

デフォルト

false

required

説明

If true, the form control will be required.

タイプ

boolean

デフォルト

false

selectOnEnter

説明

If true, the checkbox will be selected when the Enter key is pressed.

タイプ

boolean

デフォルト

false

size

説明

The size of the CheckboxCard.

タイプ

"sm" | "md" | "lg"

デフォルト

"md"

tabIndex

説明

The tab-index property of the underlying input element.

タイプ

number

value

説明

The value to be used in the checkbox input.

タイプ

Y

variant

説明

The variant of the CheckboxCard.

タイプ

"outline" | "subtle" | "surface"

デフォルト

"outline"

withIcon

説明

If true, the icon will be displayed.

タイプ

boolean

デフォルト

true

CheckboxCardGroupProps

addonProps

説明

Props for the footer of the checkbox card.

タイプ

CheckboxCardAddonProps

align

説明

The CSS align-items property.

タイプ

UIValue<AlignItems>

basis

説明

The CSS flex-basis property.

タイプ

UIValue<number | "content" | "px" | "initial" | "inherit" | (string & {}) | "auto" | "max" | "min" | "1" | "-moz-initial" | "revert" | "revert-layer" | "unset" | "2xl" | "lg" | "md" | "sm" | ... 68 more ... | "xs">

defaultValue

説明

The initial value of the checkbox group.

タイプ

Y[]

descriptionProps

説明

Props for the description of the checkbox card.

タイプ

CheckboxCardDescriptionProps

direction

説明

The CSS flex-direction property.

タイプ

UIValue<FlexDirection>

disabled

説明

If true, the form control will be disabled.

タイプ

boolean

デフォルト

false

grow

説明

The CSS flex-grow property.

タイプ

UIValue<FlexGrow>

invalid

説明

If true, the form control will be invalid.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the form control will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isInvalid

非推奨

説明

If true, the form control will be invalid.

非推奨

Use invalid instead.

タイプ

boolean

デフォルト

false

isNative

非推奨

説明

If true, input elements will receive checked attribute instead of isChecked. This assumes, you're using native radio inputs.

非推奨

It will be deprecated in version 2.0.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, the form control will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

isRequired

非推奨

説明

If true, the form control will be required.

非推奨

Use required instead.

タイプ

boolean

デフォルト

false

items

説明

If provided, generate checkbox cards based on items.

タイプ

CheckboxCardItem<Y>[]

デフォルト

'[]'

justify

説明

The CSS justify-content property.

タイプ

UIValue<JustifyContent>

labelProps

説明

Props for the label of the checkbox card.

タイプ

CheckboxCardLabelProps

onChange

説明

The callback fired when any children checkbox is checked or unchecked.

タイプ

(value: Y[]) => void

readOnly

説明

If true, the form control will be readonly.

タイプ

boolean

デフォルト

false

required

説明

If true, the form control will be required.

タイプ

boolean

デフォルト

false

shrink

説明

The CSS flex-shrink property.

タイプ

UIValue<FlexShrink>

value

説明

The value of the checkbox group.

タイプ

Y[]

withIcon

説明

If true, the icon will be displayed.

タイプ

boolean

デフォルト

true

wrap

説明

The CSS flex-wrap property.

タイプ

UIValue<FlexWrap>

CheckboxCardLabelProps

contentProps

説明

The props for the label content.

タイプ

HTMLUIProps<"span">

icon

説明

The icon of the checkbox card.

タイプ

ReactElement<any, string | JSXElementConstructor<any>>

iconProps

説明

The props for the icon.

タイプ

HTMLUIProps

withIcon

説明

If true, the icon will be displayed.

タイプ

boolean

デフォルト

true

CheckboxCardDescriptionProps

CheckboxCardAddonProps

GitHubでこのページを編集する

CheckboxSwitch