feat(Empty): update api

Tencent · Mar 30, 2023 · 3d09644 · 3d09644
1 parent 575965b
commit 3d09644
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 1 deletion.
diff --git a/site/docs.config.js b/site/docs.config.js
@@ -245,6 +245,12 @@ export default {
           path: '/mobile-vue/components/count-down',
           component: () => import('@/count-down/count-down.md'),
         },
+        {
+          title: 'Empty 空状态',
+          name: 'empty',
+          path: '/mobile-vue/components/empty',
+          component: () => import('@/empty/empty.md'),
+        },
         {
           title: 'Tag 标签',
           name: 'tag',

diff --git a/src/_common b/src/_common
diff --git a/src/empty/empty.en-US.md b/src/empty/empty.en-US.md
@@ -0,0 +1,12 @@
+:: BASE_DOC ::
+
+## API
+
+### Empty Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+action | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+description | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+icon | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+image | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
diff --git a/src/empty/empty.md b/src/empty/empty.md
@@ -0,0 +1,12 @@
+:: BASE_DOC ::
+
+## API
+
+### Empty Props
+
+名称 | 类型 | 默认值 | 说明 | 必传
+-- | -- | -- | -- | --
+action | Slot / Function | - | 操作按钮。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+description | String / Slot / Function | - | 描述文字。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+icon | String / Slot / Function | - | 图标。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
+image | String / Slot / Function | - | 图片地址。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
diff --git a/src/empty/props.ts b/src/empty/props.ts
@@ -0,0 +1,27 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import { TdEmptyProps } from './type';
+import { PropType } from 'vue';
+
+export default {
+  /** 操作按钮 */
+  action: {
+    type: Function as PropType<TdEmptyProps['action']>,
+  },
+  /** 描述文字 */
+  description: {
+    type: [String, Function] as PropType<TdEmptyProps['description']>,
+  },
+  /** 图标 */
+  icon: {
+    type: [String, Function] as PropType<TdEmptyProps['icon']>,
+  },
+  /** 图片地址 */
+  image: {
+    type: [String, Function] as PropType<TdEmptyProps['image']>,
+  },
+};
diff --git a/src/empty/type.ts b/src/empty/type.ts
@@ -0,0 +1,26 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import { TNode } from '../common';
+
+export interface TdEmptyProps {
+  /**
+   * 操作按钮
+   */
+  action?: TNode;
+  /**
+   * 描述文字
+   */
+  description?: string | TNode;
+  /**
+   * 图标
+   */
+  icon?: string | TNode;
+  /**
+   * 图片地址
+   */
+  image?: string | TNode;
+}