feat(plugins): add all Cell Range/Selection plugins into Universal

- also add full unit test suite for all plugins

examples/webpack-demo-vanilla-bundle/src/examples/example13.ts

@@ -65,9 +65,9 @@ export class Example13 {
       enableFiltering: false,
       enableExcelCopyBuffer: true,
       excelCopyBufferOptions: {
-        onCopyCells: (e, args) => console.log(e, args),
-        onPasteCells: (e, args) => console.log(e, args),
-        onCopyCancelled: (e, args) => console.log(e, args),
+        onCopyCells: (e, args) => console.log('onCopyCells', e, args),
+        onPasteCells: (e, args) => console.log('onPasteCells', e, args),
+        onCopyCancelled: (e, args) => console.log('onCopyCancelled', e, args),
       },
       enableCellNavigation: true,
       gridHeight: 275,
@@ -82,6 +82,8 @@ export class Example13 {
       ...this.gridOptions1,
       enableHeaderMenu: true,
       enableFiltering: true,
+      // frozenColumn: 2,
+      // frozenRow: 2,
       headerButton: {
         // when floating to left, you might want to inverse the icon orders
         inverseOrder: true,

packages/common/src/enums/keyCode.enum.ts

@@ -1,4 +1,6 @@
 export enum KeyCode {
+  C = 67,
+  V = 86,
   BACKSPACE = 8,
   DELETE = 46,
   DOWN = 40,

packages/common/src/enums/slickPluginList.enum.ts

@@ -17,6 +17,7 @@ import {
 } from '../interfaces/index';
 import {
   AutoTooltipPlugin,
+  CellRangeSelector,
   // CellExternalCopyManager,
   // CellRangeDecorator,
   // CellRangeSelector,
@@ -25,6 +26,7 @@ import {
 
 export type SlickPluginList =
   AutoTooltipPlugin |
+  CellRangeSelector |
   SlickCellExternalCopyManager |
   SlickCellMenu |
   SlickCellRangeDecorator |

packages/common/src/extensions/__tests__/extensionUtility.spec.ts

@@ -16,7 +16,6 @@ const mockAddon = jest.fn().mockImplementation(() => ({
   destroy: jest.fn()
 }));
 
-jest.mock('slickgrid/plugins/slick.cellexternalcopymanager', () => mockAddon);
 jest.mock('slickgrid/plugins/slick.rowselectionmodel', () => mockAddon);
 jest.mock('slickgrid/plugins/slick.rowdetailview', () => mockAddon);
 jest.mock('slickgrid/plugins/slick.rowmovemanager', () => mockAddon);

packages/common/src/extensions/extensionUtility.ts

@@ -60,20 +60,6 @@ export class ExtensionUtility {
     return output;
   }
 
-  /**
-   * Loop through object provided and set to null any property found starting with "onX"
-   * @param {Object}: obj
-   */
-  nullifyFunctionNameStartingWithOn(obj?: any) {
-    if (obj) {
-      for (const prop of Object.keys(obj)) {
-        if (prop.startsWith('on')) {
-          obj[prop] = null;
-        }
-      }
-    }
-  }
-
   /**
    * When using ColumnPicker/GridMenu to show/hide a column, we potentially need to readjust the grid option "frozenColumn" index.
    * That is because SlickGrid freezes by column index and it has no knowledge of the columns themselves and won't change the index, we need to do that ourselves whenever necessary.

packages/common/src/interfaces/cellRange.interface.ts

@@ -1,3 +1,5 @@
+import { CellRangeDecorator } from '../plugins/cellRangeDecorator';
+
 export interface CellRange {
   /** Selection start from which cell? */
   fromCell: number;
@@ -11,3 +13,17 @@ export interface CellRange {
   /** Selection goes to which row? */
   toRow: number;
 }
+
+export interface CellRangeDecoratorOption {
+  selectionCssClass: string;
+  selectionCss: CSSStyleDeclaration;
+  offset: { top: number; left: number; height: number; width: number; };
+}
+
+export interface CellRangeSelectorOption {
+  cellDecorator: CellRangeDecorator;
+  selectionCss: CSSStyleDeclaration;
+}
+
+export type CSSStyleDeclarationReadonly = 'length' | 'parentRule' | 'getPropertyPriority' | 'getPropertyValue' | 'item' | 'removeProperty' | 'setProperty';
+export type CSSStyleDeclarationWritable = keyof Omit<CSSStyleDeclaration, CSSStyleDeclarationReadonly>;

packages/common/src/interfaces/drag.interface.ts

@@ -0,0 +1,16 @@
+export interface DragPosition {
+  startX: number;
+  startY: number;
+  range: DragRange;
+}
+
+export interface DragRange {
+  start: {
+    row?: number;
+    cell?: number;
+  };
+  end: {
+    row?: number;
+    cell?: number;
+  };
+}

packages/common/src/interfaces/excelCopyBufferOption.interface.ts

@@ -7,6 +7,12 @@ import {
 import { CellExcelCopyManager, } from '../plugins/cellExcelCopyManager';
 
 export interface ExcelCopyBufferOption<T = any> {
+  /** defaults to 2000(ms), delay in ms to wait before clearing the selection after a paste action */
+  clearCopySelectionDelay?: number;
+
+  /** defaults to 100(ms), delay in ms to wait before executing focus/paste */
+  clipboardPasteDelay?: number;
+
   /** defaults to "copied", sets the css className used for copied cells. */
   copiedCellStyle?: string;
 

packages/common/src/interfaces/externalCopyClipCommand.interface.ts

@@ -0,0 +1,24 @@
+import { CellExternalCopyManager } from '../plugins/cellExternalCopyManager';
+import { CellRange, Column, ExcelCopyBufferOption } from './index';
+
+export interface ExternalCopyClipCommand {
+  activeCell: number;
+  activeRow: number;
+  cellExternalCopyManager: CellExternalCopyManager;
+  clippedRange: CellRange[];
+  destH: number;
+  destW: number;
+  h: number;
+  w: number;
+  isClipboardCommand: boolean;
+  maxDestX: number;
+  maxDestY: number;
+  oldValues: any[];
+  oneCellToMultiple: boolean;
+  _options: ExcelCopyBufferOption;
+
+  execute: () => void;
+  markCopySelection: (ranges: CellRange[]) => void;
+  setDataItemValueForColumn: (item: any, columnDef: Column, value: any) => any | void;
+  undo: () => void;
+}

packages/common/src/interfaces/index.ts

@@ -37,6 +37,7 @@ export * from './currentSorter.interface';
 export * from './customFooterOption.interface';
 export * from './dataViewOption.interface';
 export * from './domEvent.interface';
+export * from './drag.interface';
 export * from './draggableGrouping.interface';
 export * from './draggableGroupingOption.interface';
 export * from './editCommand.interface';
@@ -58,6 +59,7 @@ export * from './excelWorkbook.interface';
 export * from './excelWorksheet.interface';
 export * from './extension.interface';
 export * from './extensionModel.interface';
+export * from './externalCopyClipCommand.interface';
 export * from './externalResource.interface';
 export * from './filter.interface';
 export * from './filterArguments.interface';

packages/common/src/interfaces/slickRange.interface.ts

@@ -13,14 +13,14 @@ export interface SlickRange extends CellRange {
   constructor: (fromRow: number, fromCell: number, toRow: number, toCell: number) => void;
 
   /** Returns whether a range represents a single row. */
-  isSingleRow: () => boolean;
+  isSingleRow?: () => boolean;
 
   /** Returns whether a range represents a single cell. */
-  isSingleCell: () => boolean;
+  isSingleCell?: () => boolean;
 
   /** Returns whether a range contains a given cell. */
-  contains: (row: number, cell: number) => boolean;
+  contains?: (row: number, cell: number) => boolean;
 
   /** Returns a readable representation of a range. */
-  toString: () => string;
+  toString?: () => string;
 }