@bryntum/core-react-thin 7.2.4 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +261 -0
  2. package/lib/BryntumBooleanCombo.js +204 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +6 -14
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +8 -15
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +16 -20
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +7 -15
  14. package/lib/BryntumCheckbox.js +1 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +9 -21
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +6 -14
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +9 -20
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +7 -15
  26. package/lib/BryntumColorField.js +1 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +10 -18
  29. package/lib/BryntumCombo.js +1 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +7 -14
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +7 -15
  35. package/lib/BryntumDateField.js +1 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +9 -20
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +10 -18
  41. package/lib/BryntumDateRangeField.js +1 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +7 -15
  44. package/lib/BryntumDateTimeField.js +1 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +9 -20
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +7 -15
  50. package/lib/BryntumDisplayField.js +1 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +7 -15
  53. package/lib/BryntumDurationField.js +1 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +9 -19
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +7 -14
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +7 -14
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +9 -21
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +7 -15
  68. package/lib/BryntumFileField.js +1 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +7 -14
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +7 -15
  74. package/lib/BryntumFilterField.js +1 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +21 -30
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +6 -14
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +6 -14
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +20 -25
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +9 -20
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +7 -15
  92. package/lib/BryntumNumberField.js +1 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +10 -17
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +9 -20
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +7 -15
  101. package/lib/BryntumPasswordField.js +1 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +6 -14
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +7 -15
  107. package/lib/BryntumRadio.js +1 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +9 -21
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +7 -15
  113. package/lib/BryntumSlideToggle.js +1 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +7 -14
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +6 -14
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +9 -20
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +8 -15
  125. package/lib/BryntumTextAreaField.js +2 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +8 -16
  128. package/lib/BryntumTextAreaPickerField.js +1 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +7 -15
  131. package/lib/BryntumTextField.js +1 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +8 -16
  134. package/lib/BryntumTimeField.js +1 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +7 -14
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +10 -17
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +6 -14
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +9 -20
  146. package/lib/BryntumYearPicker.js +2 -5
  147. package/lib/BryntumYearPicker.js.map +1 -1
  148. package/lib/WrapperHelper.js +2 -2
  149. package/lib/WrapperHelper.js.map +1 -1
  150. package/lib/index.d.ts +1 -0
  151. package/lib/index.js +1 -0
  152. package/lib/index.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/BryntumBooleanCombo.tsx +1180 -0
  155. package/src/BryntumButton.tsx +69 -115
  156. package/src/BryntumButtonGroup.tsx +78 -123
  157. package/src/BryntumChatPanel.tsx +139 -169
  158. package/src/BryntumCheckbox.tsx +73 -117
  159. package/src/BryntumCheckboxGroup.tsx +109 -179
  160. package/src/BryntumChipView.tsx +65 -105
  161. package/src/BryntumCodeEditor.tsx +106 -167
  162. package/src/BryntumColorField.tsx +73 -117
  163. package/src/BryntumCombo.tsx +92 -152
  164. package/src/BryntumContainer.tsx +78 -124
  165. package/src/BryntumDateField.tsx +80 -123
  166. package/src/BryntumDatePicker.tsx +119 -193
  167. package/src/BryntumDateRangeField.tsx +79 -126
  168. package/src/BryntumDateTimeField.tsx +73 -117
  169. package/src/BryntumDemoCodeEditor.tsx +106 -167
  170. package/src/BryntumDisplayField.tsx +74 -119
  171. package/src/BryntumDurationField.tsx +80 -125
  172. package/src/BryntumEditor.tsx +90 -140
  173. package/src/BryntumFieldFilterPicker.tsx +80 -128
  174. package/src/BryntumFieldFilterPickerGroup.tsx +82 -132
  175. package/src/BryntumFieldSet.tsx +105 -172
  176. package/src/BryntumFileField.tsx +73 -117
  177. package/src/BryntumFilePicker.tsx +78 -124
  178. package/src/BryntumFilterField.tsx +76 -123
  179. package/src/BryntumHint.tsx +133 -190
  180. package/src/BryntumLabel.tsx +59 -95
  181. package/src/BryntumList.tsx +62 -101
  182. package/src/BryntumMenu.tsx +128 -188
  183. package/src/BryntumMonthPicker.tsx +106 -167
  184. package/src/BryntumNumberField.tsx +77 -121
  185. package/src/BryntumPagingToolbar.tsx +82 -129
  186. package/src/BryntumPanel.tsx +106 -167
  187. package/src/BryntumPasswordField.tsx +73 -117
  188. package/src/BryntumProgressBar.tsx +58 -93
  189. package/src/BryntumRadio.tsx +73 -117
  190. package/src/BryntumRadioGroup.tsx +109 -178
  191. package/src/BryntumSlideToggle.tsx +73 -117
  192. package/src/BryntumSlider.tsx +67 -101
  193. package/src/BryntumSplitter.tsx +61 -99
  194. package/src/BryntumTabPanel.tsx +107 -169
  195. package/src/BryntumTextAreaField.tsx +81 -119
  196. package/src/BryntumTextAreaPickerField.tsx +75 -120
  197. package/src/BryntumTextField.tsx +74 -119
  198. package/src/BryntumTimeField.tsx +79 -120
  199. package/src/BryntumTimePicker.tsx +78 -124
  200. package/src/BryntumToolbar.tsx +82 -129
  201. package/src/BryntumWidget.tsx +59 -95
  202. package/src/BryntumYearPicker.tsx +107 -169
  203. package/src/WrapperHelper.tsx +2 -2
  204. package/src/index.ts +1 -0
@@ -0,0 +1,1180 @@
1
+ /**
2
+ * React wrapper for Bryntum BooleanCombo
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, BooleanCombo, BooleanComboListeners, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, CoreContainerItemConfig, DomConfig, Duration, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, List, ListConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
+
8
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
+
10
+ export type BryntumBooleanComboProps = {
11
+ // Configs
12
+ /**
13
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
14
+ * content will be placed inside this element.
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-adopt)
16
+ */
17
+ adopt? : HTMLElement|string
18
+ /**
19
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-align)
21
+ */
22
+ align? : AlignSpec|string
23
+ /**
24
+ * When this widget is a child of a [Container](https://bryntum.com/products/core/docs/api/Core/widget/Container), it will by default be participating in a
25
+ * flexbox layout. This config allows you to set this widget's
26
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
27
+ */
28
+ alignSelf? : string
29
+ /**
30
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
31
+ * `true` to show a connector arrow pointing to the align target.
32
+ */
33
+ anchor? : boolean
34
+ /**
35
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ */
38
+ appendTo? : HTMLElement|string
39
+ /**
40
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
41
+ * into an element which will be linked using the `aria-describedby` attribute.
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-ariaDescription)
43
+ */
44
+ ariaDescription? : string
45
+ /**
46
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
47
+ * the `aria-label` attribute.
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-ariaLabel)
49
+ */
50
+ ariaLabel? : string
51
+ /**
52
+ * Sets the native `autocomplete` property of the underlying input element. For more information, please refer to
53
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
54
+ */
55
+ autoComplete? : string
56
+ /**
57
+ * Configure as `true` to have the picker expand upon focus enter.
58
+ */
59
+ autoExpand? : boolean
60
+ /**
61
+ * Specify `true` to auto select field contents on focus
62
+ */
63
+ autoSelect? : boolean
64
+ /**
65
+ * Initial text to show in badge.
66
+ */
67
+ badge? : string
68
+ /**
69
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
70
+ * hierarchy when triggered.
71
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-bubbleEvents)
72
+ */
73
+ bubbleEvents? : object
74
+ /**
75
+ * Enable caching of the last retrieved result until the timeout is reached.
76
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-cacheLastResult)
77
+ */
78
+ cacheLastResult? : number|string|Duration|DurationConfig
79
+ /**
80
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
81
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-callOnFunctions)
82
+ */
83
+ callOnFunctions? : boolean
84
+ /**
85
+ * Configure as `true` to force case matching when filtering the dropdown list based upon the typed value.
86
+ */
87
+ caseSensitive? : boolean
88
+ /**
89
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
90
+ * application state is undefined. Code which follows the event handler will *not* be executed.
91
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-catchEventHandlerExceptions)
92
+ */
93
+ catchEventHandlerExceptions? : boolean
94
+ /**
95
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
96
+ * Set to `true` to centre the Widget in browser viewport space.
97
+ */
98
+ centered? : boolean
99
+ /**
100
+ * A config object to configure the [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/ChipView) to display the
101
+ * selected value set when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
102
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-chipView)
103
+ */
104
+ chipView? : ChipViewConfig
105
+ /**
106
+ * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
107
+ * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
108
+ * configures the `clear` [trigger](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers).
109
+ */
110
+ clearable? : boolean|FieldTriggerConfig
111
+ /**
112
+ * `true` to clear value typed to a multiselect combo when picker is collapsed
113
+ */
114
+ clearTextOnPickerHide? : boolean
115
+ /**
116
+ * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
117
+ */
118
+ clearTextOnSelection? : boolean
119
+ /**
120
+ * Set to `true` to clear this field when user empties the input element
121
+ */
122
+ clearWhenInputEmpty? : boolean
123
+ /**
124
+ * Custom CSS classes to add to element.
125
+ * May be specified as a space separated string, or as an object in which property names
126
+ * with truthy values are used as the class names:
127
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-cls)
128
+ */
129
+ cls? : string|object
130
+ /**
131
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
132
+ * `style` block.
133
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-color)
134
+ */
135
+ color? : Color
136
+ /**
137
+ * Programmatic control over which column to start in when used in a grid layout.
138
+ */
139
+ column? : number
140
+ config? : object
141
+ /**
142
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
143
+ * Element, Widget or Rectangle to which this Widget is constrained.
144
+ */
145
+ constrainTo? : HTMLElement|Widget|Rectangle
146
+ /**
147
+ * The configuration for additional items associated to this field. This is typically used to add contextual
148
+ * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
149
+ * these classes for examples of nested fields.
150
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-container)
151
+ */
152
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
153
+ /**
154
+ * The config controls how the value of nested items are handled when a parent container gets or sets its
155
+ * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
156
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-containValues)
157
+ * @param {Core.widget.Field} field Field instance
158
+ * @returns {boolean}
159
+ */
160
+ containValues? : boolean|string|((field: Field) => boolean)
161
+ /**
162
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
163
+ * May be specified as a space separated string, or as an object in which property names
164
+ * with truthy values are used as the class names:
165
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-contentElementCls)
166
+ */
167
+ contentElementCls? : string|object
168
+ /**
169
+ * If configured as `true`, this means that when an unmatched string is typed into the
170
+ * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
171
+ * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-displayField).
172
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-createOnUnmatched)
173
+ * @param {string} name Record name
174
+ * @param {Core.widget.Combo} combo Combo instance
175
+ * @returns {Core.data.Model} New record
176
+ */
177
+ createOnUnmatched? : ((name: string, combo: Combo) => Model)|string|boolean
178
+ /**
179
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
180
+ * field on the expanded record to use for populating this widget's store (if applicable)
181
+ */
182
+ dataField? : string
183
+ /**
184
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
185
+ */
186
+ dataset? : Record<string, string>
187
+ /**
188
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
189
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
190
+ */
191
+ defaultBindProperty? : string
192
+ /**
193
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
194
+ * checks:
195
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-detectCSSCompatibilityIssues)
196
+ */
197
+ detectCSSCompatibilityIssues? : boolean
198
+ /**
199
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
200
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
201
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-disabled)
202
+ */
203
+ disabled? : boolean|'inert'
204
+ /**
205
+ * Field used for item text when populating from store
206
+ */
207
+ displayField? : string
208
+ /**
209
+ * Template function that can be used to customize the displayed value
210
+ * @param {Core.data.Model} record The record to provide a textual value for
211
+ * @param {Core.widget.Combo} combo A reference to this Combo
212
+ * @returns {string,void}
213
+ */
214
+ displayValueRenderer? : (record: Model, combo: Combo) => string|void
215
+ /**
216
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/core/docs/api/Core/widget/Panel)
217
+ * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
218
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
219
+ * body. Such widgets are called "edge strips".
220
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-dock)
221
+ */
222
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
223
+ /**
224
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
225
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
226
+ * property which controls when a drag should start.
227
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-draggable)
228
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
229
+ */
230
+ draggable? : boolean|object
231
+ /**
232
+ * User can edit text in text field (otherwise only pick from attached picker)
233
+ */
234
+ editable? : boolean
235
+ /**
236
+ * An object specifying attributes to assign to the root element of this widget.
237
+ * Set `null` value to attribute to remove it.
238
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-elementAttributes)
239
+ */
240
+ elementAttributes? : Record<string, string|null>
241
+ /**
242
+ * Text to display in the drop down when there are no items in the underlying store.
243
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-emptyText)
244
+ */
245
+ emptyText? : string
246
+ /**
247
+ * A function which creates an array of values for the [filterParamName](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-filterParamName) to pass
248
+ * any filters to the server upon load.
249
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-encodeFilterParams)
250
+ * @param {object[]} filters filters
251
+ * @returns {object[]} array of values
252
+ */
253
+ encodeFilterParams? : (filters: object[]) => object[]
254
+ extraData? : any
255
+ /**
256
+ * If `false`, filtering will be triggered once you exceed [minChars](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-minChars). To filter only when
257
+ * hitting Enter key, set this to `true`;
258
+ */
259
+ filterOnEnter? : boolean
260
+ /**
261
+ * The name of an operator type as implemented in [operator](https://bryntum.com/products/core/docs/api/Core/util/CollectionFilter#config-operator)
262
+ * to use when filtering the dropdown list based upon the typed value.
263
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-filterOperator)
264
+ */
265
+ filterOperator? : CollectionCompareOperator
266
+ /**
267
+ * If the dropdown is to be populated with a filtered query to a remote server, specify the
268
+ * name of the parameter to pass the typed string here. By default, the string is simply sent
269
+ * as the value of the parameter. For special encoding, configure the combo with [encodeFilterParams](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-encodeFilterParams)
270
+ */
271
+ filterParamName? : string
272
+ /**
273
+ * When [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`, you may configure `filterSelected` as
274
+ * `true` to hide items in the dropdown when they are added to the selection.
275
+ * It will appear as if the requested item has "moved" into the field's
276
+ * [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-chipView).
277
+ */
278
+ filterSelected? : boolean
279
+ /**
280
+ * When this widget is a child of a [Container](https://bryntum.com/products/core/docs/api/Core/widget/Container), it will by default be participating in a
281
+ * flexbox layout. This config allows you to set this widget's
282
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
283
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
284
+ * numeric-only values are interpreted as the `flex-grow` value.
285
+ */
286
+ flex? : number|string
287
+ /**
288
+ * Set to `true` to move the widget out of the document flow and position it
289
+ * absolutely in browser viewport space.
290
+ */
291
+ floating? : boolean
292
+ /**
293
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
294
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
295
+ * cases this config is convenient.
296
+ */
297
+ height? : string|number
298
+ /**
299
+ * Configure with true to make widget initially hidden.
300
+ */
301
+ hidden? : boolean
302
+ /**
303
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
304
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-hideAnimation)
305
+ */
306
+ hideAnimation? : boolean|object
307
+ /**
308
+ * By default, the picker is hidden on selection in single select mode, and
309
+ * remains to allow more selections when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
310
+ * Setting this to a `Boolean` value can override that default.
311
+ */
312
+ hidePickerOnSelect? : boolean
313
+ /**
314
+ * Configure as `true` to hide the expand trigger. This is automatically set to `true` if
315
+ * remote filtering is enabled by setting the [filterParamName](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-filterParamName) config.
316
+ */
317
+ hideTrigger? : boolean
318
+ /**
319
+ * Specify `true` to highlight field after external value changes
320
+ */
321
+ highlightExternalChange? : boolean
322
+ /**
323
+ * An optional string to display inside the input field as an overlay. This can be useful for displaying
324
+ * a field's units.
325
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-hint)
326
+ * @param {object} data A data object
327
+ * @param {Core.widget.Field} data.source A reference to the field instance
328
+ * @param {any} data.value The current value of the field
329
+ * @returns {string}
330
+ */
331
+ hint? : string|((data: { source: Field, value: any }) => string)
332
+ /**
333
+ * This config is similar to [hint](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
334
+ * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
335
+ * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
336
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-hintHtml)
337
+ * @param {object} data A data object
338
+ * @param {Core.widget.Field} data.source A reference to the field instance
339
+ * @param {any} data.value The current value of the field
340
+ * @returns {string}
341
+ */
342
+ hintHtml? : string|((data: { source: Field, value: any }) => string)
343
+ /**
344
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
345
+ */
346
+ id? : string
347
+ /**
348
+ * Determines if the widgets read-only state should be controlled by its parent.
349
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-ignoreParentReadOnly)
350
+ */
351
+ ignoreParentReadOnly? : boolean
352
+ /**
353
+ * Set this config to `true` to always display items horizontally along with this field. This assigns an
354
+ * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
355
+ * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
356
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-inline)
357
+ */
358
+ inline? : boolean
359
+ /**
360
+ * Configure this as `true` to render the dropdown list as a permanently visible list
361
+ * in the document flow immediately below the input area instead of as a popup.
362
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-inlinePicker)
363
+ */
364
+ inlinePicker? : boolean
365
+ /**
366
+ * Text alignment for the input field.
367
+ */
368
+ inputAlign? : string
369
+ /**
370
+ * Sets custom attributes of the underlying input element. For more information, please refer to
371
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
372
+ */
373
+ inputAttributes? : Record<string, string>
374
+ /**
375
+ * If you need to use something else than a default `input` element, as the input element, provide the tag
376
+ * name here. Please note that this is used for advanced usage only, for example when using WebComponents
377
+ * (custom elements), and that the configured element must fulfil the same contract as a regular input
378
+ * element.
379
+ */
380
+ inputTag? : string
381
+ /**
382
+ * Sets the `type` attribute of the underlying input element (password, hidden, date, color, etc.).
383
+ */
384
+ inputType? : string
385
+ /**
386
+ * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
387
+ * triggers. If a number is specified, `px` will be used.
388
+ */
389
+ inputWidth? : string|number
390
+ /**
391
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
392
+ */
393
+ insertBefore? : HTMLElement|string
394
+ /**
395
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
396
+ */
397
+ insertFirst? : HTMLElement|string
398
+ /**
399
+ * Rows to display in the dropdown (list items).
400
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-items)
401
+ */
402
+ items? : object[]|string[]|object
403
+ /**
404
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
405
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
406
+ * are the name of the instance method to call when the keystroke is received.
407
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-keyMap)
408
+ */
409
+ keyMap? : Record<string, KeyMapConfig>
410
+ /**
411
+ * The delay in milliseconds to wait after the last keystroke before triggering a change event.
412
+ * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
413
+ * immediate feedback, change will still be triggered on blur).
414
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-keyStrokeChangeDelay)
415
+ */
416
+ keyStrokeChangeDelay? : number
417
+ /**
418
+ * The delay in milliseconds to wait after the last keystroke before filtering the list.
419
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-keyStrokeFilterDelay)
420
+ */
421
+ keyStrokeFilterDelay? : number
422
+ /**
423
+ * Label, prepended to field
424
+ */
425
+ label? : string
426
+ /**
427
+ * CSS class name or class names to add to any configured [label](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Labelable#config-label)
428
+ */
429
+ labelCls? : string|object
430
+ /**
431
+ * Label position, either 'before' the field or 'above' the field
432
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-labelPosition)
433
+ */
434
+ labelPosition? : 'before'|'above'|null
435
+ /**
436
+ * The labels to add either before or after the input field.
437
+ * Each label may have the following properties:
438
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-labels)
439
+ * @property {string} html Label text
440
+ * @property {'start','end'} align Which end of the file the label should go
441
+ */
442
+ labels? : object[]
443
+ /**
444
+ * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
445
+ */
446
+ labelWidth? : string|number
447
+ /**
448
+ * CSS class to add to picker
449
+ */
450
+ listCls? : string
451
+ /**
452
+ * The listener set for this object.
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-listeners)
454
+ */
455
+ listeners? : BooleanComboListeners
456
+ /**
457
+ * Template string used to render the list items in the dropdown list
458
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-listItemTpl)
459
+ * @param {Core.data.Model} record The record representing the item being rendered
460
+ * @returns {string,void}
461
+ */
462
+ listItemTpl? : (record: Model) => string|void
463
+ /**
464
+ * A class translations of which are used for translating this entity.
465
+ * This is often used when translations of an item are defined on its container class.
466
+ * For example:
467
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-localeClass)
468
+ */
469
+ localeClass? : typeof Base
470
+ /**
471
+ * Set to `false` to disable localization of this object.
472
+ */
473
+ localizable? : boolean
474
+ /**
475
+ * List of properties which values should be translated automatically upon a locale applying.
476
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
477
+ * you could use 'localeKey' meta configuration.
478
+ * Example:
479
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-localizableProperties)
480
+ */
481
+ localizableProperties? : string[]
482
+ /**
483
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
484
+ * numeric-only values are interpreted as pixels.
485
+ */
486
+ margin? : number|string
487
+ /**
488
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/core/docs/api/Core/widget/Mask) created for the
489
+ * [masked](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
490
+ * values.
491
+ */
492
+ maskDefaults? : MaskConfig
493
+ /**
494
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
495
+ * [Mask](https://bryntum.com/products/core/docs/api/Core/widget/Mask) config object.
496
+ */
497
+ masked? : boolean|string|MaskConfig
498
+ /**
499
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
500
+ * like [height](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
501
+ */
502
+ maxHeight? : string|number
503
+ /**
504
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
505
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-maximizeOnMobile)
506
+ */
507
+ maximizeOnMobile? : number|string
508
+ /**
509
+ * The max number of characters for the input field
510
+ */
511
+ maxLength? : number
512
+ /**
513
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
514
+ * like [width](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
515
+ */
516
+ maxWidth? : string|number
517
+ /**
518
+ * The minimum string length to trigger the filtering, only relevant when [editable](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-editable) is `true`.
519
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-minChars)
520
+ */
521
+ minChars? : number
522
+ /**
523
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
524
+ * like [height](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
525
+ */
526
+ minHeight? : string|number
527
+ /**
528
+ * The min number of characters for the input field
529
+ */
530
+ minLength? : number
531
+ /**
532
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
533
+ * like [width](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
534
+ */
535
+ minWidth? : string|number
536
+ /**
537
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
538
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
539
+ * layout.
540
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-monitorResize)
541
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
542
+ */
543
+ monitorResize? : boolean|object
544
+ /**
545
+ * Set to `true` to allow selection of multiple values from the dropdown list.
546
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-multiSelect)
547
+ */
548
+ multiSelect? : boolean
549
+ /**
550
+ * A key value which, when typed in a [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) Combo, selects the
551
+ * currently active item in the picker, and clears the input field ready for another
552
+ * match to be typed.
553
+ */
554
+ multiValueSeparator? : string
555
+ /**
556
+ * Name of the field which is used as a key to get/set values from/to the field.
557
+ * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
558
+ * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
559
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-name)
560
+ */
561
+ name? : string
562
+ /**
563
+ * False option display value
564
+ */
565
+ negativeText? : string
566
+ /**
567
+ * Negative option value
568
+ */
569
+ negativeValue? : any
570
+ /**
571
+ * This implies that the picker will display an anchor pointer, but also means that the picker will align closer
572
+ * to the input field so that the pointer pierces the [pickerAlignElement](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-pickerAlignElement)
573
+ */
574
+ overlayAnchor? : boolean
575
+ /**
576
+ * Configuration object for the [picker](https://bryntum.com/products/core/docs/api/Core/widget/List) on initialization. Returns the
577
+ * [picker](https://bryntum.com/products/core/docs/api/Core/widget/List) instance at runtime.
578
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-picker)
579
+ */
580
+ picker? : ListConfig
581
+ /**
582
+ * The name of the element property to which the picker should size and align itself.
583
+ */
584
+ pickerAlignElement? : string
585
+ /**
586
+ * Width of picker, defaults to this combo's [pickerAlignElement](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-pickerAlignElement) width
587
+ */
588
+ pickerWidth? : number|string
589
+ /**
590
+ * Text to display in empty field.
591
+ */
592
+ placeholder? : string
593
+ /**
594
+ * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement), but must
595
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
596
+ * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
597
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-positioned)
598
+ */
599
+ positioned? : boolean
600
+ /**
601
+ * Positive option display value
602
+ */
603
+ positiveText? : string
604
+ /**
605
+ * Positive option value
606
+ */
607
+ positiveValue? : any
608
+ /**
609
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
610
+ * menu on click etc, since the tooltip would be displayed at the same time.
611
+ */
612
+ preventTooltipOnTouch? : boolean
613
+ /**
614
+ * Optionally a [Filter](https://bryntum.com/products/core/docs/api/Core/util/CollectionFilter) config object which the combo should use for
615
+ * filtering using the typed value.
616
+ * This may use a `filterBy` property to test its `value` against any field in the passed record.
617
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-primaryFilter)
618
+ */
619
+ primaryFilter? : CollectionFilterConfig
620
+ /**
621
+ * Makes the field unmodifiable by user action. The input area is not editable, and triggers
622
+ * are unresponsive.
623
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-readOnly)
624
+ */
625
+ readOnly? : boolean
626
+ relayStoreEvents? : boolean
627
+ /**
628
+ * Predefined style to use for the field. Possible values are:
629
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-rendition)
630
+ */
631
+ rendition? : 'outlined'|'filled'|string
632
+ /**
633
+ * Configure as `true` to indicate that a `null` field value is to be marked as invalid. This will
634
+ * optionally append a * to the field label if [showRequiredIndicator](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
635
+ */
636
+ required? : boolean
637
+ /**
638
+ * If this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
639
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
640
+ * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-clearable)
641
+ * behaviour will be activated.
642
+ */
643
+ revertOnEscape? : boolean
644
+ /**
645
+ * Configure as `true` to have the component display a translucent ripple when its
646
+ * [focusElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
647
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
648
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-ripple)
649
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
650
+ * @property {string} [color] A CSS color name or specification.
651
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
652
+ * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
653
+ */
654
+ ripple? : boolean|object
655
+ /**
656
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
657
+ * accidentally applying a role which may interfere with screen readers.
658
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-role)
659
+ */
660
+ role? : string
661
+ /**
662
+ * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
663
+ */
664
+ rootElement? : ShadowRoot|HTMLElement
665
+ /**
666
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
667
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-rtl)
668
+ */
669
+ rtl? : boolean
670
+ /**
671
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
672
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
673
+ */
674
+ scrollAction? : 'hide'|'realign'|null
675
+ /**
676
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
677
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-showAnimation)
678
+ */
679
+ showAnimation? : boolean|object
680
+ /**
681
+ * `true` to automatically display a * after the label for this field when it is [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-required).
682
+ */
683
+ showRequiredIndicator? : string
684
+ /**
685
+ * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-disabled)
686
+ */
687
+ showTooltipWhenDisabled? : boolean
688
+ /**
689
+ * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
690
+ * to the user).
691
+ */
692
+ skipValidation? : boolean
693
+ /**
694
+ * Programmatic control over how many columns to span when used in a grid layout.
695
+ */
696
+ span? : number
697
+ /**
698
+ * Sets the native `spellcheck` property of the underlying input element. For more information, please refer to
699
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck)
700
+ */
701
+ spellCheck? : boolean
702
+ /**
703
+ * Store used to populate items. Also accepts a Store config object
704
+ */
705
+ store? : Store|StoreConfig
706
+ /**
707
+ * A configuration for the [tab](https://bryntum.com/products/core/docs/api/Core/widget/Tab) created for this widget when it is placed in a
708
+ * [TabPanel](https://bryntum.com/products/core/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
709
+ * this widget:
710
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-tab)
711
+ */
712
+ tab? : boolean|TabConfig
713
+ /**
714
+ * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
715
+ * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
716
+ * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
717
+ * to the element programmatically.
718
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-tabIndex)
719
+ */
720
+ tabIndex? : number
721
+ /**
722
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
723
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-textAlign)
724
+ */
725
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
726
+ /**
727
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
728
+ */
729
+ title? : string
730
+ /**
731
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
732
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-tooltip)
733
+ */
734
+ tooltip? : string|TooltipConfig|null
735
+ /**
736
+ * How to query the store upon click of the expand trigger. Specify one of these values:
737
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-triggerAction)
738
+ */
739
+ triggerAction? : 'all'|'last'|null
740
+ /**
741
+ * The triggers to add either before or after the input field. Each property name is the reference by which
742
+ * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
743
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-triggers)
744
+ */
745
+ triggers? : Record<string, FieldTriggerConfig>
746
+ type? : 'booleancombo'
747
+ /**
748
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
749
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
750
+ * values are used as the class names.
751
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-ui)
752
+ */
753
+ ui? : string|object
754
+ /**
755
+ * `true` to cause the field to be in an invalid state while the typed filter string does not match a record in the store.
756
+ */
757
+ validateFilter? : boolean
758
+ /**
759
+ * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
760
+ * or similar.
761
+ */
762
+ validateOnInput? : boolean
763
+ /**
764
+ * Default value
765
+ */
766
+ value? : any
767
+ /**
768
+ * Field used for item value when populating from store. Setting this to `null` will
769
+ * yield the selected record as the Combo's [value](https://bryntum.com/products/core/docs/api/Core/widget/Combo#property-value).
770
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-valueField)
771
+ */
772
+ valueField? : string|null
773
+ /**
774
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/core/docs/api/Core/widget/Container).
775
+ * Higher weights go further down.
776
+ */
777
+ weight? : number
778
+ /**
779
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
780
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
781
+ * this config is convenient.
782
+ */
783
+ width? : string|number
784
+ /**
785
+ * The x position for the widget.
786
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-x)
787
+ */
788
+ x? : number
789
+ /**
790
+ * The y position for the widget.
791
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-y)
792
+ */
793
+ y? : number
794
+
795
+ // Events
796
+ /**
797
+ * The default action was performed (an item in the list was selected)
798
+ * @param {object} event Event object
799
+ * @param {Core.widget.Combo} event.source The combo
800
+ * @param {any} event.value The [value](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-valueField) of the selected record
801
+ * @param {Core.data.Model} event.record Selected record
802
+ * @param {Core.data.Model[]} event.records Selected records as an array if [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`
803
+ * @param {boolean} event.userAction `true` if the value change is due to user interaction
804
+ */
805
+ onAction? : ((event: { source: Combo, value: any, record: Model, records: Model[], userAction: boolean }) => void)|string
806
+ /**
807
+ * Fires before an object is destroyed.
808
+ * @param {object} event Event object
809
+ * @param {Core.Base} event.source The Object that is being destroyed.
810
+ */
811
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
812
+ /**
813
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
814
+ * @param {object} event Event object
815
+ * @param {Core.widget.Widget} event.source The widget being hidden.
816
+ */
817
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
818
+ /**
819
+ * Triggered before a widget is shown. Return `false` to prevent the action.
820
+ * @param {object} event Event object
821
+ * @param {Core.widget.Widget,any} event.source The widget being shown
822
+ */
823
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
824
+ /**
825
+ * Fires when any other event is fired from the object.
826
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#event-catchAll)
827
+ * @param {object} event Event object
828
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
829
+ * @param {string} event.event.type The type of the event which is caught by the listener
830
+ */
831
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
832
+ /**
833
+ * Fired when this field's value changes.
834
+ * @param {object} event Event object
835
+ * @param {Core.widget.Field,any} event.source This Field
836
+ * @param {string,number,boolean,any} event.value This field's value
837
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
838
+ * @param {boolean} event.valid True if this field is in a valid state
839
+ * @param {Event} event.event The triggering DOM event if any
840
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
841
+ * @param {boolean} event.checked
842
+ */
843
+ onChange? : ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, userAction: boolean, checked: boolean }) => void)|string
844
+ /**
845
+ * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
846
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#event-clear)
847
+ * @param {object} event Event object
848
+ * @param {Core.widget.Field,any} event.source This Field
849
+ */
850
+ onClear? : ((event: { source: Field|any }) => void)|string
851
+ /**
852
+ * Fires when an object is destroyed.
853
+ * @param {object} event Event object
854
+ * @param {Core.Base} event.source The Object that is being destroyed.
855
+ */
856
+ onDestroy? : ((event: { source: Base }) => void)|string
857
+ /**
858
+ * Triggered when a widget's [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element) is available.
859
+ * @param {object} event Event object
860
+ * @param {HTMLElement} event.element The Widget's element.
861
+ */
862
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
863
+ /**
864
+ * Fired when focus enters this Widget.
865
+ * @param {object} event Event object
866
+ * @param {Core.widget.Widget} event.source This Widget
867
+ * @param {HTMLElement} event.fromElement The element which lost focus.
868
+ * @param {HTMLElement} event.toElement The element which gained focus.
869
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
870
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
871
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
872
+ */
873
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
874
+ /**
875
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
876
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
877
+ * will not trigger this event. This is when focus exits this widget completely.
878
+ * @param {object} event Event object
879
+ * @param {Core.widget.Widget} event.source This Widget
880
+ * @param {HTMLElement} event.fromElement The element which lost focus.
881
+ * @param {HTMLElement} event.toElement The element which gained focus.
882
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
883
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
884
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
885
+ */
886
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
887
+ /**
888
+ * Triggered after a widget was hidden
889
+ * @param {object} event Event object
890
+ * @param {Core.widget.Widget} event.source The widget
891
+ */
892
+ onHide? : ((event: { source: Widget }) => void)|string
893
+ /**
894
+ * User typed into the field. Please note that the value attached to this event is the raw input field value and
895
+ * not the combos value
896
+ * @param {object} event Event object
897
+ * @param {Core.widget.Combo} event.source The combo.
898
+ * @param {string} event.value Raw input value
899
+ * @param {Event} event.event The triggering DOM event if any.
900
+ */
901
+ onInput? : ((event: { source: Combo, value: string, event: Event }) => void)|string
902
+ /**
903
+ * Triggered when a widget which had been in a non-visible state for any reason
904
+ * achieves visibility.
905
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#event-paint)
906
+ * @param {object} event Event object
907
+ * @param {Core.widget.Widget} event.source The widget being painted.
908
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
909
+ */
910
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
911
+ /**
912
+ * Fired when a Widget's read only state is toggled
913
+ * @param {object} event Event object
914
+ * @param {boolean} event.readOnly Read only or not
915
+ */
916
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
917
+ /**
918
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
919
+ * to [recompose](https://bryntum.com/products/core/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
920
+ */
921
+ onRecompose? : (() => void)|string
922
+ /**
923
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
924
+ * @param {object} event Event object
925
+ * @param {Core.widget.Widget} event.source This Widget
926
+ * @param {number} event.width The new width
927
+ * @param {number} event.height The new height
928
+ * @param {number} event.oldWidth The old width
929
+ * @param {number} event.oldHeight The old height
930
+ */
931
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
932
+ /**
933
+ * An item in the list was selected
934
+ * @param {object} event Event object
935
+ * @param {Core.widget.Combo} event.source The combo
936
+ * @param {Core.data.Model} event.record Selected record
937
+ * @param {Core.data.Model[]} event.records Selected records as an array if [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`
938
+ * @param {boolean} event.userAction `true` if the value change is due to user interaction
939
+ */
940
+ onSelect? : ((event: { source: Combo, record: Model, records: Model[], userAction: boolean }) => void)|string
941
+ /**
942
+ * Triggered after a widget is shown.
943
+ * @param {object} event Event object
944
+ * @param {Core.widget.Widget} event.source The widget
945
+ */
946
+ onShow? : ((event: { source: Widget }) => void)|string
947
+ /**
948
+ * User clicked one of this field's [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers)
949
+ * @param {object} event Event object
950
+ * @param {Core.widget.Field,any} event.source This field
951
+ * @param {Core.widget.Widget} event.trigger The trigger activated by click or touch tap.
952
+ */
953
+ onTrigger? : ((event: { source: Field|any, trigger: Widget }) => void)|string
954
+
955
+ }
956
+
957
+ export class BryntumBooleanCombo extends React.Component<BryntumBooleanComboProps> {
958
+
959
+ static instanceClass = BooleanCombo;
960
+
961
+ static instanceName = 'BooleanCombo';
962
+
963
+ processWidgetContent = processWidgetContent;
964
+
965
+ static configNames = [
966
+ 'adopt',
967
+ 'align',
968
+ 'anchor',
969
+ 'ariaDescription',
970
+ 'ariaLabel',
971
+ 'autoComplete',
972
+ 'autoExpand',
973
+ 'autoSelect',
974
+ 'bubbleEvents',
975
+ 'cacheLastResult',
976
+ 'caseSensitive',
977
+ 'centered',
978
+ 'chipView',
979
+ 'clearable',
980
+ 'clearTextOnPickerHide',
981
+ 'clearTextOnSelection',
982
+ 'clearWhenInputEmpty',
983
+ 'color',
984
+ 'config',
985
+ 'constrainTo',
986
+ 'container',
987
+ 'containValues',
988
+ 'contentElementCls',
989
+ 'createOnUnmatched',
990
+ 'dataField',
991
+ 'defaultBindProperty',
992
+ 'detectCSSCompatibilityIssues',
993
+ 'displayField',
994
+ 'displayValueRenderer',
995
+ 'dock',
996
+ 'draggable',
997
+ 'elementAttributes',
998
+ 'emptyText',
999
+ 'encodeFilterParams',
1000
+ 'filterOnEnter',
1001
+ 'filterParamName',
1002
+ 'filterSelected',
1003
+ 'floating',
1004
+ 'hideAnimation',
1005
+ 'hidePickerOnSelect',
1006
+ 'hideTrigger',
1007
+ 'highlightExternalChange',
1008
+ 'hint',
1009
+ 'hintHtml',
1010
+ 'ignoreParentReadOnly',
1011
+ 'inline',
1012
+ 'inlinePicker',
1013
+ 'inputAlign',
1014
+ 'inputAttributes',
1015
+ 'inputTag',
1016
+ 'inputType',
1017
+ 'inputWidth',
1018
+ 'items',
1019
+ 'keyStrokeChangeDelay',
1020
+ 'keyStrokeFilterDelay',
1021
+ 'labelCls',
1022
+ 'labelPosition',
1023
+ 'labels',
1024
+ 'labelWidth',
1025
+ 'listCls',
1026
+ 'listeners',
1027
+ 'listItemTpl',
1028
+ 'localeClass',
1029
+ 'localizable',
1030
+ 'localizableProperties',
1031
+ 'maskDefaults',
1032
+ 'masked',
1033
+ 'maxLength',
1034
+ 'minChars',
1035
+ 'minLength',
1036
+ 'monitorResize',
1037
+ 'multiValueSeparator',
1038
+ 'name',
1039
+ 'negativeText',
1040
+ 'negativeValue',
1041
+ 'overlayAnchor',
1042
+ 'pickerAlignElement',
1043
+ 'pickerWidth',
1044
+ 'positioned',
1045
+ 'positiveText',
1046
+ 'positiveValue',
1047
+ 'preventTooltipOnTouch',
1048
+ 'primaryFilter',
1049
+ 'relayStoreEvents',
1050
+ 'revertOnEscape',
1051
+ 'ripple',
1052
+ 'role',
1053
+ 'rootElement',
1054
+ 'scrollAction',
1055
+ 'showAnimation',
1056
+ 'showTooltipWhenDisabled',
1057
+ 'skipValidation',
1058
+ 'spellCheck',
1059
+ 'tab',
1060
+ 'tabIndex',
1061
+ 'textAlign',
1062
+ 'title',
1063
+ 'triggerAction',
1064
+ 'type',
1065
+ 'ui',
1066
+ 'validateFilter',
1067
+ 'validateOnInput',
1068
+ 'valueField',
1069
+ 'weight'
1070
+ ];
1071
+
1072
+ static propertyConfigNames = [
1073
+ 'alignSelf',
1074
+ 'appendTo',
1075
+ 'badge',
1076
+ 'callOnFunctions',
1077
+ 'catchEventHandlerExceptions',
1078
+ 'cls',
1079
+ 'column',
1080
+ 'dataset',
1081
+ 'disabled',
1082
+ 'editable',
1083
+ 'extraData',
1084
+ 'filterOperator',
1085
+ 'flex',
1086
+ 'height',
1087
+ 'hidden',
1088
+ 'id',
1089
+ 'insertBefore',
1090
+ 'insertFirst',
1091
+ 'keyMap',
1092
+ 'label',
1093
+ 'margin',
1094
+ 'maxHeight',
1095
+ 'maximizeOnMobile',
1096
+ 'maxWidth',
1097
+ 'minHeight',
1098
+ 'minWidth',
1099
+ 'multiSelect',
1100
+ 'onAction',
1101
+ 'onBeforeDestroy',
1102
+ 'onBeforeHide',
1103
+ 'onBeforeShow',
1104
+ 'onCatchAll',
1105
+ 'onChange',
1106
+ 'onClear',
1107
+ 'onDestroy',
1108
+ 'onElementCreated',
1109
+ 'onFocusIn',
1110
+ 'onFocusOut',
1111
+ 'onHide',
1112
+ 'onInput',
1113
+ 'onPaint',
1114
+ 'onReadOnly',
1115
+ 'onRecompose',
1116
+ 'onResize',
1117
+ 'onSelect',
1118
+ 'onShow',
1119
+ 'onTrigger',
1120
+ 'picker',
1121
+ 'placeholder',
1122
+ 'readOnly',
1123
+ 'rendition',
1124
+ 'required',
1125
+ 'rtl',
1126
+ 'showRequiredIndicator',
1127
+ 'span',
1128
+ 'store',
1129
+ 'tooltip',
1130
+ 'triggers',
1131
+ 'value',
1132
+ 'width',
1133
+ 'x',
1134
+ 'y'
1135
+ ];
1136
+
1137
+ static propertyNames = [
1138
+ 'content',
1139
+ 'formula',
1140
+ 'html',
1141
+ 'input',
1142
+ 'parent',
1143
+ 'scrollable'
1144
+ ];
1145
+
1146
+ // Component instance
1147
+ instance!: BooleanCombo;
1148
+
1149
+ // Component element
1150
+ element! : HTMLElement;
1151
+
1152
+ componentDidMount(): void {
1153
+ this.instance = createWidget(this);
1154
+ }
1155
+
1156
+ componentWillUnmount(): void {
1157
+ // @ts-ignore
1158
+ this.instance?.destroy?.();
1159
+ }
1160
+
1161
+ /**
1162
+ * Component about to be updated, from changing a prop using state.
1163
+ * React to it depending on what changed and prevent react from re-rendering our component.
1164
+ * @param nextProps
1165
+ * @param nextState
1166
+ * @returns {boolean}
1167
+ */
1168
+ shouldComponentUpdate(nextProps: Readonly<BryntumBooleanComboProps>, nextState: Readonly<{}>): boolean {
1169
+ return shouldComponentUpdate(this, nextProps, nextState);
1170
+ }
1171
+
1172
+ render(): React.ReactNode {
1173
+
1174
+ const className = `b-react-boolean-combo-container`;
1175
+ return (
1176
+ <div className={className} ref={(element) => (this.element = element!)}></div>
1177
+ );
1178
+
1179
+ }
1180
+ }