devextreme/ui/toast.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (ui/toast.d.ts)
* Version: 20.1.7
* Build date: Tue Aug 25 2020
*
* Copyright (c) 2012 - 2020 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import {
    animationConfig
} from '../animation/fx';

import {
    positionConfig
} from '../animation/position';

import {
    event
} from '../events/index';

import dxOverlay, {
    dxOverlayAnimation,
    dxOverlayOptions
} from './overlay';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxToastOptions extends dxOverlayOptions<dxToast> {
    /** Configures widget visibility animations. This object contains two fields: show and hide. */
    animation?: dxToastAnimation;
    /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */
    closeOnClick?: boolean;
    /** Specifies whether to close the widget if a user clicks outside it. */
    closeOnOutsideClick?: boolean | ((event: event) => boolean);
    /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */
    closeOnSwipe?: boolean;
    /** The time span in milliseconds during which the Toast widget is visible. */
    displayTime?: number;
    /** Specifies the widget's height in pixels. */
    height?: number | string | (() => number | string);
    /** Specifies the maximum width the widget can reach while resizing. */
    maxWidth?: number | string | (() => number | string);
    /** The Toast message text. */
    message?: string;
    /** Specifies the minimum width the widget can reach while resizing. */
    minWidth?: number | string | (() => number | string);
    /** Positions the widget. */
    position?: positionConfig | string;
    /** Specifies whether to shade the background when the widget is active. */
    shading?: boolean;
    /** Specifies the Toast widget type. */
    type?: 'custom' | 'error' | 'info' | 'success' | 'warning';
    /** Specifies the widget's width in pixels. */
    width?: number | string | (() => number | string);
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxToastAnimation extends dxOverlayAnimation {
    /** An object that defines the animation options used when the widget is being hidden. */
    hide?: animationConfig;
    /** An object that defines the animation options used when the widget is being shown. */
    show?: animationConfig;
}
/** The Toast is a widget that provides pop-up notifications. */
export default class dxToast extends dxOverlay {
    constructor(element: Element, options?: dxToastOptions)
    constructor(element: JQuery, options?: dxToastOptions)
}

declare global {
interface JQuery {
    dxToast(): JQuery;
    dxToast(options: "instance"): dxToast;
    dxToast(options: string): any;
    dxToast(options: string, ...params: any[]): any;
    dxToast(options: dxToastOptions): JQuery;
}
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export type Options = dxToastOptions;

/** @deprecated use Options instead */
/** Warning! This type is used for internal purposes. Do not import it directly. */
export type IOptions = dxToastOptions;