通知

在页面的一角显示全局通知消息。

基本用法

Element Plus Mobile 已注册 $notify 方法,并且它接收一个对象作为其参数。在最简单的情况下,您可以为通知的​​标题和正文设置 title 字段和 message 字段。默认情况下,通知会在 4500 毫秒后自动关闭,但通过设置 duration 您可以控制其持续时间。具体来说,如果设置为0,则不会自动关闭。请注意,duration 以毫秒为单位接收 Number

有类型

我们提供四种类型:成功、警告、信息和错误。

Element Plus Mobile 提供四种通知类型:primarysuccesswarninginfoerror。它们由 type 字段设置,其他值将被忽略。我们还为这些类型注册了可以像 open3open4 一样直接调用的方法,而无需传递 type 字段。 primary 已添加到 2.9.11 中。

自定义位置

通知可以从您喜欢的任何角落出现。

position 属性定义通知滑入哪个角落。它可以是 top-righttop-leftbottom-rightbottom-left。默认为 top-right

带偏移量

自定义通知距屏幕边缘的偏移量。

设置 offset 属性以自定义通知距屏幕边缘的偏移量。请注意,同一时刻的每个通知实例应该具有相同的偏移量。

使用 HTML 字符串

message 支持 HTML 字符串。

dangerouslyUseHTMLString 设置为 true,message 将被视为 HTML 字符串。

WARNING

尽管 message 属性支持 HTML 字符串,但在网站上动态呈现任意 HTML 可能非常危险,因为它很容易导致 XSS 攻击。因此,当 dangerouslyUseHTMLString 打开时,请确保 message 的内容是可信的,并且永远不要message 分配给用户提供的内容。

使用函数发送消息 2.9.0

message可以是VNode。

2.9.0之后,message支持返回值为VNode的函数。

隐藏关闭按钮

可以隐藏关闭按钮

showClose 属性设置为 false,以便用户无法关闭通知。

全局方法

Element Plus Mobile 为 app.config.globalProperties 添加了全局方法 $notify。因此,在 vue 实例中,您可以像我们在本页面中所做的那样调用 Notification

本地导入

javascript
import { ElNotification } from 'element-plus-mobile'

ElNotification({
  title: 'Title',
  message: 'This is a message',
  closeIcon: 'ep:close-bold',
})

在这种情况下,您应该致电 ElNotification(options)。我们还为不同类型注册了方法,例如ElNotification.success(options)。您可以调用ElNotification.closeAll()手动关闭所有实例。在2.10.5中,您可以通过调用ElNotification.updateOffsets(position)手动更新特定方向上所有实例的偏移量。

应用程序上下文继承

现在,通知接受 context 作为消息构造函数的第二个参数,这允许您将当前应用程序的上下文注入到通知中,从而允许您继承应用程序的所有属性。

你可以这样使用它:

TIP

如果您全局注册了ElNotification组件,它将自动继承您的应用程序上下文。

ts
import { getCurrentInstance } from 'vue'
import { ElNotification } from 'element-plus-mobile'

// in your setup method
const { appContext } = getCurrentInstance()!
ElNotification({}, appContext)

API

选项

名称描述类型默认
标题标题字符串''
留言描述文字字符串 / VNode / 函数''
危险地使用HTMLStringmessage 是否被视为 HTML 字符串布尔值
类型通知类型枚举''
图标自定义图标组件。它将被 type 覆盖字符串 / 组件
定制类通知的自定义类名字符串''
持续时间关闭前的持续时间。如果设置为0则不会自动关闭数字4500
位置自定义位置枚举右上角
显示关闭是否显示关闭按钮布尔值真实
关闭关闭时的回调函数功能
点击点击通知时的回调函数功能
偏移距屏幕上边缘的偏移量。同一时刻的每个通知实例应该具有相同的偏移量数字0
追加到设置通知的根元素,默认为 document.bodyCSS选择器 / HTMLElement
z索引初始 zIndex数字0
关闭图标 2.9.8自定义关闭图标字符串 / 组件关闭

方法

Notificationthis.$notify 返回当前的通知实例。如需手动关闭实例,您可以调用close

名称描述类型
关闭关闭通知功能