Notification

Options

notification

Ask AI

Source code

notification.notification : boolean | object

The notification option configures the Notification plugin.

You can set the notification option to one of the following:

Setting	Description
false	Disable the Notification plugin
true	Enable the plugin with default options
An object	Enable the plugin and set stackLimit and animation

notification: Additional options

Option	Type	Default	Description
stackLimit	number	10	Maximum visible toasts per corner. Extra requests are queued.
animation	boolean	true	Fade and slide animation when toasts appear.

Read more:

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: false
Since: 17.1.0
Example

notification: true,

Members

DEFAULT_SETTINGS

Ask AI

Source code

Notification.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Ask AI

Source code

Notification.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Ask AI

Source code

Notification.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

SETTINGS_VALIDATORS

Ask AI

Source code

Notification.SETTINGS_VALIDATORS

Returns an object of validator functions used to type-check each settings property at runtime.

Methods

destroy

Ask AI

Source code

notification.destroy()

Clears queues and toast state, unregisters shortcuts and focus scope, and removes the host from the DOM.

disablePlugin

Ask AI

Source code

notification.disablePlugin()

Hides all toasts, removes shortcuts and listeners, and destroys the UI host.

hideAll() must run before super.disablePlugin() because BasePlugin.disablePlugin() clears this.enabled first, and hideAll() relies on the plugin still being enabled. The superclass call then removes hooks and clears the shared EventManager.

enablePlugin

Ask AI

Source code

notification.enablePlugin()

Installs the notification host, document focusin listener (tab order + prior-focus for click paths), shortcuts (F6 via grid + global shortcut contexts, Escape, Tab, Shift+Tab), and the focus scope.

getQueueSize

Ask AI

Source code

notification.getQueueSize() ⇒ number

Returns how many toasts are waiting in per-position queues.

hide

Ask AI

Source code

notification.hide(id)

Hides a toast by id.

Param	Type	Description
id	string	Toast id returned from Notification#showMessage.

hideAll

Ask AI

Source code

notification.hideAll()

Hides every visible toast and clears all per-position queues.

isEnabled

Ask AI

Source code

notification.isEnabled() ⇒ boolean

Returns whether the notification setting is enabled for this instance.

isVisible

Ask AI

Source code

notification.isVisible([id]) ⇒ boolean

Returns whether a toast is visible, or whether any toast is visible when id is omitted.

Param	Type	Description
[id]	string	optional Toast id.

showMessage

Ask AI

Source code

notification.showMessage(options) ⇒ string

Displays a toast. Returns the toast id, or an empty string when the toast is not shown.

Throws:

• Error When options is invalid or actions are malformed.

Param	Type	Description
options	object	Toast options.
[options.variant]	'info' 'success' 'warning' 'error'	optional Visual variant.
[options.title]	string	optional Optional title.
options.message	string HTMLElement	Main message body.
[options.duration]	number	optional Auto-dismiss delay in ms. 0 keeps the toast until dismissed manually.
[options.position]	'top-start' 'top-end' 'bottom-start' 'bottom-end'	optional Corner stack.
[options.closable]	boolean	optional Whether the close control is shown.
[options.actions]	Array<NotificationActionSpec>	optional Action buttons.

updatePlugin

Ask AI

Source code

notification.updatePlugin([newSettings])

Rebuilds the plugin after settings change when notification options actually change.

Param	Type	Description
[newSettings]	object	optional Settings object passed to updateSettings (partial).