# message (w-message)

- **Import**: `WMessage` from `win-design-next`
- **Tag**: `<w-message>`
- **说明**: Message 消息提示
- **分类**: feedback
- **Skill 版本**: V1.1.0
- **适配组件库**: win-design-next 1.2.2
- **API 来源**: `docs/zh-CN/component/message.md`

## API

## API

### Message 配置项

| 名称                     | 说明                                                                    | 类型                                                                                       | 默认值  |
| ------------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------- |
| message                  | 消息文字                                                                | ^[string] / ^[VNode] / ^[Function]`() => VNode`                                            | ''      |
| type                     | 消息类型                                                                | ^[enum]`'success' \| 'warning' \| 'info' \| 'danger' \| 'error' \| 'primary'`              | primary |
| plain                    | 是否纯色                                                                | ^[boolean]                                                                                 | false   |
| icon                     | 自定义图标，该属性会覆盖 `type` 的图标。                                | ^[string] / ^[Component]                                                                   | —       |
| dangerouslyUseHTMLString | 是否将 message 属性作为 HTML 片段处理                                   | ^[boolean]                                                                                 | false   |
| customClass              | 自定义类名                                                              | ^[string]                                                                                  | ''      |
| duration                 | 显示时间，单位为毫秒。 设为 0 则不会自动关闭                            | ^[number]                                                                                  | 3000    |
| showClose                | 是否显示关闭按钮                                                        | ^[boolean]                                                                                 | false   |
| onClose                  | 关闭时的回调函数, 参数为被关闭的 message 实例                           | ^[Function]`() => void`                                                                    | —       |
| offset                   | Message 距离窗口顶部的偏移量                                            | ^[number]                                                                                  | 16      |
| appendTo                 | 设置 message 的根元素，默认为 `document.body`                           | ^[string] / ^[HTMLElement]                                                                 | —       |
| grouping                 | 合并内容相同的消息，不支持 VNode 类型的消息                             | ^[boolean]                                                                                 | false   |
| repeatNum                | 重复次数，类似于 Badge 。当和 `grouping` 属性一起使用时作为初始数量使用 | ^[number]                                                                                  | 1       |
| placement ^(1.0.2)       | 位置                                                                    | ^[enum]`'top' \| 'top-left' \| 'top-right' \| 'bottom' \| 'bottom-left' \| 'bottom-right'` | top     |
| detail ^(1.0.10)         | 详细信息，用于显示额外的消息内容                                        | ^[string]                                                                                  | —       |
| detailVisible ^(1.0.10)  | 是否默认展开额外的消息内容                                              | ^[boolean]                                                                                 | false   |

### Message 方法

调用 `Message` 或 `this.$message` 会返回当前 Message 的实例。 如果需要手动关闭实例，可以调用它的 `close` 方法。

| 名称  | 描述               | 类型                    |
| ----- | ------------------ | ----------------------- |
| close | 关闭当前的 Message | ^[Function]`() => void` |
