Skip to main content
cngx-src documentation

createSelectionController

Functioncore/utils/selection

projects/core/utils/selection-controller.ts

Description#

Create a signal-based selection engine that reads and writes an external WritableSignal<T[]>.

const values = signal<User[]>([]);
const selection = createSelectionController(values, { keyFn: (u) => u.id });

selection.select(alice);
selection.isSelected(alice)();      // true
selection.isSelected(alice) === selection.isSelected(alice); // stable

Signature#

createSelectionController(values: WritableSignal, options?: SelectionControllerOptions)

Parameters#

Returns#

SelectionController