add scrollTo API

huangshuwei · huangshuwei · commit c76ed7f8fafc · 2021-08-17T21:04:27.000+08:00
diff --git a/examples/src/docs/en/ve-table/api/column-props/index.vue b/examples/src/docs/en/ve-table/api/column-props/index.vue
@@ -24,7 +24,7 @@ export default {
         },
         desc: {
             type: String,
-            default: "columns",
+            default: "Columns",
         },
     },
     data() {
diff --git a/examples/src/docs/en/ve-table/api/db.js b/examples/src/docs/en/ve-table/api/db.js
@@ -53,6 +53,51 @@ const columnsType1 = [
     },
 ];
 
+// 列配置类型2（应用于实例方法）
+const columnsType2 = [
+    // {
+    //     key: "a",
+    //     field: "param",
+    //     title: "参数",
+    //     width: "10%",
+    //     align: "left",
+    //     type: "expand",
+    //     renderBodyCell: ({ row, column, rowIndex }, h) => {
+    //         return <span domPropsInnerHTML={row.param}></span>;
+    //     },
+    // },
+    {
+        key: "b",
+        field: "name",
+        title: "方法名",
+        width: "10%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.name}></span>;
+        },
+    },
+    {
+        key: "c",
+        field: "desc",
+        title: "说明",
+        width: "70%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.desc}></span>;
+        },
+    },
+    {
+        key: "d",
+        field: "param",
+        title: "参数",
+        width: "20%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.param}></span>;
+        },
+    },
+];
+
 export const db = {
     // table props option
     table: {
@@ -413,6 +458,18 @@ export const db = {
         },
     },
 
+    // instance methods
+    instanceMethods: {
+        data: [
+            {
+                name: "scrollTop",
+                desc: `Scrolls the table to the specified position`,
+                param: "Refer to <a href='https://developer.mozilla.org/zh-CN/docs/Web/API/Element/scrollTo'> MDN scrollTo</a>",
+            },
+        ],
+        columns: columnsType2,
+    },
+
     // 可展开配置
     expandOption: {
         data: [
diff --git a/examples/src/docs/en/ve-table/api/instance-methods.vue b/examples/src/docs/en/ve-table/api/instance-methods.vue
@@ -0,0 +1,32 @@
+<template>
+    <div>
+        <tpl
+            :desc="desc"
+            :anchor="anchor"
+            :table-data="db.instanceMethods.data"
+            :columns="db.instanceMethods.columns"
+        />
+    </div>
+</template>
+<script>
+import tpl from "@/comp/api-tpl";
+import { db } from "./db";
+export default {
+    components: { tpl },
+    props: {
+        anchor: {
+            type: String,
+            default: "Table Instance Methods",
+        },
+        desc: {
+            type: String,
+            default: "Table Instance Methods",
+        },
+    },
+    data() {
+        return {
+            db: db,
+        };
+    },
+};
+</script>
diff --git a/examples/src/docs/en/ve-table/api/main.vue b/examples/src/docs/en/ve-table/api/main.vue
@@ -5,6 +5,8 @@
         <TableProps />
         <!-- columns -->
         <ColumnProps />
+        <!-- instance methods -->
+        <InstanceMethods />
         <!-- cell Span Option -->
         <CellSpanOption />
         <!-- cell Style Option -->
@@ -31,6 +33,7 @@
 import { db } from "./db";
 import TableProps from "./table-props";
 import ColumnProps from "./column-props";
+import InstanceMethods from "./instance-methods";
 import ExpandOption from "./expand-option-props";
 import CheckboxOption from "./checkbox-option-props";
 import RadioOption from "./radio-option-props";
@@ -45,6 +48,7 @@ export default {
     components: {
         TableProps,
         ColumnProps,
+        InstanceMethods,
         CellSpanOption,
         EventCustomOption,
         CellStyleOption,
diff --git a/examples/src/docs/en/ve-table/api/table-props.vue b/examples/src/docs/en/ve-table/api/table-props.vue
@@ -20,7 +20,7 @@ export default {
         },
         desc: {
             type: String,
-            default: "Table props",
+            default: "Table Props",
         },
     },
     data() {
diff --git a/examples/src/docs/zh/ve-table/api/column-props/index.vue b/examples/src/docs/zh/ve-table/api/column-props/index.vue
@@ -24,7 +24,7 @@ export default {
         },
         desc: {
             type: String,
-            default: "columns",
+            default: "Columns",
         },
     },
     data() {
diff --git a/examples/src/docs/zh/ve-table/api/db.js b/examples/src/docs/zh/ve-table/api/db.js
@@ -53,6 +53,51 @@ const columnsType1 = [
     },
 ];
 
+// 列配置类型2（应用于实例方法）
+const columnsType2 = [
+    // {
+    //     key: "a",
+    //     field: "param",
+    //     title: "参数",
+    //     width: "10%",
+    //     align: "left",
+    //     type: "expand",
+    //     renderBodyCell: ({ row, column, rowIndex }, h) => {
+    //         return <span domPropsInnerHTML={row.param}></span>;
+    //     },
+    // },
+    {
+        key: "b",
+        field: "name",
+        title: "方法名",
+        width: "10%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.name}></span>;
+        },
+    },
+    {
+        key: "c",
+        field: "desc",
+        title: "说明",
+        width: "70%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.desc}></span>;
+        },
+    },
+    {
+        key: "d",
+        field: "param",
+        title: "参数",
+        width: "20%",
+        align: "left",
+        renderBodyCell: ({ row, column, rowIndex }, h) => {
+            return <span domPropsInnerHTML={row.param}></span>;
+        },
+    },
+];
+
 export const db = {
     // table props option
     table: {
@@ -413,6 +458,18 @@ export const db = {
         },
     },
 
+    // instance methods
+    instanceMethods: {
+        data: [
+            {
+                name: "scrollTop",
+                desc: `使表格滚动到指定的位置`,
+                param: "参考<a href='https://developer.mozilla.org/zh-CN/docs/Web/API/Element/scrollTo'> MDN scrollTo</a>",
+            },
+        ],
+        columns: columnsType2,
+    },
+
     // 可展开配置
     expandOption: {
         data: [
diff --git a/examples/src/docs/zh/ve-table/api/instance-methods.vue b/examples/src/docs/zh/ve-table/api/instance-methods.vue
@@ -0,0 +1,32 @@
+<template>
+    <div>
+        <tpl
+            :desc="desc"
+            :anchor="anchor"
+            :table-data="db.instanceMethods.data"
+            :columns="db.instanceMethods.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: "Table Instance Methods",
+        },
+    },
+    data() {
+        return {
+            db: db,
+        };
+    },
+};
+</script>
diff --git a/examples/src/docs/zh/ve-table/api/main.vue b/examples/src/docs/zh/ve-table/api/main.vue
@@ -5,6 +5,8 @@
         <TableProps />
         <!-- columns -->
         <ColumnProps />
+        <!-- instance methods -->
+        <InstanceMethods />
         <!-- cell Span Option -->
         <CellSpanOption />
         <!-- cell Style Option -->
@@ -31,6 +33,7 @@
 import { db } from "./db";
 import TableProps from "./table-props";
 import ColumnProps from "./column-props";
+import InstanceMethods from "./instance-methods";
 import ExpandOption from "./expand-option-props";
 import CheckboxOption from "./checkbox-option-props";
 import RadioOption from "./radio-option-props";
@@ -45,6 +48,7 @@ export default {
     components: {
         TableProps,
         ColumnProps,
+        InstanceMethods,
         CellSpanOption,
         EventCustomOption,
         CellStyleOption,
diff --git a/examples/src/docs/zh/ve-table/api/table-props.vue b/examples/src/docs/zh/ve-table/api/table-props.vue
@@ -20,7 +20,7 @@ export default {
         },
         desc: {
             type: String,
-            default: "Table props",
+            default: "Table Props",
         },
     },
     data() {
