Skip to content

Select

Copy editable source into an initialized application:

Terminal window
pnpm dlx @simurgh-ui/cli add select

For package consumption, import from the component subpath and load its optional recipe CSS:

import { Select } from '@simurgh-ui/react/select';
import '@simurgh-ui/styles/select.css';
import {
Select,
SelectOption,
} from '@simurgh-ui/vue/select';
import '@simurgh-ui/styles/select.css';
import {
SelectComponent,
SelectOption,
} from '@simurgh-ui/angular/select';
import '@simurgh-ui/styles/select.css';

Omit the component stylesheet for fully headless styling. CLI-copied components use the local path written to simurgh.json and the copied application styles instead of these package imports.

Select owns combobox/listbox state, disabled options, selection events, and a hidden native form value. Supply a visible placeholder that also names the trigger.

The optional component stylesheet provides a complete default recipe, including visual hierarchy and interaction states. Consumers can override semantic tokens or omit the recipe.

Live component Select

The public component parts are listed in API surface below. Use only the parts needed by the example; compound components depend on their documented parent/child nesting.

Controlled state remains the application’s source of truth and must be updated from every change event. Uncontrolled state reads its default only when the component mounts. Do not pass both forms of the same state at once.

FrameworkExact state contract and reset behavior
ReactControlled: value + onValueChange. Uncontrolled: defaultValue. Reset controlled state by assigning the initial value; reset uncontrolled state by changing a React key.
VueControlled: v-model (modelValue + update:modelValue). No uncontrolled prop is exposed. Reset the model ref to its initial value; reset uncontrolled state with a changed Vue :key.
AngularControlled two-way binding: [(value)] (value + valueChange). Angular exposes no separate default input; initialize and reset the bound class field explicitly.

React

const initialValue = '';
const [value, setValue] = useState(initialValue);
const [resetKey, setResetKey] = useState(0);
<Select value={value} onValueChange={setValue}></Select>
<button onClick={() => setValue(initialValue)}>Reset controlled</button>
<Select key={resetKey} defaultValue={initialValue}></Select>
<button onClick={() => setResetKey((key) => key + 1)}>Reset uncontrolled</button>

Vue

<script setup lang="ts">
import { ref } from 'vue';
const initial = '';
const state = ref(initial);
const resetKey = ref(0);
</script>
<Select v-model="state"></Select>
<button @click="state = initial">Reset controlled</button>

Angular

initial = '';
value = this.initial;
reset() { this.value = this.initial; }
<simurgh-select [(value)]="value"></simurgh-select>
<button type="button" (click)="reset()">Reset</button>

name, value, required, and disabled mirror native form concepts. Third-party form adapters are intentionally outside v1.

<Select name="city" options={[{ value: 'tehran', label: 'Tehran' }]} onValueChange={setCity} />

These keys describe behavior implemented by the adapters. Native Tab, Enter, and Space behavior still applies to descendant links, buttons, and form controls unless the component overrides it.

Concern / keysBehavior
Focus entry and exit (Tab / Shift+Tab)Tab reaches the trigger and leaves normally.
Navigation and activationArrow Down/Up opens and moves options; Home/End moves to first/last; Enter or Space selects.
EscapeCloses the option list without changing focus.
RTL differencesNo RTL-specific key mapping.
TypeaheadNot supported.

Preserve the documented composition and accessible names when wrapping or restyling this component. See accessibility and RTL guidance for keyboard, focus, labeling, and directionality requirements.

  • React exports: Select
  • Vue exports: Select
  • Angular exports: SelectComponent, SelectOption

Import these public symbols from the component subpath shown in Installation. Framework-specific props, events, slots, directives, methods, defaults, and native-attribute behavior belong in the API tables on this page; use the linked source only to verify the current implementation.

React API reference

An inherited-attributes entry means the component accepts the complete named React native interface, including its event handlers and ARIA and data attributes. Remaining attributes are forwarded to the rendered element unless the component behavior described on this page overrides them.

Complete props type: { options: SelectOption[]; name?: string; value?: string; defaultValue?: string; required?: boolean; disabled?: boolean; onValueChange?: (value: string) => void; placeholder?: ReactNode; }.

PropTypeDefault / requirement
defaultValuestringundefined
disabledbooleanundefined
namestringundefined
onValueChange(value: string) => voidundefined
optionsSelectOption[]Required
placeholderReactNodeundefined
requiredbooleanundefined
valuestringundefined
Vue API reference

Boolean props without explicit defaults use Vue’s false default. Undeclared attributes follow the fallthrough behavior stated for each component.

Vue attribute fallthrough is enabled for the rendered root.

PropTypeDefault / requirement
modelValuestring''
optionsSelectOption[]Required
namestringundefined
requiredbooleanfalse
disabledbooleanfalse
placeholderstring'Select…'
EventPayload
update:modelValuestring

Slots: none.

Exposed methods: none.

Exported type: { value: string; label: string; disabled?: boolean; }.

Angular API reference

Inputs and outputs use their public template names. Public methods are callable through a template reference or ViewChild. Native attributes apply to the documented template root or directive host; they are not automatically forwarded through component hosts.

Component selector: simurgh-select. The template’s first native element is button.

InputTypeDefault / requirement
optionsSelectOption[][]
valuestring''
placeholderstring'Select…'
namestringundefined
requiredbooleanfalse
disabledbooleanfalse
OutputPayload
valueChangestring

Content projection: none.

Public method
toggle(): void
show(): void
onTriggerKeydown(event: KeyboardEvent): void
onListKeydown(event: KeyboardEvent): void
select(value: string): void

Exported type: { value: string; label: string; disabled?: boolean; }.

Follow the framework example as a structural contract. Root components own shared state; parts that consume that state must stay under the root (or be attached to projected descendants in Angular). Parts described as conditional are optional until their corresponding interaction or semantic region is used. Do not render a state-consuming part by itself.

FrameworkRequired parent/child relationshipConditional partsSupporting types
ReactSelect is standalone and required when using this component.Content is optional unless the API requires a label or value.None.
VueSelect is standalone and required when using this component.Content is optional unless the API requires a label or value.SelectOption.
AngularSelectComponent is standalone and required when using this component.Content is optional unless the API requires a label or value.SelectOption.

Accessible names, descriptions, and form labels remain required whenever the component’s purpose cannot otherwise be determined, even when the corresponding visual part is optional.

The adapters target the same user-visible behavior and accessibility contract. Their public shapes follow each framework’s conventions and are not expected to be symbol-for-symbol identical.

ConcernContract
Public compositionReact exports 1 parts, Vue 2, and Angular 2. These are intentional composition differences; use each framework’s example rather than translating symbol-for-symbol.
State and change eventsReact uses controlled/default props and callbacks for value; Vue uses v-model; Angular uses [(value)].
Children and contentReact uses children; Vue uses the slots listed above; Angular uses the documented content projection selectors.
Native attributesReact forwards the named native interface; Vue follows the stated fallthrough rule; Angular attributes apply to the component host unless an input, directive, or documented native root consumes them.
Imperative accessReact has no forwarded ref; Vue exposes no methods; Angular exposes the listed class methods through a template reference or ViewChild.

These differences are intentional adapter design. Behavioral or accessibility differences not stated on this page are parity defects rather than supported variations.

Use name="plan" to serialize the current value under the documented field name. The examples initialize the field, keep its value application-owned, forward disabled and required, render an accessible error, and read the browser submission payload. This component has no public invalid prop; announce validation errors next to the labeled control and use native validity where available.

const initial = 'pro';
const [value, setValue] = useState(initial);
const [errors, setErrors] = useState<Record<string, string>>({});
<form onSubmit={(event) => {
event.preventDefault();
const data = new FormData(event.currentTarget);
// Submit data.get('plan').
}}>
<Select name="plan" value={value} onValueChange={setValue}
required disabled={isDisabled} />
{errors.plan && <p role="alert">{errors.plan}</p>}
<button type="submit">Submit</button>
</form>
<script setup lang="ts">
import { reactive, ref } from 'vue';
const initial = 'pro';
const value = ref(initial);
const errors = reactive<Record<string, string>>({});
function submit(event: Event) {
const data = new FormData(event.currentTarget as HTMLFormElement);
// Submit data.get('plan').
}
</script>
<form @submit.prevent="submit">
<Select v-model="value" name="plan" required :disabled="isDisabled"></Select>
<p v-if="errors.plan" role="alert">{{ errors.plan }}</p>
<button type="submit">Submit</button>
</form>
initial = 'pro';
value = this.initial;
errors: Record<string, string> = {};
submit(form: HTMLFormElement) {
const data = new FormData(form);
// Submit data.get('plan').
}
<form #form (submit)="submit(form); $event.preventDefault()">
<simurgh-select [(value)]="value" name="plan" required [disabled]="isDisabled"></simurgh-select>
<p *ngIf="errors.plan" role="alert">{{ errors.plan }}</p>
<button type="submit">Submit</button>
</form>

For Angular reactive or template-driven forms, bridge the documented value/valueChange pair to your form control. The component does not implement ControlValueAccessor; update disabled and validation state from the Angular form explicitly.

The table distinguishes component behavior from application-owned presentation. “Not supported” means there is no public state contract for that adapter; do not invent one with an undocumented attribute. Keep status and error messages accessible when they are rendered outside the component.

StateReactVueAngular
LoadingNot supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.
EmptyRender an application-owned empty message when the options collection is empty.Render an application-owned empty message when the options collection is empty.Render an application-owned empty message when the options collection is empty.
InvalidNot supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.
Read-onlyNot supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.
DisabledSupported with disabled={true} on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.Supported with :disabled="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.Supported with [disabled]="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.
ErrorNot supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.Not supported by this component API; handle this state in surrounding application UI.
Styling contract

The selectors below are used by the published component recipe or emitted consistently by an adapter. Treat these as the supported styling surface. Element order, anonymous wrappers, and undocumented descendants are implementation details and should not be targeted.

SurfaceStable hooks
Recipe classes.simurgh-content, .simurgh-indicator, .simurgh-item, .simurgh-trigger
Stable DOM parts[data-slot="button"], [data-slot="checkbox"], [data-slot="input"], [data-slot="input-otp"], [data-slot="menubar-item"], [data-slot="native-select"], [data-slot="pagination-link"], [data-slot="select-content"], [data-slot="select-option"], [data-slot="select-trigger"], [data-slot="toggle-group-item"], [data-slot="toolbar-button"]
Stable data attributes[data-density], [data-highlighted], [data-slot]
ARIA/state selectors used by the recipe[aria-disabled], [aria-expanded], [aria-selected]
CSS custom properties consumed--simurgh-border, --simurgh-control-height, --simurgh-control-padding, --simurgh-duration, --simurgh-foreground, --simurgh-item-height, --simurgh-muted, --simurgh-primary, --simurgh-radius, --simurgh-reference-width, --simurgh-ring, --simurgh-shadow, --simurgh-surface

Prefer a semantic token override for theme-wide changes. Use the listed class or part selectors for a component-scoped override. When omitting recipe CSS, preserve state attributes and ARIA semantics even if your replacement styles use different selectors.

Load the optional component stylesheet for the default recipe, override semantic tokens for broad theme changes, or omit the recipe CSS for headless styling. See theming and styling hooks for import order, selectors, dark mode, RTL, and reduced-motion guidance.

Last verified on 2026-08-13 against Simurgh registry 0.1.1.