Vue Toast API

The Toast is a UI component that provides pop-up notifications.

import DxToast from "devextreme-vue/toast"
Selector: DxToast

View Demo Read Guides

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Props

An object defining configuration properties for the Toast UI component.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
animation

closeOnClick

A Boolean value specifying whether or not the toast is closed if a user clicks 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 property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender

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

Specifies a custom template for the UI component content.
copyRootClassesToWrapper

Copies your custom CSS classes from the root element to the wrapper element.
deferRendering

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

The time span in milliseconds during which the Toast UI component is visible.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
height

Specifies the UI component's height.
hideOnOutsideClick

Specifies whether to hide the UI component if a user clicks outside it.
hideOnParentScroll

Specifies whether to hide the Toast when users scroll one of its parent elements.
hint

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

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

Specifies the maximum height the UI component can reach while resizing.
maxWidth

Specifies the maximum width the UI component can reach while resizing.
message

The Toast message text.
minHeight

Specifies the minimum height the UI component can reach while resizing.
minWidth

Specifies the minimum width the UI component can reach while resizing.
onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.
onDisposing

A function that is executed before the UI component is disposed of.
onHidden

A function that is executed after the UI component is hidden.
onHiding

A function that is executed before the UI component is hidden.
onInitialized

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

A function that is executed after a UI component property is changed.
onShowing

A function that is executed before the UI component is displayed.
onShown

A function that is executed after the UI component is displayed.
position

Positions the UI component.
rtlEnabled

Switches the UI component to a right-to-left representation.
shading

Specifies whether to shade the background when the UI component is active.
shadingColor

Specifies the shading color. Applies only if shading is enabled.
tabIndex

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

Specifies the Toast UI component type.
visible

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

Specifies the UI component's width.
wrapperAttr

Specifies the global attributes for the UI component's wrapper element.

See Also
jQuery
Angular
Vue
React

Methods

This section describes members used to manipulate the UI component.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
content()

Gets the UI component's content.
defaultOptions(rule)

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

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

Gets the root UI component element.
endUpdate()

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

Sets focus on the UI component.
getInstance(element)

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

Hides the UI component.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)

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

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

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

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

Recalculates the UI component's size and position without rerendering.
resetOption(optionName)

Resets a property to its default value.
show()

Shows the UI component.
toggle(showing)

Shows or hides the UI component depending on the argument.

Events

This section describes events fired by this UI component.

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
hidden

Raised after the UI component is hidden.
hiding

Raised before the UI component is hidden.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.
showing

Raised before the UI component is displayed.
shown

Raised after the UI component is displayed.

See Also
jQuery
Angular
Vue
React

Types

Name Description
ContentReadyEvent

The type of the contentReady event handler's argument.
DisposingEvent

The type of the disposing event handler's argument.
dxOverlayAnimation

Configures UI component visibility animations. This object contains two fields: show and hide.
dxToastAnimation

HiddenEvent

The type of the hidden event handler's argument.
HidingEvent

The type of the hiding event handler's argument.
InitializedEvent

The type of the initialized event handler's argument.
OptionChangedEvent

The type of the optionChanged event handler's argument.
ShowingEvent

The type of the showing event handler's argument.
ShownEvent

The type of the shown event handler's argument.
ToastType

Specifies the Toast UI component type.