button-group.d.ts 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  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 DxButtonGroup from 'devextreme/ui/button_group';
  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 ButtonGroup is a widget that contains a set of toggle buttons and can be used as a mode switcher.
  25. */
  26. export declare class DxButtonGroupComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxButtonGroup;
  30. /**
  31. * Specifies the shortcut key that sets focus on the widget.
  32. */
  33. accessKey: string;
  34. /**
  35. * Specifies whether or not the widget changes its state when interacting with a user.
  36. */
  37. activeStateEnabled: boolean;
  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 whether the widget can be focused using keyboard navigation.
  48. */
  49. focusStateEnabled: boolean;
  50. /**
  51. * Specifies the widget's height.
  52. */
  53. height: number | Function | string;
  54. /**
  55. * Specifies text for a hint that appears when a user pauses on the widget.
  56. */
  57. hint: string;
  58. /**
  59. * Specifies whether the widget changes its state when a user pauses on it.
  60. */
  61. hoverStateEnabled: boolean;
  62. /**
  63. * Configures buttons in the group.
  64. */
  65. items: Array<DevExpress.ui.dxButtonGroupItem>;
  66. /**
  67. * Specifies a custom button template.
  68. */
  69. itemTemplate: any;
  70. /**
  71. * Specifies which data field provides keys used to distinguish between the selected buttons.
  72. */
  73. keyExpr: Function | string;
  74. /**
  75. * Switches the widget to a right-to-left representation.
  76. */
  77. rtlEnabled: boolean;
  78. /**
  79. * Contains the keys of the selected buttons and allows selecting buttons initially.
  80. */
  81. selectedItemKeys: Array<any>;
  82. /**
  83. * Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array.
  84. */
  85. selectedItems: Array<any>;
  86. /**
  87. * Specifies whether a single or multiple buttons can be in the selected state simultaneously.
  88. */
  89. selectionMode: string;
  90. /**
  91. * Specifies how buttons in the group are styled.
  92. */
  93. stylingMode: string;
  94. /**
  95. * Specifies the number of the element when the Tab key is used for navigating.
  96. */
  97. tabIndex: number;
  98. /**
  99. * Specifies whether the widget is visible.
  100. */
  101. visible: boolean;
  102. /**
  103. * Specifies the widget's width.
  104. */
  105. width: number | Function | string;
  106. /**
  107. * A function that is executed when the widget's content is ready and each time the content is changed.
  108. */
  109. onContentReady: EventEmitter<any>;
  110. /**
  111. * A function that is executed before the widget is disposed of.
  112. */
  113. onDisposing: EventEmitter<any>;
  114. /**
  115. * A function used in JavaScript frameworks to save the widget instance.
  116. */
  117. onInitialized: EventEmitter<any>;
  118. /**
  119. * A function that is executed when a button is clicked or tapped.
  120. */
  121. onItemClick: EventEmitter<any>;
  122. /**
  123. * A function that is executed after a widget option is changed.
  124. */
  125. onOptionChanged: EventEmitter<any>;
  126. /**
  127. * A function that is executed when a button is selected or selection is canceled.
  128. */
  129. onSelectionChanged: EventEmitter<any>;
  130. /**
  131. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  132. */
  133. accessKeyChange: EventEmitter<string>;
  134. /**
  135. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  136. */
  137. activeStateEnabledChange: EventEmitter<boolean>;
  138. /**
  139. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  140. */
  141. disabledChange: EventEmitter<boolean>;
  142. /**
  143. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  144. */
  145. elementAttrChange: EventEmitter<any>;
  146. /**
  147. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  148. */
  149. focusStateEnabledChange: EventEmitter<boolean>;
  150. /**
  151. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  152. */
  153. heightChange: EventEmitter<number | Function | string>;
  154. /**
  155. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  156. */
  157. hintChange: EventEmitter<string>;
  158. /**
  159. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  160. */
  161. hoverStateEnabledChange: EventEmitter<boolean>;
  162. /**
  163. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  164. */
  165. itemsChange: EventEmitter<Array<DevExpress.ui.dxButtonGroupItem>>;
  166. /**
  167. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  168. */
  169. itemTemplateChange: EventEmitter<any>;
  170. /**
  171. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  172. */
  173. keyExprChange: EventEmitter<Function | string>;
  174. /**
  175. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  176. */
  177. rtlEnabledChange: EventEmitter<boolean>;
  178. /**
  179. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  180. */
  181. selectedItemKeysChange: EventEmitter<Array<any>>;
  182. /**
  183. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  184. */
  185. selectedItemsChange: EventEmitter<Array<any>>;
  186. /**
  187. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  188. */
  189. selectionModeChange: EventEmitter<string>;
  190. /**
  191. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  192. */
  193. stylingModeChange: EventEmitter<string>;
  194. /**
  195. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  196. */
  197. tabIndexChange: EventEmitter<number>;
  198. /**
  199. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  200. */
  201. visibleChange: EventEmitter<boolean>;
  202. /**
  203. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  204. */
  205. widthChange: EventEmitter<number | Function | string>;
  206. itemsChildren: QueryList<DxiItemComponent>;
  207. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  208. protected _createInstance(element: any, options: any): DxButtonGroup;
  209. ngOnDestroy(): void;
  210. ngOnChanges(changes: SimpleChanges): void;
  211. setupChanges(prop: string, changes: SimpleChanges): void;
  212. ngDoCheck(): void;
  213. _setOption(name: string, value: any): void;
  214. }
  215. export declare class DxButtonGroupModule {
  216. }