devextreme-angular

/*! * devextreme-angular * Version: 24.2.6 * Build date: Mon Mar 17 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState, ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core'; import { AnimationConfig, PositionConfig } from 'devextreme/common/core/animation'; import { event } from 'devextreme/events/events.types'; import { ContentReadyEvent, DisposingEvent, HiddenEvent, HidingEvent, InitializedEvent, OptionChangedEvent, ShowingEvent, ShownEvent, ToastType } from 'devextreme/ui/toast'; import DxToast from 'devextreme/ui/toast'; import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core'; import type * as DxToastTypes from "devextreme/ui/toast_types"; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/ui/toast/nested"; import * as i3 from "devextreme-angular/core"; /** * The Toast is a UI component that provides pop-up notifications. */ export declare class DxToastComponent extends DxComponent implements OnDestroy { instance: DxToast; /** * Specifies the shortcut key that sets focus on the UI component. */ get accessKey(): string | undefined; set accessKey(value: string | undefined); /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ get animation(): { hide?: AnimationConfig; show?: AnimationConfig; }; set animation(value: { hide?: AnimationConfig; show?: AnimationConfig; }); /** * A Boolean value specifying whether or not the toast is closed if a user clicks it. */ get closeOnClick(): boolean; set closeOnClick(value: boolean); /** * Specifies whether to close the UI component if a user clicks outside it. * @deprecated Use the hideOnOutsideClick option instead. */ get closeOnOutsideClick(): boolean | ((event: event) => boolean); set closeOnOutsideClick(value: 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. */ get closeOnSwipe(): boolean; set closeOnSwipe(value: boolean); /** * Specifies a custom template for the UI component content. */ get contentTemplate(): any; set contentTemplate(value: any); /** * Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. */ get deferRendering(): boolean; set deferRendering(value: boolean); /** * The time span in milliseconds during which the Toast UI component is visible. */ get displayTime(): number; set displayTime(value: number); /** * Specifies whether the UI component can be focused using keyboard navigation. */ get focusStateEnabled(): boolean; set focusStateEnabled(value: boolean); /** * Specifies the UI component's height. */ get height(): (() => number | string) | number | string; set height(value: (() => number | string) | number | string); /** * Specifies whether to hide the UI component if a user clicks outside it. */ get hideOnOutsideClick(): boolean | ((event: event) => boolean); set hideOnOutsideClick(value: boolean | ((event: event) => boolean)); /** * Specifies whether to hide the widget when users scroll one of its parent elements. */ get hideOnParentScroll(): boolean; set hideOnParentScroll(value: boolean); /** * Specifies text for a hint that appears when a user pauses on the UI component. */ get hint(): string | undefined; set hint(value: string | undefined); /** * Specifies whether the UI component changes its state when a user pauses on it. */ get hoverStateEnabled(): boolean; set hoverStateEnabled(value: boolean); /** * Specifies the maximum height the UI component can reach while resizing. */ get maxHeight(): (() => number | string) | number | string; set maxHeight(value: (() => number | string) | number | string); /** * Specifies the maximum width the UI component can reach while resizing. */ get maxWidth(): (() => number | string) | number | string; set maxWidth(value: (() => number | string) | number | string); /** * The Toast message text. */ get message(): string; set message(value: string); /** * Specifies the minimum height the UI component can reach while resizing. */ get minHeight(): (() => number | string) | number | string; set minHeight(value: (() => number | string) | number | string); /** * Specifies the minimum width the UI component can reach while resizing. */ get minWidth(): (() => number | string) | number | string; set minWidth(value: (() => number | string) | number | string); /** * Positions the UI component. */ get position(): PositionConfig | string; set position(value: PositionConfig | string); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies whether to shade the background when the UI component is active. */ get shading(): boolean; set shading(value: boolean); /** * Specifies the shading color. Applies only if shading is enabled. */ get shadingColor(): string; set shadingColor(value: string); /** * Specifies the number of the element when the Tab key is used for navigating. */ get tabIndex(): number; set tabIndex(value: number); /** * Specifies the Toast UI component type. */ get type(): ToastType; set type(value: ToastType); /** * A Boolean value specifying whether or not the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component's width. */ get width(): (() => number | string) | number | string; set width(value: (() => number | string) | number | string); /** * Specifies the global attributes for the UI component's wrapper element. */ get wrapperAttr(): any; set wrapperAttr(value: any); /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ onContentReady: EventEmitter<ContentReadyEvent>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<DisposingEvent>; /** * A function that is executed after the UI component is hidden. */ onHidden: EventEmitter<HiddenEvent>; /** * A function that is executed before the UI component is hidden. */ onHiding: EventEmitter<HidingEvent>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<InitializedEvent>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<OptionChangedEvent>; /** * A function that is executed before the UI component is displayed. */ onShowing: EventEmitter<ShowingEvent>; /** * A function that is executed after the UI component is displayed. */ onShown: EventEmitter<ShownEvent>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ animationChange: EventEmitter<{ hide?: AnimationConfig; show?: AnimationConfig; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ closeOnClickChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ closeOnOutsideClickChange: EventEmitter<boolean | ((event: event) => boolean)>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ closeOnSwipeChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ contentTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ deferRenderingChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ displayTimeChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hideOnOutsideClickChange: EventEmitter<boolean | ((event: event) => boolean)>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hideOnParentScrollChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ maxHeightChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ maxWidthChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ messageChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ minHeightChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ minWidthChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ positionChange: EventEmitter<PositionConfig | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ shadingChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ shadingColorChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ typeChange: EventEmitter<ToastType>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<(() => number | string) | number | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ wrapperAttrChange: EventEmitter<any>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxToast; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxToastComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxToastComponent, "dx-toast", never, { "accessKey": { "alias": "accessKey"; "required": false; }; "animation": { "alias": "animation"; "required": false; }; "closeOnClick": { "alias": "closeOnClick"; "required": false; }; "closeOnOutsideClick": { "alias": "closeOnOutsideClick"; "required": false; }; "closeOnSwipe": { "alias": "closeOnSwipe"; "required": false; }; "contentTemplate": { "alias": "contentTemplate"; "required": false; }; "deferRendering": { "alias": "deferRendering"; "required": false; }; "displayTime": { "alias": "displayTime"; "required": false; }; "focusStateEnabled": { "alias": "focusStateEnabled"; "required": false; }; "height": { "alias": "height"; "required": false; }; "hideOnOutsideClick": { "alias": "hideOnOutsideClick"; "required": false; }; "hideOnParentScroll": { "alias": "hideOnParentScroll"; "required": false; }; "hint": { "alias": "hint"; "required": false; }; "hoverStateEnabled": { "alias": "hoverStateEnabled"; "required": false; }; "maxHeight": { "alias": "maxHeight"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "message": { "alias": "message"; "required": false; }; "minHeight": { "alias": "minHeight"; "required": false; }; "minWidth": { "alias": "minWidth"; "required": false; }; "position": { "alias": "position"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "shading": { "alias": "shading"; "required": false; }; "shadingColor": { "alias": "shadingColor"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "type": { "alias": "type"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "width": { "alias": "width"; "required": false; }; "wrapperAttr": { "alias": "wrapperAttr"; "required": false; }; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onHidden": "onHidden"; "onHiding": "onHiding"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onShowing": "onShowing"; "onShown": "onShown"; "accessKeyChange": "accessKeyChange"; "animationChange": "animationChange"; "closeOnClickChange": "closeOnClickChange"; "closeOnOutsideClickChange": "closeOnOutsideClickChange"; "closeOnSwipeChange": "closeOnSwipeChange"; "contentTemplateChange": "contentTemplateChange"; "deferRenderingChange": "deferRenderingChange"; "displayTimeChange": "displayTimeChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hideOnOutsideClickChange": "hideOnOutsideClickChange"; "hideOnParentScrollChange": "hideOnParentScrollChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "maxHeightChange": "maxHeightChange"; "maxWidthChange": "maxWidthChange"; "messageChange": "messageChange"; "minHeightChange": "minHeightChange"; "minWidthChange": "minWidthChange"; "positionChange": "positionChange"; "rtlEnabledChange": "rtlEnabledChange"; "shadingChange": "shadingChange"; "shadingColorChange": "shadingColorChange"; "tabIndexChange": "tabIndexChange"; "typeChange": "typeChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "wrapperAttrChange": "wrapperAttrChange"; }, never, never, false, never>; } export declare class DxToastModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxToastModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxToastModule, [typeof DxToastComponent], [typeof i1.DxoAnimationModule, typeof i1.DxoHideModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i1.DxoShowModule, typeof i2.DxoToastAnimationModule, typeof i2.DxoToastAtModule, typeof i2.DxoToastBoundaryOffsetModule, typeof i2.DxoToastCollisionModule, typeof i2.DxoToastFromModule, typeof i2.DxoToastHideModule, typeof i2.DxoToastMyModule, typeof i2.DxoToastOffsetModule, typeof i2.DxoToastPositionModule, typeof i2.DxoToastShowModule, typeof i2.DxoToastToModule, typeof i3.DxIntegrationModule, typeof i3.DxTemplateModule], [typeof DxToastComponent, typeof i1.DxoAnimationModule, typeof i1.DxoHideModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i1.DxoShowModule, typeof i2.DxoToastAnimationModule, typeof i2.DxoToastAtModule, typeof i2.DxoToastBoundaryOffsetModule, typeof i2.DxoToastCollisionModule, typeof i2.DxoToastFromModule, typeof i2.DxoToastHideModule, typeof i2.DxoToastMyModule, typeof i2.DxoToastOffsetModule, typeof i2.DxoToastPositionModule, typeof i2.DxoToastShowModule, typeof i2.DxoToastToModule, typeof i3.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxToastModule>; } export { DxToastTypes };