Commit 5b3826d6 authored by 陈帅's avatar 陈帅

add backText api doc

parent 3928e0d6
...@@ -10,6 +10,7 @@ Exceptions page is used to provide feedback on specific abnormal state. Usually, ...@@ -10,6 +10,7 @@ Exceptions page is used to provide feedback on specific abnormal state. Usually,
Property | Description | Type | Default 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'} | - 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 | - title | title | ReactNode | -
desc | supplementary description | ReactNode | - desc | supplementary description | ReactNode | -
......
...@@ -9,11 +9,12 @@ order: 5 ...@@ -9,11 +9,12 @@ order: 5
## API ## API
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明| 类型 | 默认值 |
|-------------|------------------------------------------|-------------|-------| |-------------|------------------------------------------|-------------|-------|
| type | 页面类型,若配置,则自带对应类型默认的 `title``desc``img`,此默认设置可以被 `title``desc``img` 覆盖 | Enum {'403', '404', '500'} | - | | backText| 默认的返回按钮文本 | ReactNode| back to home |
| title | 标题 | ReactNode | - | | type| 页面类型,若配置,则自带对应类型默认的 `title``desc``img`,此默认设置可以被 `title``desc``img` 覆盖 | Enum {'403', '404', '500'} | - |
| desc | 补充描述 | ReactNode | - | | title | 标题 | ReactNode| -|
| img | 背景图片地址 | string | - | | desc| 补充描述| ReactNode| -|
| actions | 建议操作,配置此属性时默认的『返回首页』按钮不生效 | ReactNode | - | | img | 背景图片地址 | string| -|
| actions | 建议操作,配置此属性时默认的『返回首页』按钮不生效| ReactNode| -|
| linkElement | 定义链接的元素 | string\|ReactElement | 'a' | | linkElement | 定义链接的元素 | string\|ReactElement | 'a' |
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment