【feature】

Doc of new `beforeStartCellEditing` callback method for cell editing function

Author: huangshuwei

examples/src/docs/en/ve-table/api/db.js

@@ -961,6 +961,13 @@ export const db = {
     // 单元格编辑配置
     editOption: {
         data: [
+            {
+                param: "beforeStartCellEditing",
+                desc: `before start editing cell callback method.<code>row</code>Current row data,<code>column</code>Current column,<code>cellValue</code>Current cell value.If false is returned,Will prevent the cell from starting the editing state`,
+                type: `<code>Function({ row, column,cellValue })</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
             {
                 param: "beforeCellValueChange",
                 desc: `before cell value change callback method. <code>row</code>Current row data,<code>column</code>Current column,<code>changeValue</code>change value. If false is returned, cell editing will be blocked, the cell will back to the state before editing`,

examples/src/docs/en/ve-table/cell-edit/base.md

@@ -2,7 +2,7 @@
 
 Trying to change the value of the 'Number' column to a non number
 
-:::demo 1.After the cell stops editing, the `beforeCellValueChange` callback is triggered first. If false is returned, the editing will be blocked and the cell will be restored to the state before editing. If the editing is successful, the `afterCellValueChange` method will be triggered<br>2.You can use beforecellvaluechange to verify the contents of cell editing
+:::demo 1.Before a cell enters the editing state, the `beforeStartCellEditing` callback is first triggered. If false is returned, it will prevent the cell from entering the editing state<br>2.After the cell stops editing, the `beforeCellValueChange` callback is triggered first. If false is returned, the editing will be blocked and the cell will be restored to the state before editing. If the editing is successful, the `afterCellValueChange` method will be triggered<br>3.You can use beforecellvaluechange to verify the contents of cell editing
 
 ```html
 <template>
@@ -29,6 +29,18 @@ Trying to change the value of the 'Number' column to a non number
                 },
                 // edit option
                 editOption: {
+                    beforeStartCellEditing: ({ row, column, cellValue }) => {
+                        console.log("beforeStartCellEditing");
+                        console.log("row::", row);
+                        console.log("column::", column);
+                        console.log("cellValue::", cellValue);
+                        console.log("---");
+
+                        if (row.rowKey === 0 && column.field === "name") {
+                            alert("You can't edit this cell.");
+                            return false;
+                        }
+                    },
                     beforeCellValueChange: ({ row, column, changeValue }) => {
                         console.log("beforeCellValueChange");
                         console.log("row::", row);
@@ -98,7 +110,7 @@ Trying to change the value of the 'Number' column to a non number
                 // table data
                 tableData: [
                     {
-                        name: "John",
+                        name: "You can't edit",
                         date: "1900-05-20",
                         number: "32",
                         address: "No.1 Century Avenue, Shanghai",

examples/src/docs/zh/ve-table/api/db.js

@@ -954,6 +954,13 @@ export const db = {
     // 单元格编辑配置
     editOption: {
         data: [
+            {
+                param: "beforeStartCellEditing",
+                desc: `单元格进入编辑状态前的回调方法。<code>row</code>当前行数据，<code>column</code>当前列信息，<code>cellValue</code>当前单元格的值。如果返回false，将则会阻止单元格进入编辑状态`,
+                type: `<code>Function({ row, column,cellValue })</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
             {
                 param: "beforeCellValueChange",
                 desc: `单元格内容改变前的回调方法。<code>row</code>当前行数据，<code>column</code>当前列信息，<code>changeValue</code>单元格改变的值。如果返回false，将会阻止编辑，单元格还原为编辑前状态`,
@@ -970,7 +977,7 @@ export const db = {
             },
             {
                 param: "cellValueChange",
-                desc: `将被移除`,
+                desc: `即将废弃的方法`,
                 type: `<code>Function({ row, column })</code>`,
                 optionalVal: "-",
                 default: "-",

examples/src/docs/zh/ve-table/cell-edit/base.md

@@ -1,8 +1,9 @@
 :::anchor 基本用法
 
-尝试将 “Number”列的值改为非数字
+1、尝试将 “Number”列的值改为非数字<br>
+2、尝试修改第一行第一列
 
-:::demo 1、单元格停止编辑后首先触发`beforeCellValueChange`回调，如果返回 false，则会阻止编辑，单元格还原为编辑前状态。编辑成功将触发`afterCellValueChange`方法<br>2、你可以利用`beforeCellValueChange`做编辑校验功能
+:::demo 1、单元格进入编辑状态前首先触发`beforeStartCellEditing`回调，如果返回 false，则会阻止进入编辑状态。<br>2、单元格停止编辑后首先触发`beforeCellValueChange`回调，如果返回 false，则会阻止编辑，单元格还原为编辑前状态。编辑成功将触发`afterCellValueChange`方法<br>3、你可以利用`beforeCellValueChange`做编辑校验功能<br>
 
 ```html
 <template>
@@ -29,6 +30,18 @@
                 },
                 // edit option 可控单元格编辑
                 editOption: {
+                    beforeStartCellEditing: ({ row, column, cellValue }) => {
+                        console.log("beforeStartCellEditing");
+                        console.log("row::", row);
+                        console.log("column::", column);
+                        console.log("cellValue::", cellValue);
+                        console.log("---");
+
+                        if (row.rowKey === 0 && column.field === "name") {
+                            alert("You can't edit this cell.");
+                            return false;
+                        }
+                    },
                     beforeCellValueChange: ({ row, column, changeValue }) => {
                         console.log("beforeCellValueChange");
                         console.log("row::", row);
@@ -98,7 +111,7 @@
                 // table data
                 tableData: [
                     {
-                        name: "John",
+                        name: "You can't edit",
                         date: "1900-05-20",
                         number: "32",
                         address: "No.1 Century Avenue, Shanghai",