Selection
| Method | Type | Description |
|---|---|---|
getSelected() | () => T[] | Currently selected option objects. |
setSelected(values, opts?) | (values, { notify? }) => void | Set selected values (pass [] to clear). notify: true fires change. |
getValue() | () => string | number | (…)[] | null | Serialized value per value-format. |
selectedValue | getter | Read-only serialized value. |
selectedItem | getter | First selected option (single-select) or null. |
Dropdown
Imperative open/close added in v2.0.0.
| Method | Type | Description |
|---|---|---|
open() v2.0.0 | () => void | Open the dropdown (flushes pending property writes first). |
close() v2.0.0 | () => void | Close the dropdown. |
toggle() v2.0.0 | () => void | Toggle open/closed. |
isOpen v2.0.0 | getter/setter | Read or assign the open state. |
Search & scroll
The search-text control and scroll-to API are new in v2.0.0.
| Method | Type | Description |
|---|---|---|
searchText v2.0.0 | getter | Current search-box text. |
search(term) v2.0.0 | (term: string) => void | Set the search text and filter as if typed (runs beforeSearch / min-length / async). Does not open the dropdown. |
clearSearch() v2.0.0 | () => void | Clear the search and restore the full list. |
scrollToIndex(i, opts?) v2.0.0 | (i, { block? }) => boolean | Scroll to the option at index in the filtered list. |
scrollToValue(v, opts?) v2.0.0 | (v, { block? }) => boolean | Scroll to the option with this value (false if filtered out / under a collapsed branch). |
scrollToGroup(name, opts?) v2.0.0 | (name, { block? }) => boolean | Scroll to a group header / first group option. |
Messaging & lifecycle
| Method | Type | Description |
|---|---|---|
ready() v2.1.0 | () => void | Release the defer render gate: build the picker once with everything wired while deferred (flushes pending writes first). No-op if not deferred or already built. Latched; fires the ready event. |
isReady v2.1.0 | getter | Whether the picker has been built (the ready event has fired). False while a defer gate is held. Reflected as the is-ready attribute. |
showMessage(content, opts?) v2.0.0 | (content, { variant?, duration?, placement? }) => void | Show a transient toast (visible even in the fullscreen overlay). |
hideMessage() v2.0.0 | () => void | Dismiss the transient message. |
refresh() v2.4.0 | () => void | Re-render from the current option set without re-ingesting it — the companion to assigning options. Call it after mutating an option object in place (e.g. flipping a disabled flag) or when external state a render callback reads changed (an i18n labels map, getDisabledCallback, a custom renderer). Re-projects the filtered/tree view honouring the active search term, reconciles the selection, and repaints — silently (no select/deselect/change). |
destroy() | () => void | Clean up (called automatically on disconnect). |
Example
Imperative usage