Procházet zdrojové kódy

[stdf]Update snippets in api documents.

dufu1991 před 1 rokem
rodič
revize
47a7e3fa47

+ 3 - 3
doc/components/bottomSheet/api.md

@@ -29,6 +29,6 @@
 
 ## BottomSheet Snippets
 
-| 名称     | 说明               |
-| -------- | ------------------ |
-| children | BottomSheet 内容。 |
+| 名称     | 类型      | 参数 | 说明   |
+| -------- | --------- | ---- | ------ |
+| children | `Snippet` | -    | 内容。 |

+ 3 - 3
doc/components/bottomSheet/api_en.md

@@ -29,6 +29,6 @@
 
 ## BottomSheet Snippets
 
-| Name     | Description          |
-| -------- | -------------------- |
-| children | BottomSheet content. |
+| Name     | Type      | Parameters | Description          |
+| -------- | --------- | ---------- | -------------------- |
+| children | `Snippet` | -          | BottomSheet content. |

+ 3 - 3
doc/components/button/api.md

@@ -28,6 +28,6 @@
 
 ## Button Snippets
 
-| 名称     | 说明       |
-| -------- | ---------- |
-| children | 按钮内容。 |
+| 名称     | 类型      | 参数 | 说明       |
+| -------- | --------- | ---- | ---------- |
+| children | `Snippet` | -    | 按钮内容。 |

+ 3 - 3
doc/components/button/api_en.md

@@ -28,6 +28,6 @@
 
 ## Button Snippets
 
-| Name     | Description     |
-| -------- | --------------- |
-| children | Button content. |
+| Name     | Type      | Parameters | Description     |
+| -------- | --------- | ---------- | --------------- |
+| children | `Snippet` | -          | Button content. |

+ 6 - 6
doc/components/grids/api.md

@@ -9,9 +9,9 @@
 
 ## Grids Snippets
 
-| 名称     | 说明         |
-| -------- | ------------ |
-| children | Grids 内容。 |
+| 名称     | 类型      | 参数 | 说明         |
+| -------- | --------- | ---- | ------------ |
+| children | `Snippet` | -    | Grids 内容。 |
 
 ## Grid Props
 
@@ -22,6 +22,6 @@
 
 ## Grid Snippets
 
-| 名称     | 说明        |
-| -------- | ----------- |
-| children | Grid 内容。 |
+| 名称     | 类型      | 参数 | 说明        |
+| -------- | --------- | ---- | ----------- |
+| children | `Snippet` | -    | Grid 内容。 |

+ 6 - 6
doc/components/grids/api_en.md

@@ -9,9 +9,9 @@
 
 ## Grids Snippets
 
-| Name     | Description   |
-| -------- | ------------- |
-| children | Grids content |
+| Name     | Type      | Parameters | Description   |
+| -------- | --------- | ---------- | ------------- |
+| children | `Snippet` | -          | Grids content |
 
 ## Grid Props
 
@@ -22,6 +22,6 @@
 
 ## Grid Snippets
 
-| Name     | Description  |
-| -------- | ------------ |
-| children | Grid content |
+| Name     | Type      | Parameters | Description  |
+| -------- | --------- | ---------- | ------------ |
+| children | `Snippet` | -          | Grid content |

+ 3 - 3
doc/components/icon/api.md

@@ -12,6 +12,6 @@
 
 ## Icon Snippets
 
-| 名称     | 说明                                      |
-| -------- | ----------------------------------------- |
-| children | 自定义内容,一般是 Icon 组件或 SVG 元素。 |
+| 名称     | 类型      | 参数 | 说明                                      |
+| -------- | --------- | ---- | ----------------------------------------- |
+| children | `Snippet` | -    | 自定义内容,一般是 Icon 组件或 SVG 元素。 |

+ 3 - 3
doc/components/icon/api_en.md

@@ -12,6 +12,6 @@
 
 ## Icon Snippets
 
-| Name     | Description                                            |
-| -------- | ------------------------------------------------------ |
-| children | Custom content, usually Icon component or SVG element. |
+| Name     | Type      | Parameters | Description                                            |
+| -------- | --------- | ---------- | ------------------------------------------------------ |
+| children | `Snippet` | -          | Custom content, usually Icon component or SVG element. |

+ 3 - 3
doc/components/mask/api.md

@@ -19,6 +19,6 @@
 
 ## Mask Snippets
 
-| 名称     | 说明       |
-| -------- | ---------- |
-| children | 遮罩内容。 |
+| 名称     | 类型      | 参数 | 说明       |
+| -------- | --------- | ---- | ---------- |
+| children | `Snippet` | -    | 遮罩内容。 |

+ 3 - 3
doc/components/mask/api_en.md

@@ -19,6 +19,6 @@
 
 ## Mask Snippets
 
-| Name     | Description   |
-| -------- | ------------- |
-| children | Mask content. |
+| Name     | Type      | Parameters | Description   |
+| -------- | --------- | ---------- | ------------- |
+| children | `Snippet` | -          | Mask content. |

+ 5 - 5
doc/components/navBar/api.md

@@ -18,8 +18,8 @@
 
 ## NavBar Snippets
 
-| 名称       | 说明                 |
-| ---------- | -------------------- |
-| titleChild | 传入时渲染标题区域。 |
-| leftChild  | 传入时渲染左侧区域。 |
-| rightChild | 传入时渲染右侧区域。 |
+| 名称       | 类型      | 参数 | 说明                 |
+| ---------- | --------- | ---- | -------------------- |
+| titleChild | `Snippet` | -    | 传入时渲染标题区域。 |
+| leftChild  | `Snippet` | -    | 传入时渲染左侧区域。 |
+| rightChild | `Snippet` | -    | 传入时渲染右侧区域。 |

+ 5 - 5
doc/components/navBar/api_en.md

@@ -18,8 +18,8 @@
 
 ## NavBar Snippets
 
-| Name       | Description                     |
-| ---------- | ------------------------------- |
-| titleChild | Renders title area when passed. |
-| leftChild  | Renders left area when passed.  |
-| rightChild | Renders right area when passed. |
+| Name       | Type      | Parameters | Description                     |
+| ---------- | --------- | ---------- | ------------------------------- |
+| titleChild | `Snippet` | -          | Renders title area when passed. |
+| leftChild  | `Snippet` | -          | Renders left area when passed.  |
+| rightChild | `Snippet` | -          | Renders right area when passed. |

+ 3 - 3
doc/components/placeholder/api.md

@@ -10,6 +10,6 @@
 
 ## Placeholder Snippets
 
-| 名称     | 说明               |
-| -------- | ------------------ |
-| children | Placeholder 内容。 |
+| 名称     | 类型      | 参数 | 说明               |
+| -------- | --------- | ---- | ------------------ |
+| children | `Snippet` | -    | Placeholder 内容。 |

+ 3 - 3
doc/components/placeholder/api_en.md

@@ -10,6 +10,6 @@
 
 ## Placeholder Snippets
 
-| Name     | Description          |
-| -------- | -------------------- |
-| children | Placeholder content. |
+| Name     | Type      | Parameters | Description          |
+| -------- | --------- | ---------- | -------------------- |
+| children | `Snippet` | -          | Placeholder content. |

+ 3 - 3
doc/components/popup/api.md

@@ -31,9 +31,9 @@
 
 ## Popup Snippets
 
-| 名称     | 说明         |
-| -------- | ------------ |
-| children | Popup 内容。 |
+| 名称     | 类型      | 参数 | 说明         |
+| -------- | --------- | ---- | ------------ |
+| children | `Snippet` | -    | Popup 内容。 |
 
 ## SvelteEasing
 

+ 3 - 3
doc/components/popup/api_en.md

@@ -31,9 +31,9 @@
 
 ## Popup Snippets
 
-| Name     | Description    |
-| -------- | -------------- |
-| children | Popup content. |
+| Name     | Type      | Parameters | Description    |
+| -------- | --------- | ---------- | -------------- |
+| children | `Snippet` | -          | Popup content. |
 
 ## SvelteEasing
 

+ 1 - 1
doc/components/steps/api.md

@@ -8,7 +8,7 @@
 | barBorder | `boolean`                         | `true`   | N    | 图标是否带边框。                            |
 | vertical  | `boolean`                         | `false`  | N    | 是否纵向布局。                              |
 
-## StepsItem
+## StepsItem Props
 
 | 名称       | 类型              | 默认值 | 必传 | 说明                                                 |
 | ---------- | ----------------- | ------ | ---- | ---------------------------------------------------- |

+ 1 - 1
doc/components/steps/api_en.md

@@ -8,7 +8,7 @@
 | barBorder | `boolean`                         | `true`   | N        | Whether the icon has a border.                    |
 | vertical  | `boolean`                         | `false`  | N        | Whether to use vertical layout.                   |
 
-## StepsItem
+## StepsItem Props
 
 | Name       | Type              | Default | Required | Description                                                                |
 | ---------- | ----------------- | ------- | -------- | -------------------------------------------------------------------------- |