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 { event } from 'devextreme/events/events.types'; import { DisposingEvent, InitializedEvent, OptionChangedEvent, OpenedStateMode, PanelLocation, RevealMode } from 'devextreme/ui/drawer'; import DxDrawer from 'devextreme/ui/drawer'; import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core'; import type * as DxDrawerTypes from "devextreme/ui/drawer_types"; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/core"; /** * The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts. */ export declare class DxDrawerComponent extends DxComponent implements OnDestroy { instance: DxDrawer; /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ get activeStateEnabled(): boolean; set activeStateEnabled(value: boolean); /** * Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true. */ get animationDuration(): number; set animationDuration(value: number); /** * Specifies whether to use an opening and closing animation. */ get animationEnabled(): boolean; set animationEnabled(value: boolean); /** * Specifies whether to close the drawer if a user clicks or taps the view area. */ get closeOnOutsideClick(): boolean | ((event: event) => boolean); set closeOnOutsideClick(value: boolean | ((event: event) => boolean)); /** * Specifies whether the UI component responds to user interaction. */ get disabled(): boolean; set disabled(value: boolean); /** * Specifies the global attributes to be attached to the UI component's container element. */ get elementAttr(): Record<string, any>; set elementAttr(value: Record<string, any>); /** * Specifies the UI component's height. */ get height(): (() => number | string) | number | string | undefined; set height(value: (() => number | string) | number | string | undefined); /** * 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 drawer's width or height (depending on the drawer's position) in the opened state. */ get maxSize(): number; set maxSize(value: number); /** * Specifies the drawer's width or height (depending on the drawer's position) in the closed state. */ get minSize(): number; set minSize(value: number); /** * Specifies whether the drawer is opened. */ get opened(): boolean; set opened(value: boolean); /** * Specifies how the drawer interacts with the view in the opened state. */ get openedStateMode(): OpenedStateMode; set openedStateMode(value: OpenedStateMode); /** * Specifies the drawer's position in relation to the view. */ get position(): PanelLocation; set position(value: PanelLocation); /** * Specifies the drawer's reveal mode. */ get revealMode(): RevealMode; set revealMode(value: RevealMode); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies whether to shade the view when the drawer is opened. */ get shading(): boolean; set shading(value: boolean); /** * Specifies the drawer's content. */ get template(): any; set template(value: any); /** * Specifies whether the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component's width. */ get width(): (() => number | string) | number | string | undefined; set width(value: (() => number | string) | number | string | undefined); /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<DisposingEvent>; /** * 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>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ animationDurationChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ animationEnabledChange: 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. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<Record<string, any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<(() => number | string) | number | string | undefined>; /** * 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. */ maxSizeChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ minSizeChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ openedChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ openedStateModeChange: EventEmitter<OpenedStateMode>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ positionChange: EventEmitter<PanelLocation>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ revealModeChange: EventEmitter<RevealMode>; /** * 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. */ templateChange: EventEmitter<any>; /** * 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 | undefined>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxDrawer; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxDrawerComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxDrawerComponent, "dx-drawer", never, { "activeStateEnabled": { "alias": "activeStateEnabled"; "required": false; }; "animationDuration": { "alias": "animationDuration"; "required": false; }; "animationEnabled": { "alias": "animationEnabled"; "required": false; }; "closeOnOutsideClick": { "alias": "closeOnOutsideClick"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "elementAttr": { "alias": "elementAttr"; "required": false; }; "height": { "alias": "height"; "required": false; }; "hint": { "alias": "hint"; "required": false; }; "hoverStateEnabled": { "alias": "hoverStateEnabled"; "required": false; }; "maxSize": { "alias": "maxSize"; "required": false; }; "minSize": { "alias": "minSize"; "required": false; }; "opened": { "alias": "opened"; "required": false; }; "openedStateMode": { "alias": "openedStateMode"; "required": false; }; "position": { "alias": "position"; "required": false; }; "revealMode": { "alias": "revealMode"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "shading": { "alias": "shading"; "required": false; }; "template": { "alias": "template"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, { "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "activeStateEnabledChange": "activeStateEnabledChange"; "animationDurationChange": "animationDurationChange"; "animationEnabledChange": "animationEnabledChange"; "closeOnOutsideClickChange": "closeOnOutsideClickChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "maxSizeChange": "maxSizeChange"; "minSizeChange": "minSizeChange"; "openedChange": "openedChange"; "openedStateModeChange": "openedStateModeChange"; "positionChange": "positionChange"; "revealModeChange": "revealModeChange"; "rtlEnabledChange": "rtlEnabledChange"; "shadingChange": "shadingChange"; "templateChange": "templateChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, never, ["*"], false, never>; } export declare class DxDrawerModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxDrawerModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxDrawerModule, [typeof DxDrawerComponent], [typeof i1.DxIntegrationModule, typeof i1.DxTemplateModule], [typeof DxDrawerComponent, typeof i1.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxDrawerModule>; } export { DxDrawerTypes };