drawer.d.ts 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core';
  15. import DxDrawer from 'devextreme/ui/drawer';
  16. import { DxComponent } from '../core/component';
  17. import { DxTemplateHost } from '../core/template-host';
  18. import { NestedOptionHost } from '../core/nested-option';
  19. import { WatcherHelper } from '../core/watcher-helper';
  20. /**
  21. * The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts.
  22. */
  23. export declare class DxDrawerComponent extends DxComponent implements OnDestroy {
  24. instance: DxDrawer;
  25. /**
  26. * Specifies whether or not the widget changes its state when interacting with a user.
  27. */
  28. activeStateEnabled: boolean;
  29. /**
  30. * Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true.
  31. */
  32. animationDuration: number;
  33. /**
  34. * Specifies whether to use an opening and closing animation.
  35. */
  36. animationEnabled: boolean;
  37. /**
  38. * Specifies whether to close the drawer if a user clicks or taps the view area.
  39. */
  40. closeOnOutsideClick: boolean | Function;
  41. /**
  42. * Specifies whether the widget responds to user interaction.
  43. */
  44. disabled: boolean;
  45. /**
  46. * Specifies the attributes to be attached to the widget's root element.
  47. */
  48. elementAttr: any;
  49. /**
  50. * Specifies the widget's height.
  51. */
  52. height: number | Function | string;
  53. /**
  54. * Specifies text for a hint that appears when a user pauses on the widget.
  55. */
  56. hint: string;
  57. /**
  58. * Specifies whether the widget changes its state when a user pauses on it.
  59. */
  60. hoverStateEnabled: boolean;
  61. /**
  62. * Specifies the drawer's width or height (depending on the drawer's position) in the opened state.
  63. */
  64. maxSize: number;
  65. /**
  66. * Specifies the drawer's width or height (depending on the drawer's position) in the closed state.
  67. */
  68. minSize: number;
  69. /**
  70. * Specifies whether the drawer is opened.
  71. */
  72. opened: boolean;
  73. /**
  74. * Specifies how the drawer interacts with the view in the opened state.
  75. */
  76. openedStateMode: string;
  77. /**
  78. * Specifies the drawer's position in relation to the view.
  79. */
  80. position: string;
  81. /**
  82. * Specifies the drawer's reveal mode.
  83. */
  84. revealMode: string;
  85. /**
  86. * Switches the widget to a right-to-left representation.
  87. */
  88. rtlEnabled: boolean;
  89. /**
  90. * Specifies whether to shade the view when the drawer is opened.
  91. */
  92. shading: boolean;
  93. /**
  94. * Specifies a CSS selector for the element in which the drawer should be rendered. Applies only when the openedStateMode is "overlap".
  95. */
  96. target: Element | JQuery;
  97. /**
  98. * Specifies the drawer's content.
  99. */
  100. template: any;
  101. /**
  102. * Specifies whether the widget is visible.
  103. */
  104. visible: boolean;
  105. /**
  106. * Specifies the widget's width.
  107. */
  108. width: number | Function | string;
  109. /**
  110. * A function that is executed before the widget is disposed of.
  111. */
  112. onDisposing: EventEmitter<any>;
  113. /**
  114. * A function used in JavaScript frameworks to save the widget instance.
  115. */
  116. onInitialized: EventEmitter<any>;
  117. /**
  118. * A function that is executed after a widget option is changed.
  119. */
  120. onOptionChanged: EventEmitter<any>;
  121. /**
  122. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  123. */
  124. activeStateEnabledChange: EventEmitter<boolean>;
  125. /**
  126. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  127. */
  128. animationDurationChange: EventEmitter<number>;
  129. /**
  130. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  131. */
  132. animationEnabledChange: EventEmitter<boolean>;
  133. /**
  134. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  135. */
  136. closeOnOutsideClickChange: EventEmitter<boolean | Function>;
  137. /**
  138. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  139. */
  140. disabledChange: EventEmitter<boolean>;
  141. /**
  142. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  143. */
  144. elementAttrChange: EventEmitter<any>;
  145. /**
  146. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  147. */
  148. heightChange: EventEmitter<number | Function | string>;
  149. /**
  150. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  151. */
  152. hintChange: EventEmitter<string>;
  153. /**
  154. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  155. */
  156. hoverStateEnabledChange: EventEmitter<boolean>;
  157. /**
  158. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  159. */
  160. maxSizeChange: EventEmitter<number>;
  161. /**
  162. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  163. */
  164. minSizeChange: EventEmitter<number>;
  165. /**
  166. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  167. */
  168. openedChange: EventEmitter<boolean>;
  169. /**
  170. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  171. */
  172. openedStateModeChange: EventEmitter<string>;
  173. /**
  174. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  175. */
  176. positionChange: EventEmitter<string>;
  177. /**
  178. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  179. */
  180. revealModeChange: EventEmitter<string>;
  181. /**
  182. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  183. */
  184. rtlEnabledChange: EventEmitter<boolean>;
  185. /**
  186. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  187. */
  188. shadingChange: EventEmitter<boolean>;
  189. /**
  190. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  191. */
  192. targetChange: EventEmitter<Element | JQuery>;
  193. /**
  194. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  195. */
  196. templateChange: EventEmitter<any>;
  197. /**
  198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  199. */
  200. visibleChange: EventEmitter<boolean>;
  201. /**
  202. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  203. */
  204. widthChange: EventEmitter<number | Function | string>;
  205. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  206. protected _createInstance(element: any, options: any): DxDrawer;
  207. ngOnDestroy(): void;
  208. }
  209. export declare class DxDrawerModule {
  210. }