# message 告警提示组件 Beta
# 使用示例
默认
小尺寸长文字
大尺寸
全局调用
操作
复制代码
# Options
| 参数 | 必填 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|---|
| message | 否 | 消息文字 | string / VNode | — | — |
| type | 主题 | 主题 | string | string / success/warning/info/error | info |
dangerouslyUseHTMLString | 否 | 是否将 message 属性作为 HTML 片段处理 | boolean | — | false |
| duration | 否 | 显示时间, 毫秒。设为 0 则不会自动关闭 | number | — | 3000 |
| iconClass | 否 | 自定义图标的类名,会覆盖 type | string | — | — |
| showClose | 否 | 是否显示关闭按钮 | boolean | — | false |
| center | 否 | 文字是否居中 | boolean | — | false |
| onClose | 否 | 关闭时的回调函数, 参数为被关闭的 YKcWarningTips 实例 | function | — | — |
| offset | 否 | YKcWarningTips 距离窗口顶部的偏移量 | number | — | 20 |
# 方法
调用 YKcWarningTips 或 this.$tips 会返回当前 YKcWarningTips 的实例。
如果需要手动关闭实例,可以调用它的 close 方法。
| 方法名 | 说明 |
|---|---|
close | 关闭当前的 YKcWarningTips |
# 全局方法
YKC UI 为 · 添加了全局方法 $tips。因此在 vue instance 中可以采用本页面中的方式调用 YKcWarningTips。
# 单独引入
单独引入 YKcWarningTips:
import YKcWarningTips from '@ykc/ykc-ui/packages/warning-tips';
此时调用方法为 YKcWarningTips(options)。
我们也为每个 type 定义了各自的方法,如 YKcWarningTips.success(options)。
并且可以调用 YKcWarningTips.closeAll() 手动关闭所有实例。
# VNode 作为消息内容
复制代码
# 使用 HTML 片段
message 属性支持传入 HTML 片段
复制代码
!> message 属性虽然支持传入 HTML 片段,但是在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 XSS 攻击。因此在 dangerouslyUseHTMLString 打开的情况下,请确保 message 的内容是可信的,永远不要将用户提交的内容赋值给 message 属性。