Menu
Documentation

Select

TairoSelect and TairoSelectItem are enhanced versions of Shuriken UI's select components, offering additional features and improved styling.

Example

Components

TairoSelect

BaseSelect
Model Type
v-model
AcceptableValue | AcceptableValue[]

The controlled value of the Select. Can be bind as `v-model`.

Prop Type
autocomplete
default:-
string

Native html input `autocomplete` attribute.

bindings
default:-
{ trigger?: SelectTriggerProps; portal?: SelectPortalProps; content?: SelectContentProps; viewport?: SelectViewportProps; }

Optional bindings to pass to the inner components.

by
default:-
string | ((a: AcceptableValue, b: AcceptableValue) => boolean)

Use this to compare objects by a particular field, or pass your own comparison function for complete control over how objects are compared.

classes
default:-
{ text?: string | string[]; icon?: string | string[]; content?: string | string[]; buttonUp?: string | string[]; buttonDown?: string | string[]; viewport?: string | ... 1 more ...; }

Optional classes to pass to the inner components.

default-open
default:-
boolean

The open state of the select when it is initially rendered. Use when you do not need to control its open state.

default-value
default:-
AcceptableValue | AcceptableValue[]

The value of the select when initially rendered. Use when you do not need to control the state of the Select

dir
default:-
Direction

The reading direction of the combobox when applicable. If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.

disabled
default:-
boolean

When `true`, prevents the user from interacting with Select

icon
default:-
string
id
default:-
string

The form input identifier.

items
default:-
BaseSelectItemProps<AcceptableValue>[]

The defaults items to display for the select input.

multiple
default:-
boolean

Whether multiple options can be selected or not.

name
default:-
string

The name of the field. Submitted with its owning form as part of a name/value pair.

open
default:-
boolean

The controlled open state of the Select. Can be bind as `v-model:open`.

placeholder
default:-
string

The placeholder to display for the select input.

preset
default:-
"aligned" | "popper"

Bindings presets

required
default:-
boolean

When `true`, indicates that the user must set the value before the owning form can be submitted.

rounded
default:"md"
"md" | "none" | "sm" | "lg" | "full"

The radius of the select input.

size
default:-
"md" | "sm" | "lg" | "xl"

The size of the select input.

variant
default:"default"
"default" | "muted"

The variant of the select input.

Event Emitted Value Type
update:open
[value: boolean]
Slot Type
#default
{}

TairoSelectItem

BaseSelectItem
Prop Type
value
default:-
AcceptableValue

The value given as data when submitted with a `name`.

as
default:-
AsTag | Component

The element or component this component should render as. Can be overwritten by `asChild`.

as-child
default:-
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior. Read our [Composition](https://www.reka-ui.com/docs/guides/composition) guide for more details.

disabled
default:-
boolean

When `true`, prevents the user from interacting with the item.

icon
default:-
string
media
default:-
string
name
default:-
string
text
default:-
string
text-value
default:-
string

Optional text used for typeahead purposes. By default the typeahead behavior will use the `.textContent` of the `SelectItemText` part. Use this when the content is complex, or you have non-textual content inside.