ArrayCommitHandlerOptions

Interface

projects/forms/select/shared/array-commit-handler.ts

Info
API

Import#

import { ArrayCommitHandlerOptions } from '@cngx/forms/select'

Description#

Configuration for createArrayCommitHandler.

Index#

Properties

announceError commitAction commitMode compareWith core getLastCommitted onClearFinalize onError onStateChange onToggleFinalize values

Instance Properties#

announceError#function

ReadonlyOptional

Announce a failed commit to AT. Wire this to the commit-error announcer (CNGX_COMMIT_ERROR_ANNOUNCER_FACTORY) so the live region carries real error content. When omitted the handler announces nothing on error - the visual error surface and onError still fire; it never falls back to the misleading "selection cleared" phrase.

commitAction#Signal

Readonly

commitMode#Signal

Readonly

compareWith#Signal>

Readonly

Element-wise equality for value reconciliation.

core#CngxSelectCore

Readonly

Source of commitController, togglingOption, announce.

getLastCommitted#function

Readonly

Last committed snapshot. Consumer updates it before each beginToggle/ beginClear so retryLast replays against the correct rollback target.

onClearFinalize#function

Readonly

Consumer emits cleared + selectionChange(action:'clear').

onError#function

Readonly

onStateChange#function

Readonly

onToggleFinalize#function

Readonly

Consumer emits selectionChange/optionToggled and announces.

values#WritableSignal

Readonly

Component's primary value signal (multi-select / combobox).