CheckboxGroup

有限個のチェックボックス値をまとめ、必要に応じて親チェックボックスの状態も導出します。

デモを読み込み中…

<CheckboxGroup.Root
  allValues={["email", "push"]}
  value={channels()}
  onValueChange={setChannels}
>
  <Checkbox.Root parent><Text>All notifications</Text></Checkbox.Root>
  <Checkbox.Root value="email"><Text>Email</Text></Checkbox.Root>
  <Checkbox.Root value="push"><Text>Push</Text></Checkbox.Root>
</CheckboxGroup.Root>

#インポート

@quickgui/solid から CheckboxGroup をインポートします。

import { CheckboxGroup } from "@quickgui/solid";

#使い方

<CheckboxGroup.Root
  allValues={["email", "push"]}
  value={channels()}
  onValueChange={setChannels}
>
  <Checkbox.Root parent><Text>All notifications</Text></Checkbox.Root>
  <Checkbox.Root value="email"><Text>Email</Text></Checkbox.Root>
  <Checkbox.Root value="push"><Text>Push</Text></Checkbox.Root>
</CheckboxGroup.Root>

#構成

CheckboxGroup.Root

<CheckboxGroup.Root>{/* content */}</CheckboxGroup.Root>

#API リファレンス

項目を展開すると説明と完全なシグネチャが表示されます。ダッシュは宣言に既定値が記載されていないことを示します。

`CheckboxGroup`

ソースを見る

CheckboxGroup(props: JSX.CheckboxGroupProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

ソースを見る

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

ソースを見る

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

ソースを見る

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

ソースを見る

groupboolean | string—

Makes this element the group its descendants' `groupHover` and `groupActive` styles follow, like Tailwind's `group`: `true` opens an unnamed group, and a string names it so a descendant can follow it past a nearer group with `groupHover: { group: "name" }`.

boolean | string

ソースを見る

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

ソースを見る

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

ソースを見る

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

ソースを見る

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

ソースを見る

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

ソースを見る

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

ソースを見る

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

ソースを見る

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

ソースを見る

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

ソースを見る

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

ソースを見る

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

ソースを見る

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

ソースを見る

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

ソースを見る

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

ソースを見る

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

ソースを見る

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

ソースを見る

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

ソースを見る

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

ソースを見る

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

allValuesreadonly string[]—

The complete, ordered universe the parent checkbox derives its state from.

readonly string[]

ソースを見る

valuereadonly string[]—

Controlled checked values. The core keeps them in the declared order.

readonly string[]

ソースを見る

defaultValuereadonly string[]—

Declares defaultValue (optional). Reactive JSX expressions update this property in place.

readonly string[]

ソースを見る

onValueChange(values: readonly string[], event: QuickGuiEvent) => void—

Declares onValueChange (optional). Reactive JSX expressions update this property in place.

(values: readonly string[], event: QuickGuiEvent) => void

ソースを見る

`CheckboxGroup.Root`

ソースを見る

CheckboxGroup.Root(props: JSX.CheckboxGroupProps): NativeNode

accessibilityLabelstring—

Declares accessibilityLabel (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

childrenunknown—

Declares children (optional). Reactive JSX expressions update this property in place.

unknown

ソースを見る

styleStyleProp—

Layout, typography, paint, and interaction-state styles. Arrays merge left to right.

StyleProp

ソースを見る

disabledboolean—

Declares disabled (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

invalidboolean—

Expose web-style invalid state; the `style.invalid` variant paints while it is set.

boolean

ソースを見る

selectedboolean—

Expose web-style selected state; the `style.selected` variant paints while it is set.

boolean

ソースを見る

groupboolean | string—

boolean | string

ソースを見る

rolestring—

Declares role (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

tabIndexnumber—

Declares tabIndex (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

focusOnPointerboolean—

Keep keyboard focus where it is when this element is activated with a pointer.

boolean

ソースを見る

overlayboolean—

Paint this subtree in the viewport overlay plane above embedded native views.

boolean

ソースを見る

focusTrapboolean—

Contain keyboard focus within this subtree while it is the topmost trap.

boolean

ソースを見る

restorePreviousFocusboolean—

Restore the previously focused mounted control when this surface unmounts.

boolean

ソースを見る

autoFocusboolean—

Prefer this control when its containing focus trap takes focus.

boolean

ソースを見る

aria-modalboolean—

Expose modal semantics to assistive technology.

boolean

ソースを見る

ariaModalboolean—

Declares ariaModal (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

dismissOnEscapeboolean—

Declares dismissOnEscape (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

dismissOnPointerOutsideboolean—

Declares dismissOnPointerOutside (optional). Reactive JSX expressions update this property in place.

boolean

ソースを見る

tooltipstring—

Delayed, pointer-passive native tooltip text shown while this element is hovered.

string

ソースを見る

tooltipPlacementPopoverPlacement—

Declares tooltipPlacement (optional). Reactive JSX expressions update this property in place.

PopoverPlacement

ソースを見る

tooltipDelaynumber—

Hover delay in milliseconds, clamped by the Rust core to at most ten seconds.

number

ソースを見る

tooltipGapnumber—

Declares tooltipGap (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

tooltipViewportMarginnumber—

Declares tooltipViewportMargin (optional). Reactive JSX expressions update this property in place.

number

ソースを見る

hitSlopnumber | string—

Declares hitSlop (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopTopnumber | string—

Declares hitSlopTop (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopRightnumber | string—

Declares hitSlopRight (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopBottomnumber | string—

Declares hitSlopBottom (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

hitSlopLeftnumber | string—

Declares hitSlopLeft (optional). Reactive JSX expressions update this property in place.

number | string

ソースを見る

aria-labelstring—

Declares aria-label (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

ariaLabelstring—

Declares ariaLabel (optional). Reactive JSX expressions update this property in place.

string

ソースを見る

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode

ソースを見る

onClickEventHandler—

Declares onClick (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseEnterEventHandler—

Declares onMouseEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseLeaveEventHandler—

Declares onMouseLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerEnterEventHandler—

Declares onPointerEnter (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerLeaveEventHandler—

Declares onPointerLeave (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPointerEventHandler—

Captured pointer stream from press through release/cancel, including outside the element.

EventHandler

ソースを見る

onInputEventHandler—

Declares onInput (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onChangeEventHandler—

Declares onChange (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onSubmitEventHandler—

Declares onSubmit (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDismissEventHandler—

Declares onDismiss (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onKeyDownEventHandler—

Focused key press. Declare a `tabIndex` to make an ordinary container focusable.

EventHandler

ソースを見る

onKeyUpEventHandler—

Declares onKeyUp (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseDownEventHandler—

Declares onMouseDown (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseUpEventHandler—

Declares onMouseUp (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onMouseMoveEventHandler—

Declares onMouseMove (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDoubleClickEventHandler—

Second press of one exact native multi-click sequence.

EventHandler

ソースを見る

onWheelEventHandler—

Declares onWheel (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onContextMenuEventHandler—

Secondary-button press. Use `ContextMenu` for a declared native menu.

EventHandler

ソースを見る

onPinchEventHandler—

Declares onPinch (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onRotateEventHandler—

Declares onRotate (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onSmartMagnifyEventHandler—

Declares onSmartMagnify (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onPressureEventHandler—

Declares onPressure (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onFocusEventHandler—

Declares onFocus (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onBlurEventHandler—

Declares onBlur (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

keymapKeymap—

Bounded accelerator table resolved by the core while this element is focused.

Keymap

ソースを見る

onActionEventHandler—

Typed binding id dispatched by `keymap`.

EventHandler

ソースを見る

draggableboolean | DragSource—

Declared drag payload promoted when this element starts a drag.

boolean | DragSource

ソースを見る

onDragStartEventHandler—

Declares onDragStart (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onDragEndEventHandler—

Declares onDragEnd (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

dropKindsDropKind | readonly DropKind[]—

Payload kinds this element accepts, declared ahead of the native drag.

DropKind | readonly DropKind[]

ソースを見る

onDropEventHandler—

Declares onDrop (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

onFilesDroppedEventHandler—

Declares onFilesDropped (optional). Reactive JSX expressions update this property in place.

EventHandler

ソースを見る

allValuesreadonly string[]—

The complete, ordered universe the parent checkbox derives its state from.

readonly string[]

ソースを見る

valuereadonly string[]—

Controlled checked values. The core keeps them in the declared order.

readonly string[]

ソースを見る

defaultValuereadonly string[]—

Declares defaultValue (optional). Reactive JSX expressions update this property in place.

readonly string[]

ソースを見る

onValueChange(values: readonly string[], event: QuickGuiEvent) => void—

Declares onValueChange (optional). Reactive JSX expressions update this property in place.

(values: readonly string[], event: QuickGuiEvent) => void

ソースを見る