Web Notifications (Toastr)
Last updated
Was this helpful?
Last updated
Was this helpful?
(part of package '')
You can access it in code via: plugins.webnotificationsToastr
Removes current toasts using animation
Removes the toast with the given ID
Parameters:
{} toastrId The unique identifier of the toast notification to be removed.
Returns new, empty toastrOptions
Shows an error toastr with the given message, optional title and options
Example:
Parameters:
Shows an info toastr with the given message, optional title and options
Example:
Parameters:
Sets the given options globally
Parameters:
Shows a success toastr with the given message, optional title and options
Example:
Parameters:
Shows a warning toastr with the given message, optional title and options
Example:
Parameters:
Options to configure the appearance and behavior of toastr notifications. scripting type: CustomType<webnotificationsToastr.toastrOptions>
actionButton
If true will show a custom toastr with an additional action
Default Value: "false"
actionButtonText
When the actionButton is true, set the text to show for the action section; can be an html string
closeButton
If true, a close button is displayed on the toast.
closeHtml
The HTML for the close button.
disableTimeOut
If true, disables the auto-hide timeout.
enableHtml
If true, allows HTML content in the toast message.
extendedTimeOut
The time in milliseconds for extended timeout on hover.
hideDuration
The duration in milliseconds for the hide animation.
hideEasing
The easing function to use when hiding the toast.
hideMethod
The method used to hide the toast (deprecated for old jQuery implementations).
messageClass
CSS class applied to the toast message.
newestOnTop
If true, newer toasts appear on top of older ones.
onActivateTick
If true, activates a tick animation when the toast is activated.
positionClass
CSS class that determines the position of the toast notification.
progressAnimation
The type of animation used for the progress bar.
progressBar
If true, displays a progress bar within the toast.
showDuration
The duration in milliseconds for the show animation.
showEasing
The easing function to use when showing the toast.
showMethod
The method used to show the toast (deprecated for old jQuery implementations).
tapToDismiss
If true, clicking on the toast will dismiss it.
timeOut
The time in milliseconds before the toast auto-hides.
titleClass
CSS class applied to the toast title.
toastClass
CSS class applied to the toast container.
Returns: A new, empty toastrOptions object for configuring toast notifications.
{} message The message to show
{} [title] The optional title shown above the message
{} [options] The toastrOptions object with additional options
{} [toastrId] The optional id that can be used to clear this specific toastr via clearToastr
{} [onClick] The optional callback function when the toastr is clicked
{} message The message to show
{} [title] The optional title shown above the message
{} [options] ToastrOptions object with additional options
{} [toastrId] Optional id that can be used to clear this specific toastr via clearToastr
{} [onClick] Optional callback function when the toastr is clicked
{} options ToastrOptions
{} message The message to show
{} [title] The optional title shown above the message
{} [options] ToastrOptions object with additional options
{} [toastrId] The optional id that can be used to clear this specific toastr via clearToastr
{} [onClick] The optional callback function when the toastr is clicked
{} message The message to show
{} [title] The optional title shown above the message
{} [options] The toastrOptions object with additional options
{} [toastrId] The optional id that can be used to clear this specific toastr via clearToastr
{} [onClick] The optional callback function when the toastr is clicked
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type:
Type: