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, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import { AnimationConfig, PositionConfig } from 'devextreme/common/core/animation'; import { event } from 'devextreme/events/events.types'; import { EventInfo } from 'devextreme/common/core/events'; import { PositionAlignment } from 'devextreme/common'; import { dxPopupToolbarItem } from 'devextreme/ui/popup'; import DxPopup from 'devextreme/ui/popup'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiPopupToolbarItemComponent } from 'devextreme-angular/ui/popup/nested'; import type * as DxPopupTypes from "devextreme/ui/popup_types"; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/ui/popup/nested"; import * as i3 from "devextreme-angular/core"; /** * The Popup UI component is a pop-up window overlaying the current view. */ export declare class DxPopupComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxPopup; /** * 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; }); /** * 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)); /** * Specifies the container in which to render the UI component. */ get container(): any | string | undefined; set container(value: any | string | undefined); /** * 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); /** * Specifies whether the UI component responds to user interaction. */ get disabled(): boolean; set disabled(value: boolean); /** * Specifies an element with boundaries within which users can drag and resize the Popup. Ignored if the dragOutsideBoundary property is set to true. */ get dragAndResizeArea(): any | string | undefined; set dragAndResizeArea(value: any | string | undefined); /** * Specifies whether or not to allow a user to drag the popup window. */ get dragEnabled(): boolean; set dragEnabled(value: boolean); /** * Allows users to drag the Popup within the browser window or beyond the window's borders. */ get dragOutsideBoundary(): boolean; set dragOutsideBoundary(value: boolean); /** * Specifies whether to enable page scrolling when the UI component is visible. */ get enableBodyScroll(): boolean; set enableBodyScroll(value: boolean); /** * Specifies whether the UI component can be focused using keyboard navigation. */ get focusStateEnabled(): boolean; set focusStateEnabled(value: boolean); /** * Specifies whether to display the Popup in full-screen mode. */ get fullScreen(): boolean; set fullScreen(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); /** * 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(): Function | PositionAlignment | PositionConfig; set position(value: Function | PositionAlignment | PositionConfig); /** * Specifies whether or not an end user can resize the UI component. */ get resizeEnabled(): boolean; set resizeEnabled(value: boolean); /** * Specifies whether to display the widget at the initial position when users reopen it. */ get restorePosition(): boolean; set restorePosition(value: boolean); /** * 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 whether or not the UI component displays the Close button. */ get showCloseButton(): boolean; set showCloseButton(value: boolean); /** * A Boolean value specifying whether or not to display the title in the popup window. */ get showTitle(): boolean; set showTitle(value: boolean); /** * Specifies the number of the element when the Tab key is used for navigating. */ get tabIndex(): number; set tabIndex(value: number); /** * The title in the overlay window. */ get title(): string; set title(value: string); /** * Specifies a custom template for the UI component title. Does not apply if the title is defined. */ get titleTemplate(): any; set titleTemplate(value: any); /** * Configures toolbar items. */ get toolbarItems(): Array<dxPopupToolbarItem>; set toolbarItems(value: Array<dxPopupToolbarItem>); /** * 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<EventInfo<any>>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<EventInfo<any>>; /** * A function that is executed after the UI component is hidden. */ onHidden: EventEmitter<EventInfo<any>>; /** * A function that is executed before the UI component is hidden. */ onHiding: EventEmitter<Object>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<Object>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<Object>; /** * A function that is executed each time the UI component is resized by one pixel. */ onResize: EventEmitter<Object>; /** * A function that is executed when resizing ends. */ onResizeEnd: EventEmitter<Object>; /** * A function that is executed when resizing starts. */ onResizeStart: EventEmitter<Object>; /** * A function that is executed before the UI component is displayed. */ onShowing: EventEmitter<Object>; /** * A function that is executed after the UI component is displayed. */ onShown: EventEmitter<EventInfo<any>>; /** * A function that is executed when the UI component's title is rendered. */ onTitleRendered: EventEmitter<Object>; /** * 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. */ closeOnOutsideClickChange: EventEmitter<boolean | ((event: event) => boolean)>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ containerChange: EventEmitter<any | string | undefined>; /** * 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. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dragAndResizeAreaChange: EventEmitter<any | string | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dragEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dragOutsideBoundaryChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ enableBodyScrollChange: EventEmitter<boolean>; /** * 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. */ fullScreenChange: 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. */ 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<Function | PositionAlignment | PositionConfig>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ resizeEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ restorePositionChange: EventEmitter<boolean>; /** * 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. */ showCloseButtonChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showTitleChange: EventEmitter<boolean>; /** * 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. */ titleChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ titleTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ toolbarItemsChange: EventEmitter<Array<dxPopupToolbarItem>>; /** * 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>; get toolbarItemsChildren(): QueryList<DxiPopupToolbarItemComponent>; set toolbarItemsChildren(value: QueryList<DxiPopupToolbarItemComponent>); constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxPopup<any>; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxPopupComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxPopupComponent, "dx-popup", never, { "accessKey": { "alias": "accessKey"; "required": false; }; "animation": { "alias": "animation"; "required": false; }; "closeOnOutsideClick": { "alias": "closeOnOutsideClick"; "required": false; }; "container": { "alias": "container"; "required": false; }; "contentTemplate": { "alias": "contentTemplate"; "required": false; }; "deferRendering": { "alias": "deferRendering"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "dragAndResizeArea": { "alias": "dragAndResizeArea"; "required": false; }; "dragEnabled": { "alias": "dragEnabled"; "required": false; }; "dragOutsideBoundary": { "alias": "dragOutsideBoundary"; "required": false; }; "enableBodyScroll": { "alias": "enableBodyScroll"; "required": false; }; "focusStateEnabled": { "alias": "focusStateEnabled"; "required": false; }; "fullScreen": { "alias": "fullScreen"; "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; }; "minHeight": { "alias": "minHeight"; "required": false; }; "minWidth": { "alias": "minWidth"; "required": false; }; "position": { "alias": "position"; "required": false; }; "resizeEnabled": { "alias": "resizeEnabled"; "required": false; }; "restorePosition": { "alias": "restorePosition"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "shading": { "alias": "shading"; "required": false; }; "shadingColor": { "alias": "shadingColor"; "required": false; }; "showCloseButton": { "alias": "showCloseButton"; "required": false; }; "showTitle": { "alias": "showTitle"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "title": { "alias": "title"; "required": false; }; "titleTemplate": { "alias": "titleTemplate"; "required": false; }; "toolbarItems": { "alias": "toolbarItems"; "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"; "onResize": "onResize"; "onResizeEnd": "onResizeEnd"; "onResizeStart": "onResizeStart"; "onShowing": "onShowing"; "onShown": "onShown"; "onTitleRendered": "onTitleRendered"; "accessKeyChange": "accessKeyChange"; "animationChange": "animationChange"; "closeOnOutsideClickChange": "closeOnOutsideClickChange"; "containerChange": "containerChange"; "contentTemplateChange": "contentTemplateChange"; "deferRenderingChange": "deferRenderingChange"; "disabledChange": "disabledChange"; "dragAndResizeAreaChange": "dragAndResizeAreaChange"; "dragEnabledChange": "dragEnabledChange"; "dragOutsideBoundaryChange": "dragOutsideBoundaryChange"; "enableBodyScrollChange": "enableBodyScrollChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "fullScreenChange": "fullScreenChange"; "heightChange": "heightChange"; "hideOnOutsideClickChange": "hideOnOutsideClickChange"; "hideOnParentScrollChange": "hideOnParentScrollChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "maxHeightChange": "maxHeightChange"; "maxWidthChange": "maxWidthChange"; "minHeightChange": "minHeightChange"; "minWidthChange": "minWidthChange"; "positionChange": "positionChange"; "resizeEnabledChange": "resizeEnabledChange"; "restorePositionChange": "restorePositionChange"; "rtlEnabledChange": "rtlEnabledChange"; "shadingChange": "shadingChange"; "shadingColorChange": "shadingColorChange"; "showCloseButtonChange": "showCloseButtonChange"; "showTitleChange": "showTitleChange"; "tabIndexChange": "tabIndexChange"; "titleChange": "titleChange"; "titleTemplateChange": "titleTemplateChange"; "toolbarItemsChange": "toolbarItemsChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "wrapperAttrChange": "wrapperAttrChange"; }, ["toolbarItemsChildren"], ["*"], false, never>; } export declare class DxPopupModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxPopupModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxPopupModule, [typeof DxPopupComponent], [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.DxoPopupAnimationModule, typeof i2.DxoPopupAtModule, typeof i2.DxoPopupBoundaryOffsetModule, typeof i2.DxoPopupCollisionModule, typeof i2.DxoPopupFromModule, typeof i2.DxoPopupHideModule, typeof i2.DxoPopupMyModule, typeof i2.DxoPopupOffsetModule, typeof i2.DxoPopupPositionModule, typeof i2.DxoPopupShowModule, typeof i2.DxoPopupToModule, typeof i2.DxiPopupToolbarItemModule, typeof i3.DxIntegrationModule, typeof i3.DxTemplateModule], [typeof DxPopupComponent, 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.DxoPopupAnimationModule, typeof i2.DxoPopupAtModule, typeof i2.DxoPopupBoundaryOffsetModule, typeof i2.DxoPopupCollisionModule, typeof i2.DxoPopupFromModule, typeof i2.DxoPopupHideModule, typeof i2.DxoPopupMyModule, typeof i2.DxoPopupOffsetModule, typeof i2.DxoPopupPositionModule, typeof i2.DxoPopupShowModule, typeof i2.DxoPopupToModule, typeof i2.DxiPopupToolbarItemModule, typeof i3.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxPopupModule>; } export { DxPopupTypes };