@bryntum/core-react-thin 7.2.4 → 7.3.1

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