From 0bf222c6644ce56821ed1365906806e65fad0150 Mon Sep 17 00:00:00 2001 From: afc163 Date: Tue, 2 Apr 2019 10:26:45 +0800 Subject: [PATCH] :memo: Improve Empty doc --- components/empty/demo/simple.md | 4 ++-- components/empty/index.en-US.md | 25 ++++++++++++------------- components/empty/index.zh-CN.md | 23 ++++++++++++----------- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/components/empty/demo/simple.md b/components/empty/demo/simple.md index 5194da1f6f..58b180c569 100644 --- a/components/empty/demo/simple.md +++ b/components/empty/demo/simple.md @@ -7,11 +7,11 @@ title: ## zh-CN -可以通过设置 image 为 Empty.PRESENTED_IMAGE_SIMPLE 选择另一种风格的图片。 +可以通过设置 `image` 为 `Empty.PRESENTED_IMAGE_SIMPLE` 选择另一种风格的图片。 ## en-US -You can choose another style of image by setting image to Empty.PRESENTED_IMAGE_SIMPLE +You can choose another style of `image` by setting image to `Empty.PRESENTED_IMAGE_SIMPLE`. ```jsx import { Empty } from 'antd'; diff --git a/components/empty/index.en-US.md b/components/empty/index.en-US.md index 76af68c387..fccf075d56 100644 --- a/components/empty/index.en-US.md +++ b/components/empty/index.en-US.md @@ -9,19 +9,8 @@ Empty state placeholder. ## When To Use -When there is no data provided, display for friendly tips. - - -## Built-in image - -+ Empty.PRESENTED_IMAGE_SIMPLE - - - - -+ Empty.PRESENTED_IMAGE_DEFAULT - - +- When there is no data provided, display for friendly tips. +- User tutorial to create something in fresh new situation. ## API @@ -36,3 +25,13 @@ When there is no data provided, display for friendly tips. | description | Customize description | string \| ReactNode | - | | imageStyle | style of image | CSSProperties | - | | image | Customize image. Will tread as image url when string provided. | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | + +## Built-in images + ++ Empty.PRESENTED_IMAGE_SIMPLE + + + ++ Empty.PRESENTED_IMAGE_DEFAULT + + diff --git a/components/empty/index.zh-CN.md b/components/empty/index.zh-CN.md index 8380a0530a..8f257037b3 100644 --- a/components/empty/index.zh-CN.md +++ b/components/empty/index.zh-CN.md @@ -10,17 +10,8 @@ cols: 1 ## 何时使用 -当目前没有数据时,用于显式的用户提示。 - -## 内置图片 (3.16.0 以上版本) - -+ Empty.PRESENTED_IMAGE_SIMPLE - - - -+ Empty.PRESENTED_IMAGE_DEFAULT - - +- 当目前没有数据时,用于显式的用户提示。 +- 初始化场景时的引导创建流程。 ## API @@ -35,3 +26,13 @@ cols: 1 | description | 自定义描述内容 | string \| ReactNode | - | | imageStyle | 图片样式 | CSSProperties | - | | image | 设置显示图片,为 string 时表示自定义图片地址。 | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | + +## 内置图片 (3.16.0 以上版本) + ++ Empty.PRESENTED_IMAGE_SIMPLE + + + ++ Empty.PRESENTED_IMAGE_DEFAULT + +