beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
Options to be applied. |
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, { Properties } from "devextreme/ui/toast";
// ...
export class AppComponent {
constructor () {
Toast.defaultOptions<Properties>({
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 dxToast from "devextreme/ui/toast";
import Toast from "devextreme-react/toast";
dxToast.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Toast properties
}
});
export default function App() {
return (
<div>
<Toast id="toast1" />
<Toast id="toast2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxToast.defaultOptions({
device: deviceConfig,
options: {
// Here go the Toast properties
}
});
});Angular
import Toast, { Properties } from "devextreme/ui/toast";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Toast.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the Toast properties
}
});
});
}
}Vue
<template>
<div>
<DxToast />
</div>
</template>
<script>
import DxToast from "devextreme-vue/toast";
import Toast from "devextreme/ui/toast";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Toast.defaultOptions({
device: deviceConfig,
options: {
// Here go the Toast properties
}
});
});
export default {
components: {
DxToast
}
}
</script>React
import dxToast from "devextreme/ui/toast";
import Toast from "devextreme-react/toast";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxToast.defaultOptions({
device: deviceConfig,
options: {
// Here go the Toast properties
}
});
});
export default function App() {
return (
<div>
<Toast />
</div>
)
}dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myToast").dxToast("dispose");
$("#myToast").remove();Angular
Use conditional rendering instead of this method:
<dx-toast ...
*ngIf="condition">
</dx-toast>Vue
Use conditional rendering instead of this method:
<template>
<DxToast ...
v-if="condition">
</DxToast>
</template>
<script>
import DxToast from 'devextreme-vue/toast';
export default {
components: {
DxToast
}
}
</script>React
Use conditional rendering instead of this method:
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;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getInstance(element)
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()
A Promise that is resolved after the UI component is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
registerKeyHandler(key, handler)
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
show()
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
The UI component is automatically hidden after the time specified in the displayTime property.
See Also
toggle(showing)
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.