UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

301 lines (226 loc) 11.6 kB
import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core'; import { UserDefinedElement } from 'devextreme/core/element'; import DxDrawer from 'devextreme/ui/drawer'; import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core'; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/core"; import * as i2 from "@angular/platform-browser"; /** * 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&apos;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 | Function; set closeOnOutsideClick(value: boolean | Function); /** * 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&apos;s container element. */ get elementAttr(): any; set elementAttr(value: any); /** * Specifies the UI component&apos;s height. */ get height(): number | Function | string | undefined; set height(value: number | Function | 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&apos;s width or height (depending on the drawer&apos;s position) in the opened state. */ get maxSize(): number; set maxSize(value: number); /** * Specifies the drawer&apos;s width or height (depending on the drawer&apos;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(): string; set openedStateMode(value: string); /** * Specifies the drawer&apos;s position in relation to the view. */ get position(): string; set position(value: string); /** * Specifies the drawer&apos;s reveal mode. */ get revealMode(): string; set revealMode(value: string); /** * 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 a CSS selector for the element in which the drawer should be rendered. Applies only when the openedStateMode is &apos;overlap&apos;. * @deprecated */ get target(): string | UserDefinedElement; set target(value: string | UserDefinedElement); /** * Specifies the drawer&apos;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&apos;s width. */ get width(): number | Function | string | undefined; set width(value: number | Function | string | undefined); /** * 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 | 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<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<string | UserDefinedElement>; /** * 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 | 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": "activeStateEnabled"; "animationDuration": "animationDuration"; "animationEnabled": "animationEnabled"; "closeOnOutsideClick": "closeOnOutsideClick"; "disabled": "disabled"; "elementAttr": "elementAttr"; "height": "height"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "maxSize": "maxSize"; "minSize": "minSize"; "opened": "opened"; "openedStateMode": "openedStateMode"; "position": "position"; "revealMode": "revealMode"; "rtlEnabled": "rtlEnabled"; "shading": "shading"; "target": "target"; "template": "template"; "visible": "visible"; "width": "width"; }, { "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"; "targetChange": "targetChange"; "templateChange": "templateChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, 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 i2.BrowserTransferStateModule], [typeof DxDrawerComponent, typeof i1.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxDrawerModule>; }