naive-ui/demo/documentation/components/notification/zhCN/index.md

70 lines
2.7 KiB
Markdown
Raw Normal View History

2020-02-04 14:10:35 +08:00
# 通知 Notification
通知某人。
UI 同志很早就设计完了。但是,你也知道,像是通知组件这种东西优先级不那么高,所以我可以弄一堆没什么用的动画上去。
## 演示
```demo
basic
type
change-content
scrollable
closable
duration
```
## API
#### $Notification API
#### $NNotification Methods
2020-02-07 23:40:07 +08:00
|名称|类型|说明|
2020-02-04 14:10:35 +08:00
|-|-|-|
2020-02-05 12:21:18 +08:00
|open|`(option: NotificationOption, type: string = 'default') => NotificationEnvironment`|`type` 可以是 `'default'`, `'warning'`, `'info'`, `'success'``'error'`|
|success|`(option: NofiticationOption) => NotificationEnvironment`||
|info|`(option: NofiticationOption) => NotificationEnvironment`||
|warning|`(option: NofiticationOption) => NotificationEnvironment`||
|error|`(option: NofiticationOption) => NotificationEnvironment`||
2020-02-04 14:10:35 +08:00
#### $Notification Properties
2020-02-07 23:40:07 +08:00
|名称|类型|默认值|说明|
2020-02-04 14:10:35 +08:00
|-|-|-|-|
|scrollable|`boolean`|`false`||
### NotificationOption API
#### NotificationOption Type
2020-02-07 23:40:07 +08:00
|名称|类型|默认值|说明|
2020-02-04 14:10:35 +08:00
|-|-|-|-|
2020-03-19 22:21:09 +08:00
|theme|`'light' \| 'dark'`|`null`||
|avatar|`() => VNode \| Array<VNode>`|`null`|可以是 render 函数|
2020-02-29 14:55:52 +08:00
|title|`string \| (() => VNode \| Array<VNode>)`|`null`|可以是 render 函数|
|description|`string \| (() => VNode \| Array<VNode>)`|`null`|可以是 render 函数|
|content|`string \| (() => VNode \| Array<VNode>)`|`null`|可以是 render 函数|
|meta|`string \| (() => VNode \| Array<VNode>)`|`null`|可以是 render 函数|
|action|`string \| (() => VNode \| Array<VNode>)`|`null`|可以是 render 函数|
2020-02-04 14:10:35 +08:00
|closable|`boolean`|`true`||
|onClose|`() => boolean \| Promise<boolean> \| any`|`() => {}`|关闭通知的回调。返回 `false`、Promise resolve `false` 或者 reject 会取消这次关闭|
2020-02-04 14:10:35 +08:00
|onAfterHide|`function`|`null`||
|onAfterShow|`function`|`null`||
|duration|`number`|`null`|如果没有设定则不会自动关闭,单位毫秒|
### NotificationEnvironment API
#### NotificationEnvironment Properties
NofiticationEnvironment 实例的属性可以被动态改变。
2020-02-07 23:40:07 +08:00
|名称|类型|说明|
2020-02-04 14:10:35 +08:00
|-|-|-|
|avatar|`() => VNode \| Array<VNode>`|可以是 render 函数|
2020-02-29 14:55:52 +08:00
|title|`string \| (() => VNode \| Array<VNode>)`|可以是 render 函数|
|description|`string \| (() => VNode \| Array<VNode>)`|可以是 render 函数|
|content|`string \| (() => VNode \| Array<VNode>)`|可以是 render 函数|
|meta|`string \| (() => VNode \| Array<VNode>)`|可以是 render 函数|
|action|`string \| (() => VNode \| Array<VNode>)`|可以是 render 函数|
2020-02-04 14:10:35 +08:00
|closable|`boolean`||
|onClose|`(next: function) => any`|点击了关闭按钮的回调。只有调用了 next 通知才会被关闭|
|onHide|`function`||
|onAfterHide|`function`||
|onAfterShow|`function`||
#### NotificationEnvironment Methods
2020-02-07 23:40:07 +08:00
|名称|类型|说明|
2020-02-04 14:10:35 +08:00
|-|-|-|
|hide|`()`||