BetaPublic beta — Read the release notes
Solidiom
Get Started
Documentation

Select

Dropdown selection from a list of options.

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

Generated from the package's public source.

API

Contentcomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        Content(props: SelectContentProps): Element

Props

ref?
(el: HTMLDivElement) => void

children: Element

View source

HiddenInputcomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        HiddenInput(): Element

View source

Itemcomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        Item(props: SelectItemProps): Element

Props

disabled?
boolean — Disabled state.
textValue?
string — Text for typeahead matching. Defaults to value.
value
string — Unique value for this item.

children: Element

View source

Rootcomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        Root(props: SelectRootProps): Element

Props

defaultOpen?
boolean
defaultValue?
string | string[]
disabled?
Accessor<boolean> — Disabled state.
multiple?
boolean — Multiple selection mode.
name?
string — Form field name for hidden input.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void
onValueChange?
(value: string | string[], details: ChangeDetails<SelectReason>) => void
open?
Accessor<boolean> — Controlled open state.
value?
Accessor<string | string[] | undefined> — Controlled value.

children: Element

View source

ScrollDownButtoncomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        ScrollDownButton(props: SelectScrollDownButtonProps): Element

Props

class?
string
style?
string | CSSProperties

children: Element

View source

ScrollUpButtoncomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        ScrollUpButton(props: SelectScrollUpButtonProps): Element

Props

class?
string
style?
string | CSSProperties

children: Element

View source

SelectContentPropsinterface

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

Props

ref?
(el: HTMLDivElement) => void

children: Element

View source

SelectItemPropsinterface

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

Props

disabled?
boolean — Disabled state.
textValue?
string — Text for typeahead matching. Defaults to value.
value
string — Unique value for this item.

children: Element

View source

SelectRootPropsinterface

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

Props

defaultOpen?
boolean
defaultValue?
string | string[]
disabled?
Accessor<boolean> — Disabled state.
multiple?
boolean — Multiple selection mode.
name?
string — Form field name for hidden input.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void
onValueChange?
(value: string | string[], details: ChangeDetails<SelectReason>) => void
open?
Accessor<boolean> — Controlled open state.
value?
Accessor<string | string[] | undefined> — Controlled value.

children: Element

View source

SelectScrollDownButtonPropsinterface

Props for the select scroll down button.

Props

class?
string
style?
string | CSSProperties

children: Element

View source

SelectScrollUpButtonPropsinterface

Props for the select scroll up button.

Props

class?
string
style?
string | CSSProperties

children: Element

View source

SelectTriggerPropsinterface

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

Props

aria-label?
string — Accessible name for the trigger when no visible label is present.
aria-labelledby?
string — ID reference to an external visible label.
ref?
(el: HTMLButtonElement) => void

children: Element

View source

SelectValuePropsinterface

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

Props

placeholder?
string — Placeholder when no value is selected.

View source

Triggercomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        Trigger(props: SelectTriggerProps): Element

Props

aria-label?
string — Accessible name for the trigger when no visible label is present.
aria-labelledby?
string — ID reference to an external visible label.
ref?
(el: HTMLButtonElement) => void

children: Element

View source

Valuecomponent

@solidiom/select — Headless select primitive. Parts: Root, Trigger, Content, Item, Value, HiddenInput, ScrollUpButton, ScrollDownButton.

                        Value(props: SelectValueProps): Element

Props

placeholder?
string — Placeholder when no value is selected.

View source