JavaScript/jQuery Toast Options

An object defining configuration properties for the Toast UI component.

See Also
jQuery
Angular
Vue
React

accessKey

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

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

animation

Type:

dxToastAnimation

The following code shows default values of the object depending on the device type:

Desktop, iOS
Android
{
    show: {
        type: 'fade',
        duration: 400,
        from: 0,
        to: 1
    },
    hide: {
        type: 'fade',
        duration: 400,
        from: 1,
        to: 0
    }
}
{
    show: {
        type: 'slide',
        duration: 200,
        from: {
            position: {
                my: 'top',
                at: 'bottom',
                of: window
            }
        }
    },
    hide: {
        type: 'slide',
        duration: 200,
        to: {
            position: {
                my: 'top',
                at: 'bottom',
                of: window
            }
        }
    }
}

Set the animation object to null or undefined to disable animations.

closeOnClick

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

Type:

Boolean

Default Value: false

closeOnOutsideClick Deprecated

Use the hideOnOutsideClick property instead.

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

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or EventObject)

The event that caused UI component closing. It is a EventObject or a jQuery.Event when you use jQuery.

Return Value:

Boolean

true if the UI component should be closed; otherwise false.

Default Value: true (Android)

closeOnSwipe

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

Type:

Boolean

Default Value: true

contentTemplate

Specifies a custom template for the UI component content.

Type:

template

Template Data: undefined
Default Name: 'content'

See Also

copyRootClassesToWrapper Deprecated

IMPORTANT
Use the wrapperAttr property instead.

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

Type:

Boolean

Default Value: false

This property allows you to use CSS for wrapper element configuration. You can customize the shade, resize, and drag zones.

The following markup illustrates relations between wrapper and root elements when you set copyRootClassesToWrapper to true:

HTML
<body>

    <!-- The following element is the root element on which the component is initialized. -->
    <!-- Specify classes to be copied to the wrapper element here. -->
    <div id="toast" class="custom-class" ... ></div>

    <!-- The following element is the wrapper element. -->
    <!-- Custom classes are automatically copied from the root element. -->
    <div class="dx-overlay-wrapper dx-popup-wrapper custom-class" ... > 

        <!-- The following element displays text content and an icon. -->
        <div class="dx-toast-content" ... >
            <!-- ... -->
        </div>
    </div>
</body>

deferRendering

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

Type:

Boolean

Default Value: true

Angular

If you set the deferRendering property to true, wrap the content in the Angular named template.

Vue

If you set the deferRendering property to true, wrap the content in the Vue named template.

displayTime

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

Type:

Number

Default Value: 2000, 4000 (Fluent, Material)

elementAttr Deprecated

Use the wrapperAttr property instead.

Specifies the global attributes to be attached to the UI component's container element.

Type: any
Default Value: {}

jQuery
$(function(){
    $("#toastContainer").dxToast({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-toast ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-toast>
import { DxToastModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxToastModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxToast ...
        :element-attr="toastAttributes">
    </DxToast>
</template>

<script>
import DxToast from 'devextreme-vue/toast';

export default {
    components: {
        DxToast
    },
    data() {
        return {
            toastAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import Toast from 'devextreme-react/toast';

class App extends React.Component {
    toastAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Toast ...
                elementAttr={this.toastAttributes}>
            </Toast>
        );
    }
}
export default App;

focusStateEnabled

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

Type:

Boolean

Default Value: false

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: 'auto'

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "20vh", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

The Toast calculates its height relative to one of the elements in the following priority: position.of => window.

hideOnOutsideClick

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

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or EventObject)

The event that caused UI component hiding. It is a EventObject or a jQuery.Event when you use jQuery.

Return Value:

Boolean

true if the UI component should be hidden; otherwise false.

Default Value: true (Android)

The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.

jQuery
JavaScript
$(function () {
    $("#toastContainer").dxToast({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
import { DxToastModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    hideOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxToastModule
     ],
     // ...
 })
<dx-toast ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-toast>
Vue
App.vue
<template>
    <DxToast ....
        :hide-on-outside-click="hideOnOutsideClick">
    </DxToast>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxToast from 'devextreme-vue/toast';

export default {
    components: {
        DxToast
    },
    methods: {
        hideOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>
React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import Toast from 'devextreme-react/toast';

const hideOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <Toast ...
            hideOnOutsideClick={hideOnOutsideClick}>
        </Toast>
    );
}

The hideOnOutsideClick function is called when a user clicks the UI component or outside it.

Popup Demo

hideOnParentScroll

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

Type:

Boolean

Default Value: false

hint

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

Type:

String

Default Value: undefined

hoverStateEnabled

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

Type:

Boolean

Default Value: false

maxHeight

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The maximum height.

Default Value: null

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "20vh", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

maxWidth

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The maximum width.

Default Value: 568 (Fluent, Material)

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "20vw", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

message

The Toast message text.

Type:

String

Default Value: ''

minHeight

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The minimum height.

Default Value: null

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "20vh", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

minWidth

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The minimum width.

Default Value: 344 (Fluent, Material)

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "20vw", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

onContentReady

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

Type:

Function

Function parameters:
e:

ContentReadyEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

DisposingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

onHidden

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

Type:

Function

Function parameters:
e:

HiddenEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

onHiding

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

Type:

Function

Function parameters:
e:

HidingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
cancel

Boolean

Set this field to true if you want the Toast to remain visible.
Default Value: null

onInitialized

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

Type:

Function

Function parameters:
e:

InitializedEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

Angular
app.component.html
app.component.ts
<dx-toast ...
    (onInitialized)="saveInstance($event)">
</dx-toast>
import { Component } from "@angular/core";
import Toast from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    toastInstance: Toast;
    saveInstance (e) {
        this.toastInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxToast ...
            @initialized="saveInstance">
        </DxToast>
    </div>
</template>

<script>
import DxToast from 'devextreme-vue/toast';

export default {
    components: {
        DxToast
    },
    data: function() {
        return {
            toastInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.toastInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxToast ...
            @initialized="saveInstance">
        </DxToast>
    </div>
</template>

<script setup>
import DxToast from 'devextreme-vue/toast';

let toastInstance = null;

const saveInstance = (e) => {
    toastInstance = e.component;
}
</script>
React
App.js
import Toast from 'devextreme-react/toast';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.toastInstance = e.component;
    }

    render() {
        return (
            <div>
                <Toast onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onOptionChanged

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

Type:

Function

Function parameters:
e:

OptionChangedEvent

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.
previousValue any

The UI component's previous value.
name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullName

String

The path to the modified property that includes all parent properties.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#toastContainer").dxToast({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-toast ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-toast>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxToastModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxToastModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }
Vue
App.vue
<template> 
    <DxToast ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxToast from 'devextreme-vue/toast'; 

export default { 
    components: { 
        DxToast
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Toast from 'devextreme-react/toast'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Toast ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onShowing

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

Type:

Function

Function parameters:
e:

ShowingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
cancel

Boolean

Set this field to true if you want to prevent the Toast from being displayed.
Default Value: null

onShown

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

Type:

Function

Function parameters:
e:

ShownEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

Toast

The UI component's instance.
Default Value: null

position

Positions the UI component.

Type:

PositionConfig

|

String

Default Value: 'bottom center', { at: 'bottom center', my: 'bottom center', offset: '0 0' } (phones on Android), { at: 'bottom left', my: 'bottom left', offset: '20 -20'} (Android)
Raised Events: onPositioned

If you set the position.of to a specific element, the shading applies to this element. The Toast calculates its size relative to the element.

rtlEnabled

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

Type:

Boolean

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

shading

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

Type:

Boolean

Default Value: false

Shading applies to the first specified element in the following sequence: container => position.of => window

If this property is set to true, the Toast is displayed in modal mode, and users cannot interact with other UI components.

shadingColor

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

Type:

String

Default Value: ''

This property supports the following colors:

tabIndex

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

Type:

Number

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

type

Specifies the Toast UI component type.

Type:

ToastType

Default Value: 'info'

The available toast types (except for "custom") only differ by the icon and background color.

If you assign "custom" to the type property, the dx-toast-custom class is applied to the UI component element. Implement the appropriate CSS class to specify toast appearance.

visible

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

Type:

Boolean

Default Value: false
Raised Events: onHiding onShowing

You can show and hide the UI component by changing the value of an observable variable passed to this property.

The UI component is automatically hidden after the time specified in the displayTime property.

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: '80vw', '100vw' (phones on Android), 'auto' (Android)

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "20vw", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

The Toast calculates its width relative to one of the elements in the following priority: position.of => window.

wrapperAttr

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

Type: any
Default Value: {}

jQuery
$(function(){
    $("#toastContainer").dxToast({
        // ...
        wrapperAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-toast ...
    [wrapperAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-toast>
import { Component } from '@angular/core';
// ...
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxToastModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxToastModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxToast ...
        :wrapper-attr="toastAttributes">
    </DxToast>
</template>

<script>
import DxToast from 'devextreme-vue/toast';

export default {
    components: {
        DxToast
    },
    data() {
        return {
            toastAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React, { useMemo } from 'react';

import Toast from 'devextreme-react/toast';

function App() {
    const toastAttributes = useMemo(() => {
        return {
            id: 'elementId',
            class: 'class-name'
        }
    }, []);

    return (
        <Toast ...
            wrapperAttr={toastAttributes}>
        </Toast>
    );
}
export default App;

The code above specifies the id and class attributes for the wrapper element and produces markup similar to this:

HTML
<body>
    <!-- The following is the wrapper element. -->
    <!-- It is nested inside an element defined by the `container` property (`<body>` by default). -->
    <div id="elementId" class="dx-overlay-wrapper dx-toast-wrapper class-name" ... > 

        <!-- The following element displays text content and an icon. -->
        <div class="dx-toast-content" ... >
            <!-- ... -->
        </div>
    </div>
</body>
jQuery

You can specify attributes to the component's root element directly in HTML code:

<div id="myToast" class="myClass"></div>
Angular

You can specify attributes to the component's root element directly in HTML code:

<dx-toast ... class="myClass">
</dx-toast>
React

You can specify attributes to the component's root element directly in HTML code:

<Toast ... className="myClass" />
ASP.NET Core Controls

To add an attribute to an ASP.NET Core control, use its OnInitialized method:

@(Html.DevExtreme().Toast()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)
ASP.NET MVC Controls

To add an attribute to an ASP.NET MVC control, use its OnInitialized method:

    @(Html.DevExtreme().Toast()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)