ReorderCommitHandlerOptions

Interface

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

Info
API

Import#

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

Description#

Configuration for createReorderCommitHandler.

Index#

Properties

commitAction commitController commitMode getLastCommitted onAnnounce onError onReorder onStateChange setLastCommitted values

Instance Properties#

commitAction#Signal

Readonly

Current commit action - read per dispatch for supersede safety.

commitController#CngxCommitController

Readonly

Shared low-level commit controller. Reorder commits bypass createArrayCommitHandler (whose sameArrayContents would skip same-membership writes) and drive this controller directly.

commitMode#Signal

Readonly

Optimistic vs pessimistic commit UX.

getLastCommitted#function

Readonly

Read the last successfully committed snapshot (rollback target).

onAnnounce#function

Readonly

Announce the reorder. Pulled out so consumers can route to a custom announcer without forking.

onError#function

Readonly

Hook for the consumer's commitError output.

onReorder#function

Readonly

Emit selectionChange + reordered payload. Consumer controls the shape; signature covers optimistic / pessimistic / no-commit branches.

onStateChange#function

Readonly

Hook for the consumer's stateChange output.

setLastCommitted#function

Readonly

Update the rollback snapshot. Called on optimistic-mode begin (stash pre-reorder state) and on success (store canonicalised server value).

values#WritableSignal

Readonly

Component's primary value signal.