From 5b3826d6cd60a9ac5dc8120501c149ee2a518fdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=B8=85?= Date: Sat, 18 Aug 2018 00:22:19 +0800 Subject: [PATCH] add backText api doc --- src/components/Exception/index.en-US.md | 1 + src/components/Exception/index.zh-CN.md | 13 +++++++------ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/components/Exception/index.en-US.md b/src/components/Exception/index.en-US.md index 320b0e71..10f23a0a 100644 --- a/src/components/Exception/index.en-US.md +++ b/src/components/Exception/index.en-US.md @@ -10,6 +10,7 @@ Exceptions page is used to provide feedback on specific abnormal state. Usually, Property | Description | Type | Default ---------|-------------|------|-------- +| backText | default return button text | ReactNode | back to home | type | type of exception, the corresponding default `title`, `desc`, `img` will be given if set, which can be overridden by explicit setting of `title`, `desc`, `img` | Enum {'403', '404', '500'} | - title | title | ReactNode | - desc | supplementary description | ReactNode | - diff --git a/src/components/Exception/index.zh-CN.md b/src/components/Exception/index.zh-CN.md index 13e4e7ef..bc7e5f1d 100644 --- a/src/components/Exception/index.zh-CN.md +++ b/src/components/Exception/index.zh-CN.md @@ -9,11 +9,12 @@ order: 5 ## API -| 参数 | 说明 | 类型 | 默认值 | +| 参数 | 说明| 类型 | 默认值 | |-------------|------------------------------------------|-------------|-------| -| type | 页面类型，若配置，则自带对应类型默认的 `title`，`desc`，`img`，此默认设置可以被 `title`，`desc`，`img` 覆盖 | Enum {'403', '404', '500'} | - | -| title | 标题 | ReactNode | - | -| desc | 补充描述 | ReactNode | - | -| img | 背景图片地址 | string | - | -| actions | 建议操作，配置此属性时默认的『返回首页』按钮不生效 | ReactNode | - | +| backText| 默认的返回按钮文本 | ReactNode| back to home | +| type| 页面类型，若配置，则自带对应类型默认的 `title`，`desc`，`img`，此默认设置可以被 `title`，`desc`，`img` 覆盖 | Enum {'403', '404', '500'} | - | +| title | 标题 | ReactNode| -| +| desc| 补充描述| ReactNode| -| +| img | 背景图片地址 | string| -| +| actions | 建议操作，配置此属性时默认的『返回首页』按钮不生效| ReactNode| -| | linkElement | 定义链接的元素 | string\|ReactElement | 'a' | -- GitLab