Checkbox

Binary or indeterminate toggle control.

Package: @solidiom/checkbox
Version: 0.0.1-next.0
Status: stable

Generated from the package's public source.

API

`CheckboxGroupProps`interface

Props

class?: string
defaultValue?: string[] — Default value (uncontrolled).
disabled?: boolean
onValueChange?: (value: string[]) => void — Called when the set of checked values changes.
style?: string | CSSProperties
value?: Accessor<string[] | undefined> — Controlled value — array of checked item values.

children: Element

View source

`CheckboxIndicatorProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`CheckboxRootProps`interface

Props

checked?: Accessor<CheckedState | undefined>
class?: string
defaultChecked?: CheckedState
disabled?: boolean
name?: string
onCheckedChange?: (checked: CheckedState) => void
required?: boolean
style?: string | CSSProperties
value?: string — When used inside a CheckboxGroup, identifies this checkbox's value.

children: Element

View source

`CheckedState`type

View source

`Group`component

                        Group(props: CheckboxGroupProps): Element

Props

class?: string
defaultValue?: string[] — Default value (uncontrolled).
disabled?: boolean
onValueChange?: (value: string[]) => void — Called when the set of checked values changes.
style?: string | CSSProperties
value?: Accessor<string[] | undefined> — Controlled value — array of checked item values.

children: Element

View source

`Indicator`component

                        Indicator(props: CheckboxIndicatorProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`Root`component

                        Root(props: CheckboxRootProps): Element

Props

checked?: Accessor<CheckedState | undefined>
class?: string
defaultChecked?: CheckedState
disabled?: boolean
name?: string
onCheckedChange?: (checked: CheckedState) => void
required?: boolean
style?: string | CSSProperties
value?: string — When used inside a CheckboxGroup, identifies this checkbox's value.

children: Element

View source

`useCheckboxGroup`function

                        useCheckboxGroup(): CheckboxGroupContextValue | null

View source

API

#CheckboxGroupPropsinterface

Props

#CheckboxIndicatorPropsinterface

Props

#CheckboxRootPropsinterface

Props

#CheckedStatetype

#Groupcomponent

Props

#Indicatorcomponent

Props

#Rootcomponent

Props

#useCheckboxGroupfunction

`CheckboxGroupProps`interface

`CheckboxIndicatorProps`interface

`CheckboxRootProps`interface

`CheckedState`type

`Group`component

`Indicator`component

`Root`component

`useCheckboxGroup`function