feat: convert selected to signal model with two-way binding

Convert the selected input to a signal model.

BREAKING CHANGE: The selected input no longer mutates the original array
passed to the component. Applications that rely on the array being updated
in place must switch to two-way binding with [(selected)] to maintain
reactivity.

DEPRECATED: The `DatatableComponent.select` output is deprecated; use (selectedChange)
or two-way binding instead .

Before:
```html
<ngx-datatable [selected]="mySelection" (select)="onSelect($event)"></ngx-datatable>
```

After:
```html
<ngx-datatable [(selected)]="mySelection" (selectedChange)="onSelect({selected: $event})"></ngx-datatable>
<!-- or -->
<ngx-datatable [(selected)]="mySelection"></ngx-datatable>
```

Author: spike-rabbit

projects/ngx-datatable/src/lib/components/datatable.component.html

@@ -51,7 +51,6 @@
       [offsetX]="_offsetX"
       [rowDetail]="rowDetail"
       [groupHeader]="groupHeader"
-      [selected]="selected"
       [innerWidth]="_innerWidth"
       [bodyHeight]="bodyHeight"
       [selectionType]="selectionType()"
@@ -72,6 +71,7 @@
       [rowDragEvents]="rowDragEvents"
       [rowDefTemplate]="rowDefTemplate"
       [cssClasses]="cssClasses"
+      [(selected)]="selected"
       (page)="onBodyPage($event)"
       (activate)="activate.emit($event)"
       (rowContextmenu)="onRowContextmenu($event)"
@@ -105,7 +105,7 @@
       [pagerLeftArrowIcon]="cssClasses.pagerLeftArrow"
       [pagerRightArrowIcon]="cssClasses.pagerRightArrow"
       [pagerPreviousIcon]="cssClasses.pagerPrevious"
-      [selectedCount]="selected.length"
+      [selectedCount]="selected().length"
       [selectedMessage]="!!selectionType() && (messages.selectedMessage ?? 'selected')"
       [pagerNextIcon]="cssClasses.pagerNext"
       (page)="onFooterPage($event)"

projects/ngx-datatable/src/lib/components/datatable.component.ts

@@ -16,6 +16,7 @@ import {
   Input,
   IterableDiffer,
   IterableDiffers,
+  model,
   numberAttribute,
   OnDestroy,
   OnInit,
@@ -194,7 +195,7 @@ export class DatatableComponent<TRow extends Row = any>
    * represented as selected in the grid.
    * Default value: `[]`
    */
-  @Input() selected: TRow[] = [];
+  readonly selected = model<TRow[]>([]);
 
   /**
    * Enable vertical scrollbars
@@ -493,6 +494,19 @@ export class DatatableComponent<TRow extends Row = any>
 
   /**
    * A cell or row was selected.
+   * @deprecated Use two-way binding on `selected` instead.
+   *
+   * Before:
+   * ```html
+   * <ngx-datatable [selected]="mySelection" (select)="onSelect($event)"></ngx-datatable>
+   * ```
+   *
+   * After:
+   * ```html
+   * <ngx-datatable [selected]="mySelection" (selectedChange)="onSelect({selected: $event})"></ngx-datatable>
+   * <!-- or -->
+   * <ngx-datatable [(selected)]="mySelection"></ngx-datatable>
+   * ```
    */
   readonly select = output<SelectEvent<TRow>>();
 
@@ -682,15 +696,16 @@ export class DatatableComponent<TRow extends Row = any>
    * Returns if all rows are selected.
    */
   get allRowsSelected(): boolean {
-    let allRowsSelected = this.rows && this.selected && this.selected.length === this.rows.length;
+    const selected = this.selected();
+    let allRowsSelected = this.rows && selected && selected.length === this.rows.length;
 
     if (this.bodyComponent && this.selectAllRowsOnPage()) {
       const indexes = this.bodyComponent.indexes;
       const rowsOnPage = indexes().last - indexes().first;
-      allRowsSelected = this.selected.length === rowsOnPage;
+      allRowsSelected = selected.length === rowsOnPage;
     }
 
-    return this.selected && this.rows?.length !== 0 && allRowsSelected;
+    return selected && this.rows?.length !== 0 && allRowsSelected;
   }
 
   element = inject<ElementRef<HTMLElement>>(ElementRef).nativeElement;
@@ -1046,9 +1061,9 @@ export class DatatableComponent<TRow extends Row = any>
     });
 
     if (this.selectAllRowsOnPage()) {
-      this.selected = [];
+      this.selected.set([]);
       this.select.emit({
-        selected: this.selected
+        selected: this.selected()
       });
     }
   }
@@ -1186,9 +1201,9 @@ export class DatatableComponent<TRow extends Row = any>
   onColumnSort(event: SortEvent): void {
     // clean selected rows
     if (this.selectAllRowsOnPage()) {
-      this.selected = [];
+      this.selected.set([]);
       this.select.emit({
-        selected: this.selected
+        selected: this.selected()
       });
     }
 
@@ -1230,14 +1245,13 @@ export class DatatableComponent<TRow extends Row = any>
       // before we splice, chk if we currently have all selected
       const first = this.bodyComponent.indexes().first;
       const last = this.bodyComponent.indexes().last;
-      const allSelected = this.selected.length === last - first;
-
-      // remove all existing either way
-      this.selected = [];
+      const allSelected = this.selected().length === last - first;
 
       // do the opposite here
       if (!allSelected) {
-        this.selected.push(...this._internalRows.slice(first, last).filter(row => !!row));
+        this.selected.set(this._internalRows.slice(first, last).filter(row => !!row) as TRow[]);
+      } else {
+        this.selected.set([]);
       }
     } else {
       let relevantRows: TRow[];
@@ -1250,25 +1264,24 @@ export class DatatableComponent<TRow extends Row = any>
         relevantRows = this.rows.filter(row => !!row);
       }
       // before we splice, chk if we currently have all selected
-      const allSelected = this.selected.length === relevantRows.length;
-      // remove all existing either way
-      this.selected = [];
+      const allSelected = this.selected().length === relevantRows.length;
       // do the opposite here
       if (!allSelected) {
-        this.selected.push(...relevantRows);
+        this.selected.set(relevantRows);
+      } else {
+        this.selected.set([]);
       }
     }
 
     this.select.emit({
-      selected: this.selected
+      selected: this.selected()
     });
   }
 
   /**
    * A row was selected from body
    */
   onBodySelect(selected: TRow[]): void {
-    this.selected.splice(0, this.selected.length, ...selected);
     this.select.emit({ selected });
   }
 

projects/ngx-datatable/src/lib/types/public.types.ts

@@ -238,6 +238,7 @@ export const SelectionType = {
 
 export type SelectionType = (typeof SelectionType)[keyof typeof SelectionType];
 
+/** @deprecated. Use two-way binding instead. See {@link DatatableComponent.select} */
 export interface SelectEvent<TRow> {
   selected: TRow[];
 }

src/app/selection/selection-single.component.ts

@@ -1,10 +1,5 @@
 import { Component, inject } from '@angular/core';
-import {
-  ActivateEvent,
-  DatatableComponent,
-  SelectEvent,
-  TableColumn
-} from '@siemens/ngx-datatable';
+import { ActivateEvent, DatatableComponent, TableColumn } from '@siemens/ngx-datatable';
 
 import { Employee } from '../data.model';
 import { DataService } from '../data.service';
@@ -43,9 +38,9 @@ import { DataService } from '../data.service';
           [headerHeight]="50"
           [footerHeight]="50"
           [limit]="5"
-          [selected]="selected"
+          [(selected)]="selected"
           (activate)="onActivate($event)"
-          (select)="onSelect($event)"
+          (selectedChange)="onSelect($event)"
         />
       </div>
 
@@ -80,9 +75,9 @@ export class SingleSelectionComponent {
     });
   }
 
-  onSelect({ selected }: SelectEvent<Employee>) {
+  onSelect(employees: Employee[]) {
     // eslint-disable-next-line no-console
-    console.log('Select Event', selected, this.selected);
+    console.log('Select Event', employees);
   }
 
   onActivate(event: ActivateEvent<Employee>) {