Notification

Displays a global notification message at a corner of the page.

Basic usage

Bigin UI has registered the $notify method and it receives an object as its parameter. In the simplest case, you can set the title field and the message field for the title and body of the notification. By default, the notification automatically closes after 4500ms, but by setting duration you can control its duration. Specifically, if set to 0, it will not close automatically. Note that duration receives a Number in milliseconds.

Types

We provide four types: success, warning, info and error.

Bigin UI provides four notification types: success, warning, info and error. They are set by the type field, and other values will be ignored. We also registered methods for these types that can be invoked directly like open3 and open4 without passing a type field.

Custom Position

Notification can emerge from any corner you like. The position attribute defines which corner Notification slides in. It can be top-right, top-left, bottom-right or bottom-left. Defaults to top-right.

With Offset

Customize Notification's offset from the edge of the screen. Set the offset attribute to customize Notification's offset from the edge of the screen. Note that every Notification instance of the same moment should have the same offset.

Use HTML String

message supports HTML string. Set dangerouslyUseHTMLString to true and message will be treated as an HTML string.

WARNING

Although message property supports HTML strings, dynamically rendering arbitrary HTML on your website can be very dangerous because it can easily lead to XSS attacks. So when dangerouslyUseHTMLString is on, please make sure the content of message is trusted, and never assign message to user-provided content.

Hide Close Button

It is possible to hide the close button. Set the showClose attribute to false so the notification cannot be closed by the user.

Global method

Bigin UI has added a global method $notify for app.config.globalProperties. So in a vue instance you can call Notification like what we did in this page.

Local Import

import { BNotification } from 'bigin-ui'

In this case you should call BNotification(options). We have also registered methods for different types, e.g. BNotification.success(options). You can call BNotification.closeAll() to manually close all the instances.

App Context Inheritance

Now notification accepts a context as second parameter of the message constructor which allows you to inject current app's context to notification which allows you to inherit all the properties of the app.

You can use it like this:

TIP

If you globally registered BNotification component, it will automatically inherit your app context.

import { getCurrentInstance } from 'vue'
import { BNotification } from 'bigin-ui'
// in your setup method
const { appContext } = getCurrentInstance()!
BNotification({}, appContext)

Options

Attribute	Description	Type	Accepted Values	Default
title	title	string	—	—
message	description text	string/Vue.VNode	—	—
dangerouslyUseHTMLString	whether message is treated as HTML string	boolean	—	false
type	notification type	string	success/warning/info/error	—
icon	custom icon component. It will be overridden by type	string / Component	—	—
customClass	custom class name for Notification	string	—	—
duration	duration before close. It will not automatically close if set 0	number	—	4500
position	custom position	string	top-right/top-left/bottom-right/bottom-left	top-right
showClose	whether to show a close button	boolean	—	true
onClose	callback function when closed	function	—	—
onClick	callback function when notification clicked	function	—	—
offset	offset from the top edge of the screen. Every Notification instance of the same moment should have the same offset	number	—	0
appendTo	set the root element for the notification	string / HTMLElement	-	document.body
zIndex	initial zIndex	number	-	0

Methods

Notification and this.$notify returns the current Notification instance. To manually close the instance, you can call close on it.

Method	Description
close	close the Notification