feat(sort): add default sort field as grid option

- when clearing sorting, the default is to use as sort is "id". This new grid option allows to provide another field id.

Author: ghiscoding-SE

package.json

@@ -90,7 +90,7 @@
     "lodash.isequal": "^4.5.0",
     "moment-mini": "^2.22.1",
     "rxjs": "^6.3.3",
-    "slickgrid": "^2.4.18",
+    "slickgrid": "^2.4.19",
     "text-encoding-utf-8": "^1.0.2"
   },
   "devDependencies": {

src/app/examples/grid-basic.component.ts

@@ -1,5 +1,5 @@
 import { Component, OnInit } from '@angular/core';
-import { Column, GridOption } from './../modules/angular-slickgrid';
+import { Column, GridOption, Formatters } from './../modules/angular-slickgrid';
 
 const NB_ITEMS = 995;
 
@@ -27,8 +27,8 @@ export class GridBasicComponent implements OnInit {
       { id: 'title', name: 'Title', field: 'title', sortable: true },
       { id: 'duration', name: 'Duration (days)', field: 'duration', sortable: true },
       { id: '%', name: '% Complete', field: 'percentComplete', sortable: true },
-      { id: 'start', name: 'Start', field: 'start' },
-      { id: 'finish', name: 'Finish', field: 'finish' },
+      { id: 'start', name: 'Start', field: 'start', formatter: Formatters.dateIso },
+      { id: 'finish', name: 'Finish', field: 'finish', formatter: Formatters.dateIso },
       { id: 'effort-driven', name: 'Effort Driven', field: 'effortDriven', sortable: true }
     ];
     this.gridOptions1 = {
@@ -69,8 +69,8 @@ export class GridBasicComponent implements OnInit {
         title: 'Task ' + i,
         duration: Math.round(Math.random() * 100) + '',
         percentComplete: randomPercent,
-        start: `${randomMonth}/${randomDay}/${randomYear}`,
-        finish: `${randomMonth}/${randomDay}/${randomYear}`,
+        start: new Date(randomYear, randomMonth + 1, randomDay),
+        finish: new Date(randomYear + 1, randomMonth + 1, randomDay),
         effortDriven: (i % 5 === 0)
       };
     }

src/app/modules/angular-slickgrid/editors/longTextEditor.ts

@@ -73,8 +73,8 @@ export class LongTextEditor implements Editor {
   }
 
   /** Get the Validator function, can be passed in Editor property or Column Definition */
-  get validator(): EditorValidator {
-    return this.columnEditor.validator || this.columnDef.validator;
+  get validator(): EditorValidator | undefined {
+    return (this.columnEditor && this.columnEditor.validator) || (this.columnDef && this.columnDef.validator);
   }
 
   init(): void {

src/app/modules/angular-slickgrid/global-grid-options.ts

@@ -72,6 +72,7 @@ export const GlobalGridOptions: Partial<GridOption> = {
     syncGridSelectionWithBackendService: false, // but disable it when using backend services
   },
   datasetIdPropertyName: 'id',
+  defaultColumnSortFieldId: 'id',
   defaultFilter: Filters.input,
   enableFilterTrimWhiteSpace: false, // do we want to trim white spaces on all Filters?
   defaultFilterPlaceholder: '&#128269;',

src/app/modules/angular-slickgrid/models/gridOption.interface.ts

@@ -130,6 +130,9 @@ export interface GridOption {
     syncGridSelectionWithBackendService?: boolean;
   };
 
+  /** Defaults to 'id', what is the default column field id to sort when calling clear sorting */
+  defaultColumnSortFieldId?: string;
+
   /** Default column width, is set to 80 when null */
   defaultColumnWidth?: number;
 

src/app/modules/angular-slickgrid/services/sort.service.ts

@@ -111,7 +111,9 @@ export class SortService {
           this.onBackendSortChanged(undefined, { grid: this._grid, sortCols: [], clearSortTriggered: true });
         } else {
           if (this._columnDefinitions && Array.isArray(this._columnDefinitions)) {
-            this.onLocalSortChanged(this._grid, this._dataView, new Array({ sortAsc: true, sortCol: this._columnDefinitions[0], clearSortTriggered: true }));
+            const sortColFieldId = this._gridOptions && this._gridOptions.defaultColumnSortFieldId || 'id';
+            const sortCol = { id: sortColFieldId, field: sortColFieldId } as Column;
+            this.onLocalSortChanged(this._grid, this._dataView, new Array({ sortAsc: true, sortCol, clearSortTriggered: true }));
           }
         }
       } else if (this._isBackendGrid) {