docs(empty): mobile-react 新增epmty组件文档 (#425)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
TDesignOteam · Sep 18, 2024 · 3ec0282 · 3ec0282
1 parent a41ca10
commit 3ec0282
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 4 deletions.
diff --git a/db/TDesign.db b/db/TDesign.db
diff --git a/packages/products/tdesign-mobile-react/src/empty/empty.en-US.md b/packages/products/tdesign-mobile-react/src/empty/empty.en-US.md
@@ -0,0 +1,14 @@
+:: BASE_DOC ::
+
+## API
+
+### Empty Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+className | String | - | className of component | N
+style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N
+action | TElement | - | action block。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+description | TNode | - | empty component description。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+icon | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+image | TNode | - | image url, or Image component props, or custom any node you need.。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
diff --git a/packages/products/tdesign-mobile-react/src/empty/empty.md b/packages/products/tdesign-mobile-react/src/empty/empty.md
@@ -0,0 +1,14 @@
+:: BASE_DOC ::
+
+## API
+
+### Empty Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+className | String | - | 类名 | N
+style | Object | - | 样式，TS 类型：`React.CSSProperties` | N
+action | TElement | - | 操作按钮。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+description | TNode | - | 描述文字。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+icon | TNode | - | 图标。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+image | TNode | - | 图片地址。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
diff --git a/packages/products/tdesign-mobile-react/src/empty/type.ts b/packages/products/tdesign-mobile-react/src/empty/type.ts
@@ -0,0 +1,26 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import { TNode, TElement } from '../common';
+
+export interface TdEmptyProps {
+  /**
+   * 操作按钮
+   */
+  action?: TElement;
+  /**
+   * 描述文字
+   */
+  description?: TNode;
+  /**
+   * 图标
+   */
+  icon?: TNode;
+  /**
+   * 图片地址
+   */
+  image?: TNode;
+}
diff --git a/packages/scripts/api.json b/packages/scripts/api.json
@@ -45984,7 +45984,8 @@
     {
       "id": 1712661318,
       "platform_framework": [
-        "8"
+        "8",
+        "16"
       ],
       "component": "Empty",
       "field_category": 1,
@@ -46013,7 +46014,8 @@
       "support_default_value": 0,
       "field_category_text": "Props",
       "platform_framework_text": [
-        "Vue(Mobile)"
+        "Vue(Mobile)",
+        "React(Mobile)"
       ],
       "field_type_text": [
         "String",
@@ -46026,7 +46028,6 @@
         "1",
         "2",
         "4",
-        "16",
         "32"
       ],
       "component": "Empty",
@@ -46059,7 +46060,6 @@
         "Vue(PC)",
         "React(PC)",
         "Angular(PC)",
-        "React(Mobile)",
         "Angular(Mobile)"
       ],
       "field_type_text": [
@@ -46071,6 +46071,7 @@
       "id": 1712661364,
       "platform_framework": [
         "8",
+        "16",
         "64"
       ],
       "component": "Empty",
@@ -46101,6 +46102,7 @@
       "field_category_text": "Props",
       "platform_framework_text": [
         "Vue(Mobile)",
+        "React(Mobile)",
         "Miniprogram"
       ],
       "field_type_text": [