JavaScript/jQuery Toast Methods
This section describes members used to manipulate the UI component.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
content()
Gets the UI component's content.
An HTML element or a jQuery element when you use jQuery.
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Toast UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxToast.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Toast properties
}
});Angular
import Toast from "devextreme/ui/toast";
// ...
export class AppComponent {
constructor () {
Toast.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Toast properties
}
});
}
}Vue
<template>
<div>
<DxToast id="toast1" />
<DxToast id="toast2" />
</div>
</template>
<script>
import DxToast from "devextreme-vue/toast";
import Toast from "devextreme/ui/toast";
Toast.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Toast properties
}
});
export default {
components: {
DxToast
}
}
</script>React
import React, {useEffect} from "react";
import dxToast from "devextreme/ui/toast";
import Toast from "devextreme-react/toast";
export default function App() {
useEffect(() => {
dxToast.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Toast properties
}
})
});
return (
<div>
<Toast id="toast1" />
<Toast id="toast2" />
</div>
)
}dispose()
Disposes of all the resources allocated to the Toast instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myToast").dxToast("dispose");
$("#myToast").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-toast ...
*ngIf="condition">
</dx-toast>Vue
<template>
<DxToast ...
v-if="condition">
</DxToast>
</template>
<script>
import DxToast from 'devextreme-vue/toast';
export default {
components: {
DxToast
}
}
</script>React
import React from 'react';
import Toast from 'devextreme-react/toast';
function DxToast(props) {
if (!props.shouldRender) {
return null;
}
return (
<Toast ... >
</Toast>
);
}
class App extends React.Component {
render() {
return (
<DxToast shouldRender="condition" />
);
}
}
export default App;See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Toast instance found in an element with the myToast ID:
// Modular approach
import Toast from "devextreme/ui/toast";
...
let element = document.getElementById("myToast");
let instance = Toast.getInstance(element) as Toast;
// Non-modular approach
let element = document.getElementById("myToast");
let instance = DevExpress.ui.dxToast.getInstance(element);See Also
hide()
Hides the UI component.
A Promise that is resolved after the UI component is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with their new values.
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
resetOption(optionName)
Resets a property to its default value.
A property's name.
show()
Shows the UI component.
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(showing)
Shows or hides the UI component depending on the argument.
Specifies whether to show or hide the UI component.
A Promise that is resolved with true if the UI component is shown or false if it is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
You can use the toggle(showing) method instead of the show() and hide() methods. In this case, pass true or false as the method parameter to show or hide the UI component.
The UI component is automatically hidden after the time specified in the displayTime property.