Skip to content

NotificationUI

Description

Methods

createToastElement

Source code

notificationUI.createToastElement(options, closeLabel, animation) ⇒ Object

Builds a toast element from normalized options.

ParamTypeDescription
optionsobjectNormalized notification options (id, variant, title, message, closable, actions).
closeLabelstringTranslated label for the close control.
animationbooleanWhether enter animation is enabled.

destroy

Source code

notificationUI.destroy()

Detaches the host from the DOM and clears internal stack references.

getFocusables

Source code

NotificationUI.getFocusables(toastEl) ⇒ Array<HTMLElement>

ParamTypeDescription
toastElHTMLElementToast root element.

getHost

Source code

notificationUI.getHost() ⇒ HTMLElement | null

getStack

Source code

notificationUI.getStack(position) ⇒ HTMLElement | undefined

ParamTypeDescription
positionstringStack key.

install

Source code

notificationUI.install()

Creates the notification host and four corner stack elements inside the overlays layer (ht-overlay).

setRtl

Source code

notificationUI.setRtl(isRtl)

Updates RTL direction on the host.

ParamTypeDescription
isRtlbooleanWhether the grid uses RTL layout.

setSanitizer

Source code

notificationUI.setSanitizer(sanitizer)

Updates the HTML sanitizer used for string notification messages.

ParamTypeDescription
sanitizerfunctionSanitizer from Handsontable settings, if any.

setSequentialFocusWithinHost

Source code

NotificationUI.setSequentialFocusWithinHost(host, enabled)

Enables or disables sequential keyboard focus for notification controls. When disabled, controls stay out of the tab order so opening a toast does not move focus; screen readers still receive aria-live updates.

ParamTypeDescription
hostHTMLElement
null
Notification plugin host element.
enabledbooleanWhether controls participate in tab navigation.