Remove onCheckCellIsEditable prop

CHANGELOG.md

@@ -34,6 +34,8 @@
     - ⚠️ `getValidFilterValues`
     - ⚠️ `onCellCopyPaste`
     - ⚠️ `onSelectedCellRangeChange`
+    - ⚠️ `onCheckCellIsEditable`
+      - Use `column.editable` instead.
     - ⚠️ `onGridKeyDown`
     - ⚠️ `onGridKeyUp`
     - ⚠️ `onRowDoubleClick`

src/DataGrid.tsx

@@ -29,7 +29,6 @@ import {
 
 import {
   CalculatedColumn,
-  CheckCellIsEditableEvent,
   Column,
   Filters,
   FormatterProps,
@@ -121,8 +120,6 @@ export interface DataGridProps<R, K extends keyof R, SR = unknown> {
   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
@@ -180,7 +177,6 @@ function DataGrid<R, K extends keyof R, SR>({
   onScroll,
   onColumnResize,
   onSelectedCellChange,
-  onCheckCellIsEditable,
   // Toggles and modes
   enableFilters = false,
   enableCellAutoFocus = true,
@@ -453,7 +449,6 @@ function DataGrid<R, K extends keyof R, SR>({
               scrollTop={scrollTop}
               scrollToCell={scrollToCell}
               editorPortalTarget={editorPortalTarget}
-              onCheckCellIsEditable={onCheckCellIsEditable}
               onRowsUpdate={handleRowsUpdate}
               onSelectedCellChange={onSelectedCellChange}
             />

src/common/types.ts

@@ -147,11 +147,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;

src/masks/InteractionMasks.tsx

@@ -24,7 +24,6 @@ import { DataGridProps } from '../DataGrid';
 
 type SharedCanvasProps<R, SR> = Pick<DataGridProps<R, never, SR>,
   | 'rows'
-  | 'onCheckCellIsEditable'
   | 'onSelectedCellChange'
 > & Pick<Required<DataGridProps<R, never, SR>>,
   | 'rowHeight'
@@ -70,7 +69,6 @@ export default function InteractionMasks<R, SR>({
   scrollLeft,
   scrollTop,
   onSelectedCellChange,
-  onCheckCellIsEditable,
   onRowsUpdate,
   scrollToCell
 }: InteractionMasksProps<R, SR>) {
@@ -257,7 +255,7 @@ export default function InteractionMasks<R, SR>({
 
   function isCellEditable(position: Position) {
     return isCellWithinBounds(position)
-      && isSelectedCellEditable<R, SR>({ columns, rows, selectedPosition: position, onCheckCellIsEditable });
+      && isSelectedCellEditable<R, SR>({ columns, rows, selectedPosition: position });
   }
 
   function selectCell(position: Position, enableEditor = false): void {

src/utils/columnUtils.test.ts

@@ -152,7 +152,7 @@ describe('canEdit', () => {
     expect(canEdit({ ...column, editable: false }, row)).toBe(false);
     expect(canEdit({ ...column, editable: true }, row)).toBe(true);
     expect(canEdit({ ...column, editor }, row)).toBe(true);
-    expect(canEdit({ ...column, editor, editable: false }, row)).toBe(true);
+    expect(canEdit({ ...column, editor, editable: false }, row)).toBe(false);
     expect(canEdit({ ...column, editor, editable: true }, row)).toBe(true);
   });
 });

src/utils/columnUtils.ts

@@ -109,7 +109,7 @@ export function canEdit<R, SR>(column: CalculatedColumn<R, SR>, row: R): boolean
   if (typeof column.editable === 'function') {
     return column.editable(row);
   }
-  return Boolean(column.editor || column.editable);
+  return column.editable || column.editor != null && column.editable !== false;
 }
 
 export function getColumnScrollPosition<R, SR>(columns: readonly CalculatedColumn<R, SR>[], idx: number, currentScrollLeft: number, currentClientWidth: number): number {

src/utils/selectedCellUtils.ts

@@ -30,14 +30,12 @@ interface IsSelectedCellEditableOpts<R, SR> {
   selectedPosition: Position;
   columns: readonly CalculatedColumn<R, SR>[];
   rows: readonly R[];
-  onCheckCellIsEditable?: (arg: { row: R; column: CalculatedColumn<R, SR> } & Position) => boolean;
 }
 
-export function isSelectedCellEditable<R, SR>({ selectedPosition, columns, rows, onCheckCellIsEditable }: IsSelectedCellEditableOpts<R, SR>): boolean {
+export function isSelectedCellEditable<R, SR>({ selectedPosition, columns, rows }: IsSelectedCellEditableOpts<R, SR>): boolean {
   const column = columns[selectedPosition.idx];
   const row = rows[selectedPosition.rowIdx];
-  const isCellEditable = onCheckCellIsEditable ? onCheckCellIsEditable({ row, column, ...selectedPosition }) : true;
-  return isCellEditable && canEdit<R, SR>(column, row);
+  return canEdit<R, SR>(column, row);
 }
 
 interface GetNextSelectedCellPositionOpts<R, SR> {