add doc

Author: huangshuwei

examples/src/docs/en/ve-table/api/contextmenu-body-option-props.vue

@@ -0,0 +1,32 @@
+<template>
+    <div>
+        <tpl
+            :desc="desc"
+            :anchor="anchor"
+            :table-data="db.contextmenuBodyOption.data"
+            :columns="db.contextmenuBodyOption.columns"
+        />
+    </div>
+</template>
+<script>
+import tpl from "@/comp/api-tpl";
+import { db } from "./db";
+export default {
+    components: { tpl },
+    props: {
+        anchor: {
+            type: String,
+            default: "Contextmenu Configuration",
+        },
+        desc: {
+            type: String,
+            default: "contextmenuBodyOption",
+        },
+    },
+    data() {
+        return {
+            db: db,
+        };
+    },
+};
+</script>

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

@@ -225,7 +225,7 @@ export const db = {
             {
                 param: "virtualScrollOption",
                 desc: "Virtual scroll configuration, it is recommended to display more than 1000 rows at a time.Refer to virtualScrollOption configuration for details",
-                type: "<code>Boolean</code>",
+                type: "<code>Object</code>",
                 optionalVal: "-",
                 default: "-",
             },
@@ -250,6 +250,13 @@ export const db = {
                 optionalVal: "-",
                 default: "-",
             },
+            {
+                param: "contextmenuBodyOption",
+                desc: "contextmenu configuration,Refer to contextmenuBodyOption",
+                type: "<code>Object</code>",
+                optionalVal: "-",
+                default: "-",
+            },
             {
                 param: "eventCustomOption",
                 desc: `Custom event configuration,Refer to eventCustomOption configuration for details`,
@@ -894,6 +901,27 @@ export const db = {
         columns: columnsType1,
     },
 
+    // 右键菜单配置
+    contextmenuBodyOption: {
+        data: [
+            {
+                param: "callback",
+                desc: `The callback of the right-click menu item.<code>type</code>menu type,<code>selection </code>Currently selected cell`,
+                type: `<code>Function({ type, selection  })</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
+            {
+                param: "contextmenus",
+                desc: `contextmenu option. <a href='#/en/doc/base/contextmenu'>contextmenu component</a>`,
+                type: `<code>Array</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
+        ],
+        columns: columnsType1,
+    },
+
     // 单元格选择配置
     cellSelectionOption: {
         data: [

examples/src/docs/en/ve-table/api/main.vue

@@ -29,6 +29,8 @@
         <CellSelectionOption />
         <!-- edit Option -->
         <EditOption />
+        <!-- contextmenu body option -->
+        <contextmenuBodyOption />
         <!-- Event Custom Option -->
         <EventCustomOption />
     </div>
@@ -50,6 +52,7 @@ import CellStyleOption from "./cell-style-option-props";
 import RowStyleOption from "./row-style-option-props";
 import CellSelectionOption from "./cell-selection-option-props";
 import EditOption from "./edit-option-props";
+import contextmenuBodyOption from "./contextmenu-body-option-props";
 export default {
     components: {
         TableProps,
@@ -67,6 +70,7 @@ export default {
         SortOption,
         CellSelectionOption,
         EditOption,
+        contextmenuBodyOption,
     },
     data() {
         return {

examples/src/docs/zh/ve-table/api/contextmenu-body-option-props.vue

@@ -0,0 +1,32 @@
+<template>
+    <div>
+        <tpl
+            :desc="desc"
+            :anchor="anchor"
+            :table-data="db.contextmenuBodyOption.data"
+            :columns="db.contextmenuBodyOption.columns"
+        />
+    </div>
+</template>
+<script>
+import tpl from "@/comp/api-tpl";
+import { db } from "./db";
+export default {
+    components: { tpl },
+    props: {
+        anchor: {
+            type: String,
+            default: "右键菜单配置",
+        },
+        desc: {
+            type: String,
+            default: "contextmenuBodyOption",
+        },
+    },
+    data() {
+        return {
+            db: db,
+        };
+    },
+};
+</script>

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

@@ -231,7 +231,7 @@ export const db = {
             {
                 param: "virtualScrollOption",
                 desc: "虚拟滚动配置，建议需要一次性展示1000条以上使用。具体见下表 virtualScrollOption 配置。",
-                type: "<code>Boolean</code>",
+                type: "<code>Object</code>",
                 optionalVal: "-",
                 default: "-",
             },
@@ -256,6 +256,13 @@ export const db = {
                 optionalVal: "-",
                 default: "-",
             },
+            {
+                param: "contextmenuBodyOption",
+                desc: "右键菜单配置，具体见下表 contextmenuBodyOption 配置",
+                type: "<code>Object</code>",
+                optionalVal: "-",
+                default: "-",
+            },
             {
                 param: "eventCustomOption",
                 desc: `自定义事件配置，具体见下表 eventCustomOption 配置`,
@@ -900,6 +907,27 @@ export const db = {
         columns: columnsType1,
     },
 
+    // 右键菜单配置
+    contextmenuBodyOption: {
+        data: [
+            {
+                param: "callback",
+                desc: `右键菜单项被点击的回调。<code>type</code>菜单类型，<code>selection </code>当前选中单元格`,
+                type: `<code>Function({ type, selection  })</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
+            {
+                param: "contextmenus",
+                desc: `右键菜单配置项。 <a href='#/zh/doc/base/contextmenu'>右键菜单组件</a>`,
+                type: `<code>Array</code>`,
+                optionalVal: "-",
+                default: "-",
+            },
+        ],
+        columns: columnsType1,
+    },
+
     // 单元格选择配置
     cellSelectionOption: {
         data: [

examples/src/docs/zh/ve-table/api/main.vue

@@ -29,6 +29,8 @@
         <CellSelectionOption />
         <!-- edit Option -->
         <EditOption />
+        <!-- contextmenu body option -->
+        <contextmenuBodyOption />
         <!-- Event Custom Option -->
         <EventCustomOption />
     </div>
@@ -50,6 +52,7 @@ import CellStyleOption from "./cell-style-option-props";
 import RowStyleOption from "./row-style-option-props";
 import CellSelectionOption from "./cell-selection-option-props";
 import EditOption from "./edit-option-props";
+import contextmenuBodyOption from "./contextmenu-body-option-props";
 export default {
     components: {
         TableProps,
@@ -67,6 +70,7 @@ export default {
         SortOption,
         CellSelectionOption,
         EditOption,
+        contextmenuBodyOption,
     },
     data() {
         return {

examples/src/docs/zh/ve-table/contextmenu/base.md

@@ -134,8 +134,6 @@
                 ],
             };
         },
-
-        methods: {},
     };
 </script>
 ```

examples/src/docs/zh/ve-table/contextmenu/custom.md

@@ -178,8 +178,6 @@
                 ],
             };
         },
-
-        methods: {},
     };
 </script>
 ```

examples/src/docs/zh/ve-table/contextmenu/main.vue

@@ -5,13 +5,19 @@
         <ContextmenuTypes />
         <Base />
         <Custom />
+        <API
+            title="API"
+            anchor="API"
+            desc="contextmenuBodyOption 右键菜单配置"
+        />
     </div>
 </template>
 <script>
 import Explain from "./explain.md";
 import ContextmenuTypes from "./contextmenu-types.md";
 import Base from "./base.md";
 import Custom from "./custom.md";
+import API from "../api/contextmenu-body-option-props";
 
 export default {
     name: "basic-main",
@@ -20,6 +26,7 @@ export default {
         ContextmenuTypes,
         Base,
         Custom,
+        API,
     },
 };
 </script>