BetaPublic beta — Read the release notes
Documentation

Toggle Group

Group of mutually-exclusive or multi-select toggle buttons.

Package
@solidiom/toggle-group
Version
0.0.1-next.0
Status
stable

Generated from the package's public source.

API

Itemcomponent

                        Item(props: ToggleGroupItemProps): Element
                      

Props

class?
string
disabled?
boolean
style?
string | CSSProperties
value
string — The value this item represents.

children: Element

View source

Rootcomponent

                        Root(props: ToggleGroupRootProps): Element
                      

Props

class?
string
defaultValue?
string[] — Default value (uncontrolled).
disabled?
boolean
onValueChange?
(value: string[]) => void — Called when the selected values change.
orientation?
"horizontal" | "vertical" — Layout orientation.
style?
string | CSSProperties
type?
"single" | "multiple" — Selection mode: "single" allows one active item, "multiple" allows many.
value?
Accessor<string[] | undefined> — Controlled value.

children: Element

View source

ToggleGroupItemPropsinterface

Props

class?
string
disabled?
boolean
style?
string | CSSProperties
value
string — The value this item represents.

children: Element

View source

ToggleGroupRootPropsinterface

Props

class?
string
defaultValue?
string[] — Default value (uncontrolled).
disabled?
boolean
onValueChange?
(value: string[]) => void — Called when the selected values change.
orientation?
"horizontal" | "vertical" — Layout orientation.
style?
string | CSSProperties
type?
"single" | "multiple" — Selection mode: "single" allows one active item, "multiple" allows many.
value?
Accessor<string[] | undefined> — Controlled value.

children: Element

View source