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