NEURALNG

PUBLIC CONTRACT

MultiSelect API

Inputs and models

NameTypeDefaultPurpose
optionsreadonly TOption[][] Immutable source options.
optionLabelstring'label' Visible and accessible label path.
optionValuestring'value' Model value path.
optionDisabledstring'disabled' Disabled-state path.
optionGroupstring'' Optional group label path.
valuereadonly TValue[][] Two-way immutable Signal model.
filterValuestring'' Two-way filter query model.
display'chip' | 'comma''chip' Selected-value presentation.
dataMode'local' | 'remote''local' Filtering ownership.
filterMode'contains' | 'startsWith' | 'endsWith''contains' Local matching strategy.
filterBy / filterLocalestring'' Nested paths and matching locale.
filterbooleantrue Shows the filter input.
showToggleAllbooleantrue Shows visible-option select all.
clearablebooleantrue Shows the clear action.
closeOnSelectbooleanfalse Closes after each toggle.
selectionLimitnumber0 Maximum selections; zero is unlimited.
maxSelectedLabelsnumber3 Comma labels before count summary.
filterDelaynumber150 Debounced filter event delay in ms.
virtualScrollbooleanfalse Enables fixed-height windowing.
virtualItemSizenumber42 Option row height in pixels.
virtualScrollHeightnumber256 List viewport height in pixels.
virtualOverscannumber3 Extra rows around viewport.
loadingbooleanfalse Shows localized busy content.
disabled / readonlybooleanfalse Interaction policies.
required / invalidbooleanfalse ARIA and validation states.
pending / touched / dirtybooleanfalse Forms state hooks.
fluidbooleanfalse Fills available inline size.
placeholder / filterPlaceholderstringlocale Trigger and filter labels.
emptyLabel / loadingLabelstringlocale Status labels.
selectedItemsLabelstringlocale Collapsed count pattern.
selectAllLabel / clearLabelstringlocale Action labels.
dropdownLabel / removeLabelstringlocale Accessible action patterns.
ariaLabelstring'' Combobox and listbox name.
multiSelectId / namestring'' Control identity and Forms name.
dropdownIconClassstring'nt-chevron-down' Dropdown glyph.
clearIconClass / removeIconClassstring'nt-x' Removal glyphs.
searchIconClass / checkIconClassstringNeural Icons Filter and selection glyphs.
loadingIconClassstring'nt-loader-3 nt-spin' Busy glyph.
compareWithfunctionObject.is Custom value equality.
unstyledbooleanfalse Removes visual classes.
multiSelectClassstring'' Additive root class.
classesNeuralMultiSelectClasses{} Typed slot classes.

Outputs

valueChangereadonly TValue[] Generated by the value model.
filterValueChangestring Generated by the filter model.
selectionChangeNeuralMultiSelectChange Current/previous arrays, option and source.
selected / removedNeuralMultiSelectItemEvent One option was added or removed.
clearedNeuralMultiSelectClearEvent Explicit clear with previous values.
selectAllChangeNeuralMultiSelectSelectAllEvent Visible enabled options changed together.
filterChangeNeuralMultiSelectFilterEvent Debounced query and monotonic requestId.
opened / closedvoid Popover lifecycle.
touchvoid Completed interaction.

Public methods

focus(options?: FocusOptions)

Focuses the combobox trigger.

reset()

Closes, clears filter and restores an empty array.

openPanel / closePanel()

Controls popup visibility.

togglePanel(event?: Event)

Toggles when enabled.

clear(event?: Event)

Clears mutable selections.

toggleAll(event?: Event)

Toggles visible enabled options.

Typed templates

neuralMultiSelectOption

Context: option, resolved, label, value, index, active, selected, disabled

neuralMultiSelectValue

Context: value, labels

neuralMultiSelectGroup

Context: group

neuralMultiSelectHeader

Context: No context

neuralMultiSelectFooter

Context: No context

neuralMultiSelectEmpty

Context: $implicit localized empty label

neuralMultiSelectLoading

Context: $implicit localized loading label

Typed class slots

roottriggervalueplaceholderchipListchipchipLabelchipRemoveclearButtondropdownButtoniconpanelheaderfilterselectAlllistgroupoptionoptionLabelcheckboxactiveOptionselectedOptiondisabledOptionemptyMessageloadingMessagefooter