BetaPublic beta — Read the release notes
Documentation

Multi Selector

Multi-select dropdown with checkbox items and search filtering.

Package
@solidiom/multi-selector
Version
0.6.0
Status
experimental

Generated from the package's public source.

API

Contentcomponent

                        Content(props: MultiSelectorContentProps): Element
                      

children: Element

View source

Itemcomponent

                        Item(props: MultiSelectorItemProps): Element
                      

Props

disabled?
boolean — Disabled state.
textValue?
string — Display/search text. Defaults to value.
value
string — Unique value for this item.

children: Element

View source

ItemIndicatorcomponent

                        ItemIndicator(props: MultiSelectorItemIndicatorProps): Element
                      

children: Element

View source

MultiSelectorContentPropsinterface

children: Element

View source

MultiSelectorItemIndicatorPropsinterface

children: Element

View source

MultiSelectorItemPropsinterface

Props

disabled?
boolean — Disabled state.
textValue?
string — Display/search text. Defaults to value.
value
string — Unique value for this item.

children: Element

View source

MultiSelectorRootPropsinterface

Props

class?
string — CSS class name.
defaultOpen?
boolean — Default open state when uncontrolled.
defaultValue?
string[] — Default selected keys (uncontrolled).
disabled?
boolean — Disabled state.
id?
string — Element id.
invalid?
boolean — Invalid state.
name?
string — Form field name for hidden input.
onOpenChange?
(open: boolean) => void — Called when open state changes.
onValueChange?
(values: string[]) => void — Called when selection changes.
open?
boolean — Controlled open state.
placeholder?
string — Placeholder text when no items are selected.
readOnly?
boolean — Read-only state.
required?
boolean — Required state.
value?
string[] — Controlled selected keys.

children: Element

View source

MultiSelectorSearchInputPropsinterface

Props

onValueChange?
(value: string) => void — Called when search value changes.
placeholder?
string — Placeholder for the search input.
value?
string — Controlled search value.

View source

MultiSelectorTagListPropsinterface

children: Element

View source

MultiSelectorTagPropsinterface

Props

value
string — The value of the item this tag represents.

children: Element

View source

MultiSelectorTagRemovePropsinterface

children: Element

View source

MultiSelectorTriggerPropsinterface

Props

aria-label?
string — Accessible name for the combobox trigger. Required by ARIA for role="combobox".

children: Element

View source

Rootcomponent

                        Root(props: MultiSelectorRootProps): Element
                      

Props

class?
string — CSS class name.
defaultOpen?
boolean — Default open state when uncontrolled.
defaultValue?
string[] — Default selected keys (uncontrolled).
disabled?
boolean — Disabled state.
id?
string — Element id.
invalid?
boolean — Invalid state.
name?
string — Form field name for hidden input.
onOpenChange?
(open: boolean) => void — Called when open state changes.
onValueChange?
(values: string[]) => void — Called when selection changes.
open?
boolean — Controlled open state.
placeholder?
string — Placeholder text when no items are selected.
readOnly?
boolean — Read-only state.
required?
boolean — Required state.
value?
string[] — Controlled selected keys.

children: Element

View source

SearchInputcomponent

                        SearchInput(props: MultiSelectorSearchInputProps): Element
                      

Props

onValueChange?
(value: string) => void — Called when search value changes.
placeholder?
string — Placeholder for the search input.
value?
string — Controlled search value.

View source

Tagcomponent

                        Tag(props: MultiSelectorTagProps): Element
                      

Props

value
string — The value of the item this tag represents.

children: Element

View source

TagListcomponent

                        TagList(props: MultiSelectorTagListProps): Element
                      

children: Element

View source

TagRemovecomponent

                        TagRemove(props: MultiSelectorTagRemoveProps): Element
                      

children: Element

View source

Triggercomponent

                        Trigger(props: MultiSelectorTriggerProps): Element
                      

Props

aria-label?
string — Accessible name for the combobox trigger. Required by ARIA for role="combobox".

children: Element

View source