Fixed bug that readOnly of Action is always readOnly when updated with function. (#269)

Author: ota-meshi

packages/cheetah-grid/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cheetah-grid",
-  "version": "0.22.6",
+  "version": "0.22.7",
   "description": "Cheetah Grid is a high performance grid engine that works on canvas",
   "keywords": [
     "spreadsheet",

packages/cheetah-grid/src/js/columns/action.ts

@@ -6,6 +6,7 @@ import type {
   EditorOption,
   InlineInputEditorOption,
   InlineMenuEditorOption,
+  RecordBoolean,
   SmallDialogInputEditorOption,
 } from "../ts-types";
 import { Action } from "./action/Action";
@@ -20,28 +21,28 @@ import { SmallDialogInputEditor } from "./action/SmallDialogInputEditor";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class ImmutableCheckEditor extends CheckEditor<any> {
-  get disabled(): boolean {
+  get disabled(): RecordBoolean {
     return this._disabled;
   }
-  get readOnly(): boolean {
+  get readOnly(): RecordBoolean {
     return this._readOnly;
   }
 }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class ImmutableRadioEditor extends RadioEditor<any> {
-  get disabled(): boolean {
+  get disabled(): RecordBoolean {
     return this._disabled;
   }
-  get readOnly(): boolean {
+  get readOnly(): RecordBoolean {
     return this._readOnly;
   }
 }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class ImmutableInputEditor extends SmallDialogInputEditor<any> {
-  get disabled(): boolean {
+  get disabled(): RecordBoolean {
     return this._disabled;
   }
-  get readOnly(): boolean {
+  get readOnly(): RecordBoolean {
     return this._readOnly;
   }
 }

packages/cheetah-grid/src/js/columns/action/BaseAction.ts

@@ -4,18 +4,19 @@ import type {
   EventListenerId,
   LayoutObjectId,
   ListGridAPI,
+  RecordBoolean,
 } from "../../ts-types";
 
 export abstract class BaseAction<T> {
-  protected _disabled: boolean;
+  protected _disabled: RecordBoolean;
   constructor(option: BaseActionOption = {}) {
     this._disabled = option.disabled || false;
   }
   abstract get editable(): boolean;
-  get disabled(): boolean {
+  get disabled(): RecordBoolean {
     return this._disabled;
   }
-  set disabled(disabled: boolean) {
+  set disabled(disabled: RecordBoolean) {
     this._disabled = disabled;
     this.onChangeDisabledInternal();
   }

packages/cheetah-grid/src/js/columns/action/Editor.ts

@@ -1,19 +1,19 @@
+import type { EditorOption, RecordBoolean } from "../../ts-types";
 import { BaseAction } from "./BaseAction";
-import type { EditorOption } from "../../ts-types";
 export abstract class Editor<T> extends BaseAction<T> {
-  protected _readOnly: boolean;
+  protected _readOnly: RecordBoolean;
   constructor(option: EditorOption = {}) {
     super(option);
     this._readOnly = option.readOnly || false;
   }
   get editable(): boolean {
     return true;
   }
-  get readOnly(): boolean {
+  get readOnly(): RecordBoolean {
     return this._readOnly;
   }
-  set readOnly(readOnly: boolean) {
-    this._readOnly = !!readOnly;
+  set readOnly(readOnly: RecordBoolean) {
+    this._readOnly = readOnly;
     this.onChangeReadOnlyInternal();
   }
   onChangeReadOnlyInternal(): void {

packages/cheetah-grid/src/js/columns/action/action-utils.ts

@@ -1,9 +1,8 @@
-import type { ListGridAPI } from "../../ts-types";
+import type { ListGridAPI, RecordBoolean } from "../../ts-types";
 import { isPromise } from "../../internal/utils";
 
 export function isDisabledRecord<T>(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  option: boolean | ((record: any) => boolean),
+  option: RecordBoolean,
   grid: ListGridAPI<T>,
   row: number
 ): boolean {
@@ -13,8 +12,7 @@ export function isDisabledRecord<T>(
   return getBooleanOptionOfRecord(option, grid, row);
 }
 export function isReadOnlyRecord<T>(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  option: boolean | ((record: any) => boolean),
+  option: RecordBoolean,
   grid: ListGridAPI<T>,
   row: number
 ): boolean {
@@ -55,8 +53,7 @@ export function toggleValue(
 }
 
 function getBooleanOptionOfRecord<T>(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  option: boolean | ((record: any) => boolean),
+  option: RecordBoolean,
   grid: ListGridAPI<T>,
   row: number
 ): boolean {

packages/cheetah-grid/src/js/header/action/BaseAction.ts

@@ -8,7 +8,7 @@ import type {
 export class BaseAction<T> {
   protected _disabled: boolean;
   constructor(option: BaseActionOption = {}) {
-    this._disabled = option.disabled || false;
+    this._disabled = !!option.disabled || false;
   }
   get disabled(): boolean {
     return this._disabled;

packages/cheetah-grid/src/js/ts-types/column/action.ts

@@ -3,8 +3,11 @@ import type { ColumnMenuItemOptions } from "../define";
 import type { ListGridAPI } from "../grid-engine";
 import type { MaybePromise } from "../base";
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type RecordBoolean<T = any> = boolean | ((record: T) => boolean);
+
 export interface BaseActionOption {
-  disabled?: boolean;
+  disabled?: RecordBoolean;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -13,7 +16,7 @@ export interface ActionOption extends BaseActionOption {
   action?: ActionListener;
 }
 export interface EditorOption extends BaseActionOption {
-  readOnly?: boolean;
+  readOnly?: RecordBoolean;
 }
 export type ButtonActionOption = ActionOption;