介绍
在页面顶部展示消息提示,支持函数调用和组件调用两种方式。
函数调用
Notify 是一个函数,调用后会直接在页面中弹出相应的消息提示。
组件调用
通过组件调用 Notify 时,可以通过下面的方式进行注册(从 2.8.5 版本开始支持):
代码演示
基础用法
通知类型
支持 `primary`、`success`、`warning`、`danger` 四种通知类型,默认为 `danger`。
自定义通知
自定义消息通知的颜色和展示时长。
全局方法
引入 Notify 组件后,会自动在 Vue 的 prototype 上挂载 `$notify` 方法,便于在组件内调用。
组件调用
如果需要在 Notify 内嵌入组件或其他自定义内容,可以使用组件调用的方式。
API
方法
方法名 | 说明 | 参数 | 返回值 | |
---|---|---|---|---|
Notify | 展示提示 | options | message | |
Notify.clear | 关闭提示 | - | void | |
Notify.setDefaultOptions | 修改默认配置,对所有 Notify 生效 | options | void | |
Notify.resetDefaultOptions | 重置默认配置,对所有 Notify 生效 | - | void |
Options
参数 | 说明 | 类型 | 默认值 | |
---|---|---|---|---|
type | 类型,可选值为 primary success warning | string | danger | |
message | 展示文案,支持通过 \n 换行 | string | - | |
duration | 展示时长(ms),值为 0 时,notify 不会消失 | number 、 string | 3000 | |
color | 字体颜色 | string | white | |
background | 背景颜色 | string | - | |
className | 自定义类名 | any | - | |
onClick | 点击时的回调函数 | Function | - | |
onOpened | 完全展示后的回调函数 | Function | - | |
onClose | 关闭时的回调函数 | Function | - |
样式变量
组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考
。
名称 | 默认值 | 描述 | |
---|---|---|---|
@notify-text-color | @white | - | |
@notify-padding | @padding-xs @padding-md | - | |
@notify-font-size | @font-size-md | - | |
@notify-line-height | @line-height-md | - | |
@notify-primary-background-color | @blue | - | |
@notify-success-background-color | @green | - | |
@notify-danger-background-color | @red | - | |
@notify-warning-background-color | @orange | - |
效果图: