UI Library

Prop Type Default Value Notes
activeValuestring?''
Committed option value (not its label); marked in the panel.
align'left' | 'right''left'
Panel edge anchored to the trigger.
allowCustomValuebooleanfalse
Enter commits typed text that matches no option (filterable only).
ariaLabelstring?—
Accessible name for the control.
autoPlacebooleantrue
Flips the panel when crowded.
buttonClassstring?built-in
Replaces the trigger button box classes.
buttonLabelstring?derived
Overrides the trigger label; omit it and the trigger shows the committed option's label (or the raw value).
clearLabelstring?'Clear selection'
Accessible name for the clear button.
clearablebooleanfalse
Appends a cross button that clears the value.
controlClassstring?built-in
Replaces the filterable trigger box classes.
defaultValuestring?''
Baseline the clear button compares against: the option value (not its label); the cross hides while the committed value matches it.
emptyLabelstring?—
Shown when the filtered list is empty.
filterablebooleanfalse
Renders a combobox input with filtering.
hideOutlinebooleanfalse
Drops the bordered trigger’s border, hover tint, and focus border while keeping its surface, metrics, and text rules.
leadingSnippet—
Content rendered in the trigger before the text; it sits in flow and is sized by the caller (a leading search icon or glyph).
optionClassstring?built-in
Replaces the option row classes.
options(string | { value: string; label?: string })[]—
Selectable options; a bare string (or a missing label) displays as its own value. The eye resets to the default options.
panelClassstring?built-in
Replaces the floating panel classes.
ratiosSelectRatioOverrides?—
Partial override of the trigger and option-row ratios (font, paddings, the chevron’s border gutter and label gap, min-width, gap, icon); the line box follows the font and both chevron metrics stay independent of padX.
size'xs' | 'sm' | 'md' | 'lg' | 'xl' | number'md'
Control scale; numbers are icon-scale pixels interpolated between the steps.
trailerSnippet—
Content rendered outside the trigger, after it (and after the clear affordance).
variant'bordered' | 'embedded''bordered'
Chrome variant; embedded drops the border, surface, and focus styles for a trigger inside another surface.
onClear() => voidonSelect(default)—Clear handler; selects the default value when omitted.
onSelect(value: string) => void——Called with the chosen value.