Vue Toast API

The Toast is a widget that provides pop-up notifications.

import DxToast from "devextreme-vue/toast"
Type: DxToastTypes.default

View Demo Read Guides

See Also

Props

An object defining configuration options for the Toast widget.

Name Description
accessKey

Specifies the shortcut key that sets focus on the widget.
animation

Configures widget visibility animations. This object contains two fields: show and hide.
closeOnClick

A Boolean value specifying whether or not the toast is closed if a user clicks it.
closeOnOutsideClick

Specifies whether to close the widget if a user clicks outside it.
closeOnSwipe

A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries.
contentComponent

An alias for the contentTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender

An alias for the contentTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
contentTemplate

Specifies a custom template for the widget content.
deferRendering

Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.
displayTime

The time span in milliseconds during which the Toast widget is visible.
elementAttr

Specifies the attributes to be attached to the widget's root element.
focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.
height

Specifies the widget's height in pixels.
hint

Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.
maxHeight

Specifies the maximum height the widget can reach while resizing.
maxWidth

Specifies the maximum width the widget can reach while resizing.
message

The Toast message text.
minHeight

Specifies the minimum height the widget can reach while resizing.
minWidth

Specifies the minimum width the widget can reach while resizing.
onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing

A function that is executed before the widget is disposed of.
onHidden

A function that is executed after the widget is hidden.
onHiding

A function that is executed before the widget is hidden.
onInitialized

A function used in JavaScript frameworks to save the widget instance.
onOptionChanged

A function that is executed after a widget option is changed.
onShowing

A function that is executed before the widget is displayed.
onShown

A function that is executed after the widget is displayed.
position

Positions the widget.
rtlEnabled

Switches the widget to a right-to-left representation.
shading

Specifies whether to shade the background when the widget is active.
shadingColor

Specifies the shading color.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
type

Specifies the Toast widget type.
visible

A Boolean value specifying whether or not the widget is visible.
width

Specifies the widget's width in pixels.

See Also

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.
content()

Gets the widget's content.
defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.
dispose()

Disposes of all the resources allocated to the Toast instance.
element()

Gets the root widget element.
endUpdate()

Refreshes the widget after a call of the beginUpdate() method.
focus()

Sets focus on the widget.
getInstance(element)

Gets the instance of a widget found using its DOM node.
hide()

Hides the widget.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Recalculates the widget's size and position without rerendering.
show()

Shows the widget.
toggle(showing)

Shows or hides the widget depending on the argument.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.
disposing

Raised before the widget is disposed of.
hidden

Raised after the widget is hidden.
hiding

Raised before the widget is hidden.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.
showing

Raised before the widget is displayed.
shown

Raised after the widget is displayed.

See Also