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