Module: notification

Functions

dispatch

▸ dispatch(messageOptions): Promise<void>

Parameters

Name	Type
messageOptions	MessageDataType<"notificationDispatch">

Returns

Promise<void>

Defined in

src/channel.ts:462

Type Aliases

notificationDispatch

Ƭ notificationDispatch: Object

Dispatch a notification.

Type declaration

Name	Type	Description
responseType	void	-
message	string	This message will be shown in the notification. HTML syntax can be used but it will be sanitized. Only some basic tags and attributes can be used.
title	string	The title of the notification
growl?	boolean	Create a growl notification. Default is true.
variant?	"success" | "info" | "warning" | "error"	The variant of the notification
appearance?	"system" | "notification"	There are two types of notification styles. Use "system" only for technical application notifications.
actions?	{ label: string ; method?: () => void ; route?: string ; disabled?: boolean }[]	You can add several action buttons to the notification. Each button contains a route (url) which gets opened on a click.

Defined in

src/notification/index.ts:8