action-sheet.d.ts 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  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, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxActionSheet from 'devextreme/ui/action_sheet';
  17. import { DxComponent } from '../core/component';
  18. import { DxTemplateHost } from '../core/template-host';
  19. import { NestedOptionHost } from '../core/nested-option';
  20. import { WatcherHelper } from '../core/watcher-helper';
  21. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  22. import { DxiItemComponent } from './nested/item-dxi';
  23. /**
  24. * The ActionSheet widget is a sheet containing a set of buttons located one under the other. These buttons usually represent several choices relating to a single task.
  25. */
  26. export declare class DxActionSheetComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxActionSheet;
  30. /**
  31. * The text displayed in the button that closes the action sheet.
  32. */
  33. cancelText: string;
  34. /**
  35. * Binds the widget to data.
  36. */
  37. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>;
  38. /**
  39. * Specifies whether the widget responds to user interaction.
  40. */
  41. disabled: boolean;
  42. /**
  43. * Specifies the attributes to be attached to the widget's root element.
  44. */
  45. elementAttr: any;
  46. /**
  47. * Specifies the widget's height.
  48. */
  49. height: number | Function | string;
  50. /**
  51. * Specifies text for a hint that appears when a user pauses on the widget.
  52. */
  53. hint: string;
  54. /**
  55. * Specifies whether the widget changes its state when a user pauses on it.
  56. */
  57. hoverStateEnabled: boolean;
  58. /**
  59. * The time period in milliseconds before the onItemHold event is raised.
  60. */
  61. itemHoldTimeout: number;
  62. /**
  63. * An array of items displayed by the widget.
  64. */
  65. items: Array<string | any | {
  66. disabled?: boolean;
  67. icon?: string;
  68. onClick?: Function | string;
  69. template?: any;
  70. text?: string;
  71. type?: string;
  72. }>;
  73. /**
  74. * Specifies a custom template for items.
  75. */
  76. itemTemplate: any;
  77. /**
  78. * Switches the widget to a right-to-left representation.
  79. */
  80. rtlEnabled: boolean;
  81. /**
  82. * Specifies whether or not to display the Cancel button in action sheet.
  83. */
  84. showCancelButton: boolean;
  85. /**
  86. * A Boolean value specifying whether or not the title of the action sheet is visible.
  87. */
  88. showTitle: boolean;
  89. /**
  90. * Specifies the element the action sheet popover points at. Applies only if usePopover is true.
  91. */
  92. target: Element | JQuery;
  93. /**
  94. * The title of the action sheet.
  95. */
  96. title: string;
  97. /**
  98. * Specifies whether or not to show the action sheet within a Popover widget.
  99. */
  100. usePopover: boolean;
  101. /**
  102. * A Boolean value specifying whether or not the ActionSheet 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 when the Cancel button is clicked or tapped.
  111. */
  112. onCancelClick: EventEmitter<any>;
  113. /**
  114. * A function that is executed when the widget's content is ready and each time the content is changed.
  115. */
  116. onContentReady: EventEmitter<any>;
  117. /**
  118. * A function that is executed before the widget is disposed of.
  119. */
  120. onDisposing: EventEmitter<any>;
  121. /**
  122. * A function used in JavaScript frameworks to save the widget instance.
  123. */
  124. onInitialized: EventEmitter<any>;
  125. /**
  126. * A function that is executed when a collection item is clicked or tapped.
  127. */
  128. onItemClick: EventEmitter<any>;
  129. /**
  130. * A function that is executed when a collection item is right-clicked or pressed.
  131. */
  132. onItemContextMenu: EventEmitter<any>;
  133. /**
  134. * A function that is executed when a collection item has been held for a specified period.
  135. */
  136. onItemHold: EventEmitter<any>;
  137. /**
  138. * A function that is executed after a collection item is rendered.
  139. */
  140. onItemRendered: EventEmitter<any>;
  141. /**
  142. * A function that is executed after a widget option is changed.
  143. */
  144. onOptionChanged: EventEmitter<any>;
  145. /**
  146. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  147. */
  148. cancelTextChange: EventEmitter<string>;
  149. /**
  150. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  151. */
  152. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>>;
  153. /**
  154. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  155. */
  156. disabledChange: EventEmitter<boolean>;
  157. /**
  158. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  159. */
  160. elementAttrChange: EventEmitter<any>;
  161. /**
  162. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  163. */
  164. heightChange: EventEmitter<number | Function | string>;
  165. /**
  166. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  167. */
  168. hintChange: EventEmitter<string>;
  169. /**
  170. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  171. */
  172. hoverStateEnabledChange: EventEmitter<boolean>;
  173. /**
  174. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  175. */
  176. itemHoldTimeoutChange: EventEmitter<number>;
  177. /**
  178. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  179. */
  180. itemsChange: EventEmitter<Array<string | any | {
  181. disabled?: boolean;
  182. icon?: string;
  183. onClick?: Function | string;
  184. template?: any;
  185. text?: string;
  186. type?: string;
  187. }>>;
  188. /**
  189. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  190. */
  191. itemTemplateChange: EventEmitter<any>;
  192. /**
  193. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  194. */
  195. rtlEnabledChange: EventEmitter<boolean>;
  196. /**
  197. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  198. */
  199. showCancelButtonChange: EventEmitter<boolean>;
  200. /**
  201. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  202. */
  203. showTitleChange: EventEmitter<boolean>;
  204. /**
  205. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  206. */
  207. targetChange: EventEmitter<Element | JQuery>;
  208. /**
  209. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  210. */
  211. titleChange: EventEmitter<string>;
  212. /**
  213. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  214. */
  215. usePopoverChange: EventEmitter<boolean>;
  216. /**
  217. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  218. */
  219. visibleChange: EventEmitter<boolean>;
  220. /**
  221. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  222. */
  223. widthChange: EventEmitter<number | Function | string>;
  224. itemsChildren: QueryList<DxiItemComponent>;
  225. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  226. protected _createInstance(element: any, options: any): DxActionSheet;
  227. ngOnDestroy(): void;
  228. ngOnChanges(changes: SimpleChanges): void;
  229. setupChanges(prop: string, changes: SimpleChanges): void;
  230. ngDoCheck(): void;
  231. _setOption(name: string, value: any): void;
  232. }
  233. export declare class DxActionSheetModule {
  234. }