UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

283 lines (208 loc) • 8.5 kB
/*! * devextreme-angular * Version: 20.2.5 * Build date: Fri Jan 15 2021 * * Copyright (c) 2012 - 2021 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 } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core'; import DxDrawer from 'devextreme/ui/drawer'; import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } 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 or not the UI component changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true. */ animationDuration: number; /** * Specifies whether to use an opening and closing animation. */ animationEnabled: boolean; /** * Specifies whether to close the drawer if a user clicks or taps the view area. */ closeOnOutsideClick: boolean | Function; /** * Specifies whether the UI component responds to user interaction. */ disabled: boolean; /** * Specifies the global attributes to be attached to the UI component's container element. */ elementAttr: any; /** * Specifies the UI component's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint: string; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Specifies the drawer's width or height (depending on the drawer's position) in the opened state. */ maxSize: number; /** * Specifies the drawer's width or height (depending on the drawer's position) in the closed state. */ minSize: number; /** * Specifies whether the drawer is opened. */ opened: boolean; /** * Specifies how the drawer interacts with the view in the opened state. */ openedStateMode: string; /** * Specifies the drawer's position in relation to the view. */ position: string; /** * Specifies the drawer's reveal mode. */ revealMode: string; /** * Switches the UI component to a right-to-left representation. */ rtlEnabled: boolean; /** * Specifies whether to shade the view when the drawer is opened. */ shading: boolean; /** * Specifies a CSS selector for the element in which the drawer should be rendered. Applies only when the openedStateMode is 'overlap'. * @deprecated */ target: Element | JQuery | string; /** * Specifies the drawer's content. */ template: any; /** * Specifies whether the UI component is visible. */ visible: boolean; /** * Specifies the UI component's width. */ width: number | Function | string; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * 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 | Function>; /** * 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<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string>; /** * 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<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ positionChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ revealModeChange: EventEmitter<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. */ targetChange: EventEmitter<Element | JQuery | string>; /** * 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 | Function | string>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxDrawer; ngOnDestroy(): void; } export declare class DxDrawerModule { }