Yamada UIにスターをあげる

スター
Yamada UIYamada UIv1.7.2

Toggle

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

ソース@yamada-ui/toggle

Props

ToggleProps

active

説明

If true, the toggle button is represented as active.

タイプ

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"

デフォルト

"gray"

defaultIsSelected

非推奨

説明

If true, the toggle button will be initially selected.

非推奨

Use defaultSelected instead.

タイプ

boolean

デフォルト

false

defaultSelected

説明

If true, the toggle button will be initially selected.

タイプ

boolean

デフォルト

false

disableRipple

説明

If true, disable ripple effects when pressing a element.

タイプ

boolean

デフォルト

false

fullRounded

説明

If true, the toggle button is full rounded. Else, it'll be slightly round.

タイプ

boolean

デフォルト

false

icon

説明

The icon to be used in the button.

タイプ

ReactElement<any, string | JSXElementConstructor<any>>

isActive

非推奨

説明

If true, the toggle button is represented as active.

非推奨

Use active instead.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the toggle button will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, the toggle button will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

isRounded

非推奨

説明

If true, the toggle button is full rounded. Else, it'll be slightly round.

非推奨

Use fullRounded instead.

タイプ

boolean

デフォルト

false

isSelected

非推奨

説明

If true, the toggle button will be selected.

非推奨

Use selected instead.

タイプ

boolean

onChange

説明

The callback invoked when selected state changes.

タイプ

(selected: boolean) => void

readOnly

説明

If true, the toggle button will be readonly.

タイプ

boolean

デフォルト

false

selected

説明

If true, the toggle button will be selected.

タイプ

boolean

size

説明

The size of the Toggle.

タイプ

"xs" | "sm" | "md" | "lg"

デフォルト

"md"

value

説明

The value of the toggle button.

タイプ

Y

variant

説明

The variant of the Toggle.

タイプ

"outline" | "solid" | "subtle" | "unstyled"

デフォルト

"subtle"

ToggleGroupProps

defaultValue

説明

The initial value of the toggle button group.

タイプ

NonNullable<Y extends any[] ? Y : Y | undefined>

direction

非推奨

説明

The CSS flex-direction property.

非推奨

Use flexDirection instead.

タイプ

UIValue<FlexDirection>

disabled

説明

If true, all wrapped toggle button will be disabled.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, all wrapped toggle button will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, all wrapped toggle button will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

onChange

説明

The callback fired when any children toggle button is selected or unselected.

タイプ

(value: Y extends any[] ? Y : Y | undefined) => void

readOnly

説明

If true, all wrapped toggle button will be readonly.

タイプ

boolean

デフォルト

false

value

説明

The value of the toggle button group.

タイプ

NonNullable<Y extends any[] ? Y : Y | undefined>

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

SwitchSelect