# notification (w-notification)

- **Import**: `WNotification` from `win-design-next`
- **Tag**: `<w-notification>`
- **说明**: Notification 通知
- **分类**: feedback
- **Skill 版本**: V1.1.0
- **适配组件库**: win-design-next 1.2.2
- **API 来源**: `docs/zh-CN/component/notification.md`

## API

## API

### 配置项

| 名称                     | 说明                                                                                          | 类型                                                                                | 默认      |
| ------------------------ | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------- |
| title                    | 标题                                                                                          | ^[string]                                                                           | ''        |
| message                  | 通知栏正文内容                                                                                | ^[string] / ^[VNode] / ^[Function]`() => VNode`                                     | ''        |
| dangerouslyUseHTMLString | 是否将 message 属性作为 HTML 片段处理                                                         | ^[boolean]                                                                          | false     |
| type                     | 通知的类型                                                                                    | ^[enum]`'success' \| 'warning' \| 'info' \| 'error' \| 'danger' \| 'primary' \| ''` | ''        |
| icon                     | 自定义图标。 若设置了 `type`，则 `icon` 会被覆盖                                              | ^[string] / ^[Component]                                                            | —         |
| customClass              | 自定义类名                                                                                    | ^[string]                                                                           | ''        |
| duration                 | 显示时间, 单位为毫秒。 值为 0 则不会自动关闭                                                  | ^[number]                                                                           | 4500      |
| position                 | 自定义弹出位置                                                                                | ^[enum]`'top-right' \| 'top-left' \| 'bottom-right' \| 'bottom-left'`               | top-right |
| showClose                | 是否显示关闭按钮                                                                              | ^[boolean]                                                                          | true      |
| onClose                  | 关闭时的回调函数                                                                              | ^[Function]`() => void`                                                             | —         |
| onClick                  | 点击 Notification 时的回调函数                                                                | ^[Function]`() => void`                                                             | —         |
| offset                   | 相对屏幕顶部的偏移量 偏移的距离，在同一时刻，所有的 Notification 实例应当具有一个相同的偏移量 | ^[number]                                                                           | 0         |
| appendTo                 | 设置 notification 的根元素，默认为 `document.body`                                            | ^[string] / ^[HTMLElement]                                                          | —         |
| zIndex                   | 初始 zIndex                                                                                   | ^[number]                                                                           | 0         |

### 方法

`Notification` 和 `this.$notify` 都返回当前的 Notification 实例。 如果需要手动关闭实例，可以调用它的 `close` 方法。

| 名称  | 详情                    | 类型                    |
| ----- | ----------------------- | ----------------------- |
| close | 关闭当前的 Notification | ^[Function]`() => void` |
