Remove onCheckCellIsEditable prop (#2016)

* Remove onCheckCellIsEditable prop * Allow column.editable: false to disable editing even if we have a custom editor * inline canEdit into isSelectedCellEditable Co-authored-by: Aman Mahajan <[email protected]>
adazzle · Oct 29, 2020 · 6eac41e · 6eac41e
1 parent 509963f
commit 6eac41e
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 64 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -53,6 +53,8 @@
     - ⚠️ `getValidFilterValues`
     - ⚠️ `onCellCopyPaste`
     - ⚠️ `onSelectedCellRangeChange`
+    - ⚠️ `onCheckCellIsEditable`
+      - Use `column.editable` instead.
     - ⚠️ `onGridKeyDown`
     - ⚠️ `onGridKeyUp`
     - ⚠️ `onRowDoubleClick`

diff --git a/src/DataGrid.tsx b/src/DataGrid.tsx
@@ -29,7 +29,6 @@ import {
 
 import {
   CalculatedColumn,
-  CheckCellIsEditableEvent,
   Column,
   Filters,
   Position,
@@ -148,8 +147,6 @@ export interface DataGridProps<R, SR = unknown> extends SharedDivProps {
   onColumnResize?: (idx: number, width: number) => void;
   /** Function called whenever selected cell is changed */
   onSelectedCellChange?: (position: Position) => void;
-  /** called before cell is set active, returns a boolean to determine whether cell is editable */
-  onCheckCellIsEditable?: (event: CheckCellIsEditableEvent<R, SR>) => boolean;
 
   /**
    * Toggles and modes
@@ -208,7 +205,6 @@ function DataGrid<R, SR>({
   onScroll,
   onColumnResize,
   onSelectedCellChange,
-  onCheckCellIsEditable,
   // Toggles and modes
   enableFilters = false,
   enableCellCopyPaste = false,
@@ -639,7 +635,7 @@ function DataGrid<R, SR>({
 
   function isCellEditable(position: Position): boolean {
     return isCellWithinBounds(position)
-      && isSelectedCellEditable<R, SR>({ columns, rows, selectedPosition: position, onCheckCellIsEditable, isGroupRow });
+      && isSelectedCellEditable<R, SR>({ columns, rows, selectedPosition: position, isGroupRow });
   }
 
   function selectCell(position: Position, enableEditor = false): void {

diff --git a/src/types.ts b/src/types.ts
@@ -209,11 +209,6 @@ export interface RowsUpdateEvent<TUpdatedValue = never> {
   fromCellKey?: string;
 }
 
-export interface CheckCellIsEditableEvent<TRow, TSummaryRow> extends Position {
-  row: TRow;
-  column: CalculatedColumn<TRow, TSummaryRow>;
-}
-
 export interface SelectRowEvent {
   rowIdx: number;
   checked: boolean;

diff --git a/src/utils/columnUtils.test.ts b/src/utils/columnUtils.test.ts
@@ -1,6 +1,6 @@
-import { getColumnMetrics, getColumnScrollPosition, canEdit } from './columnUtils';
+import { getColumnMetrics, getColumnScrollPosition } from './columnUtils';
 import { ValueFormatter } from '../formatters';
-import { Column, CalculatedColumn } from '../types';
+import { Column } from '../types';
 import { createColumns } from '../test/utils';
 
 describe('getColumnMetrics', () => {
@@ -126,42 +126,3 @@ describe('getColumnScrollPosition', () => {
     });
   });
 });
-
-describe('canEdit', () => {
-  interface Row {
-    id: number;
-  }
-
-  const column: CalculatedColumn<Row> = {
-    idx: 0,
-    key: 'id',
-    name: 'ID',
-    left: 460,
-    width: 150,
-    resizable: false,
-    sortable: false,
-    formatter: ValueFormatter
-  };
-
-  it('should return the result of editable(row)', () => {
-    const fnColumn = {
-      ...column,
-      editor: () => null,
-      editable(row: Row) { return row.id === 1; }
-    };
-    expect(canEdit(fnColumn, { id: 1 })).toBe(true);
-    expect(canEdit(fnColumn, { id: 0 })).toBe(false);
-  });
-
-  it('should return correct booleans', () => {
-    const row: Row = { id: 1 };
-    const editor = () => null;
-
-    expect(canEdit(column, row)).toBe(false);
-    expect(canEdit({ ...column, editable: false }, row)).toBe(false);
-    expect(canEdit({ ...column, editable: true }, row)).toBe(false);
-    expect(canEdit({ ...column, editor }, row)).toBe(true);
-    expect(canEdit({ ...column, editor, editable: false }, row)).toBe(false);
-    expect(canEdit({ ...column, editor, editable: true }, row)).toBe(true);
-  });
-});
diff --git a/src/utils/columnUtils.ts b/src/utils/columnUtils.ts
@@ -158,13 +158,6 @@ function clampColumnWidth<R, SR>(
   return width;
 }
 
-// Logic extented to allow for functions to be passed down in column.editable
-// this allows us to decide whether we can be editing from a cell level
-export function canEdit<R, SR>(column: Column<R, SR>, row: R): boolean {
-  const isEditable = typeof column.editable === 'function' ? column.editable(row) : column.editable;
-  return column.editor != null && isEditable !== false;
-}
-
 export function getColumnScrollPosition<R, SR>(columns: readonly CalculatedColumn<R, SR>[], idx: number, currentScrollLeft: number, currentClientWidth: number): number {
   let left = 0;
   let frozen = 0;

diff --git a/src/utils/selectedCellUtils.ts b/src/utils/selectedCellUtils.ts
@@ -1,21 +1,20 @@
 import { CellNavigationMode } from '../enums';
-import { canEdit } from './columnUtils';
 import { CalculatedColumn, Position, GroupRow } from '../types';
 
 interface IsSelectedCellEditableOpts<R, SR> {
   selectedPosition: Position;
   columns: readonly CalculatedColumn<R, SR>[];
   rows: readonly (R | GroupRow<R>)[];
-  onCheckCellIsEditable?: (arg: { row: R; column: CalculatedColumn<R, SR> } & Position) => boolean;
   isGroupRow: (row: R | GroupRow<R>) => row is GroupRow<R>;
 }
 
-export function isSelectedCellEditable<R, SR>({ selectedPosition, columns, rows, onCheckCellIsEditable, isGroupRow }: IsSelectedCellEditableOpts<R, SR>): boolean {
+export function isSelectedCellEditable<R, SR>({ selectedPosition, columns, rows, isGroupRow }: IsSelectedCellEditableOpts<R, SR>): boolean {
   const column = columns[selectedPosition.idx];
   const row = rows[selectedPosition.rowIdx];
-  if (column.rowGroup === true || isGroupRow(row)) return false;
-  const isCellEditable = onCheckCellIsEditable ? onCheckCellIsEditable({ row, column, ...selectedPosition }) : true;
-  return isCellEditable && canEdit<R, SR>(column, row);
+  return column.editor != null
+    && !column.rowGroup
+    && !isGroupRow(row)
+    && (typeof column.editable === 'function' ? column.editable(row) : column.editable) !== false;
 }
 
 interface GetNextSelectedCellPositionOpts<R, SR> {