diff --git a/components/alert/demo/basic.md b/components/alert/demo/basic.md index b015a58a3a..02b0e57b58 100644 --- a/components/alert/demo/basic.md +++ b/components/alert/demo/basic.md @@ -1,13 +1,22 @@ --- order: 0 -title: 基本 +title: + zh-CN: 基本 + en-US: Basic --- +## zh-CN + 最简单的用法,适用于简短的警告提示。 +## en-US + +The simplest usage for short messages. + ````jsx import { Alert } from 'antd'; -ReactDOM.render( +ReactDOM.render( + , mountNode); ```` diff --git a/components/alert/demo/closable.md b/components/alert/demo/closable.md index fb3e14ccd1..57d9c3a707 100644 --- a/components/alert/demo/closable.md +++ b/components/alert/demo/closable.md @@ -1,25 +1,33 @@ --- order: 2 -title: 可关闭的警告提示 +title: + zh-CN: 可关闭的警告提示 + en-US: Closable --- +## zh-CN + 显示关闭按钮,点击可关闭警告提示。 +## en-US + +To show close button. + ````jsx import { Alert } from 'antd'; const onClose = function (e) { - console.log(e, '我要被关闭啦!'); + console.log(e, 'I was closed.'); }; ReactDOM.render(
- - + , mountNode); ```` diff --git a/components/alert/demo/description.md b/components/alert/demo/description.md index e597381225..9d8c5fd189 100644 --- a/components/alert/demo/description.md +++ b/components/alert/demo/description.md @@ -1,30 +1,40 @@ --- order: 3 -title: 含有辅助性文字介绍 +title: + zh-CN: 含有辅助性文字介绍 + en-US: Description --- +## zh-CN + 含有辅助性文字介绍的警告提示。 +## en-US + +Additional description for alert message. + ````jsx import { Alert } from 'antd'; ReactDOM.render(
- -
, mountNode); diff --git a/components/alert/demo/icon.md b/components/alert/demo/icon.md index cfb36a42cc..a6fda9ec68 100644 --- a/components/alert/demo/icon.md +++ b/components/alert/demo/icon.md @@ -1,10 +1,18 @@ --- order: 4 -title: 图标 +title: + zh-CN: 图标 + en-US: Icon --- +## zh-CN + 可口的图标让信息类型更加醒目。 +## en-US + +Decent icon make information more clear and more friendly. + ````jsx import { Alert } from 'antd'; @@ -13,12 +21,14 @@ ReactDOM.render(
- - - - - - + + + +
, mountNode); ```` diff --git a/components/alert/index.en-US.md b/components/alert/index.en-US.md new file mode 100644 index 0000000000..160f8d18a7 --- /dev/null +++ b/components/alert/index.en-US.md @@ -0,0 +1,24 @@ +--- +category: Components +type: Views +english: Alert +--- + +Alert component for feedback. + +## When to use + +- When you need to show alert messages for users. +- When you need a persist static container, and closable by user actions. + +## API + +| Property | Description | Type | Default | +|----------- |--------------------------------------------------------- | ---------- |-------| +| type | Type of Alert styles, options:`success`, `info`, `warning`, `error` | String | `info` | +| closable | Whether Alert can be closed | Boolean | - | +| closeText | Close text to show | React.Node | - | +| message | Content of Alert | React.Node | - | +| description | Additional content of Alert | React.Node | - | +| onClose | Callback when close Alert | Function | - | +| showIcon | Whether to show icon | Boolean | false | diff --git a/components/alert/index.md b/components/alert/index.md deleted file mode 100644 index 9d4364f073..0000000000 --- a/components/alert/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -category: Components -chinese: 警告提示 -type: Views -english: Alert ---- - -警告提示,展现需要关注的信息。 - -## 何时使用 - -- 当某个页面需要向用户显示警告的信息时。 -- 非浮层的静态展现形式,始终展现,不会自动消失,用户可以点击关闭。 - -## API - -| 参数 | 说明 | 类型 | 默认值 | -|----------- |--------------------------------------------------------- | ---------- |-------| -| type | 必选参数,指定警告提示的样式,有四种选择 `success`、`info`、`warning`、`error` | String | `info` | -| closable | 可选参数,默认不显示关闭按钮 | Boolean | 无 | -| closeText | 可选参数,自定义关闭按钮 | React.Node | 无 | -| message | 必选参数,警告提示内容 | React.Node | 无 | -| description | 可选参数,警告提示的辅助性文字介绍 | React.Node | 无 | -| onClose | 可选参数,关闭时触发的回调函数 | Function | 无 | -| showIcon | 可选参数,是否显示辅助图标 | Boolean | false | diff --git a/components/alert/index.zh-CN.md b/components/alert/index.zh-CN.md new file mode 100644 index 0000000000..13ad5c908c --- /dev/null +++ b/components/alert/index.zh-CN.md @@ -0,0 +1,25 @@ +--- +category: Components +chinese: 警告提示 +type: Views +english: Alert +--- + +警告提示,展现需要关注的信息。 + +## 何时使用 + +- 当某个页面需要向用户显示警告的信息时。 +- 非浮层的静态展现形式,始终展现,不会自动消失,用户可以点击关闭。 + +## API + +| 参数 | 说明 | 类型 | 默认值 | +|----------- |--------------------------------------------------------- | ---------- |-------| +| type | 指定警告提示的样式,有四种选择 `success`、`info`、`warning`、`error` | String | `info` | +| closable | 默认不显示关闭按钮 | Boolean | 无 | +| closeText | 自定义关闭按钮 | React.Node | 无 | +| message | 警告提示内容 | React.Node | 无 | +| description | 警告提示的辅助性文字介绍 | React.Node | 无 | +| onClose | 关闭时触发的回调函数 | Function | 无 | +| showIcon | 是否显示辅助图标 | Boolean | false |