ISelectProps
Full prop surface for <OrigamSelect>. Aggregates the text-field base, density, adjacent slots, field chrome, input contract, spacing, border, rounded, elevation, item list configuration, transitions, filters, and lazy loading, then adds select-specific behaviour: chips, multiple selection, menu control, autocomplete, and search.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- chipsboolean
- Renders selected values as chip tags inside the control instead of plain text.
- closableChipsboolean
- Adds a close/remove button to each selection chip. Requires chips=true.
- hideNoDataboolean
- Hides the "no data" message in the dropdown when the search returns no results.
- hideSelectedboolean
- Removes already-selected items from the dropdown list (useful for multiple selects).
- listPropsIListProps
- Props forwarded to the internal OrigamList rendered inside the dropdown.
- menuboolean
- v-model:menu — controls the open/closed state of the dropdown programmatically.
- menuIconTIcon
- Icon shown in the append-inner slot to indicate the dropdown is available. Defaults to mdi-chevron-down.
- menuPropsIMenuProps
- Props forwarded to the internal OrigamMenu (position, max-height, transition, etc.).
- chipPropsIChipProps
- Props forwarded to every selection chip (color, size, variant…).
- multipleboolean
- Allows selecting more than one item. modelValue becomes an array.
- noDataTextstring
- Text displayed when the dropdown list is empty or the search yields no results.
- openOnClearboolean
- Re-opens the dropdown after the user clears the selection via the clear icon.
- autocompleteboolean
- Enables text-input filtering — the user types to narrow the dropdown list.
- autoSelectFirstboolean | string
- Auto-highlights the first matching item while the user types. Pass "exact" to restrict to exact-match prefix.
- clearOnSelectboolean
- Clears the search input after an item is selected (useful for multiple autocomplete).
- dividerstring
- Character used to separate multi-select values in the display string.
- searchstring
- v-model:search — exposes the autocomplete search string for external control.
- closeTextstring
- Accessible label for the close/collapse action on the dropdown.
- openTextstring
- Accessible label for the open/expand action on the dropdown.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Multi-select with chips and autocomplete