@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,1019 @@
1
+ /**
2
+ * React wrapper for Bryntum ColumnFilterField
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
+ import { ColumnFilterField, ColumnFilterFieldListeners, TaskBoardContainerItemConfig, TaskBoard } from '@bryntum/taskboard-thin';
8
+
9
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
10
+
11
+ export type BryntumColumnFilterFieldProps = {
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/ColumnFilterField#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/ColumnFilterField#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/ColumnFilterField#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/ColumnFilterField#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
+ * 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/ColumnFilterField#config-bubbleEvents)
74
+ */
75
+ bubbleEvents? : object
76
+ /**
77
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
78
+ * ...
79
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-callOnFunctions)
80
+ */
81
+ callOnFunctions? : boolean
82
+ /**
83
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
84
+ * application state is undefined. Code which follows the event handler will *not* be executed.
85
+ * ...
86
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-catchEventHandlerExceptions)
87
+ */
88
+ catchEventHandlerExceptions? : boolean
89
+ /**
90
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
91
+ * Set to `true` to centre the Widget in browser viewport space.
92
+ */
93
+ centered? : boolean
94
+ /**
95
+ * 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
96
+ * 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
97
+ * configures the `clear` [trigger](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-triggers).
98
+ */
99
+ clearable? : boolean|FieldTriggerConfig
100
+ /**
101
+ * Custom CSS classes to add to element.
102
+ * May be specified as a space separated string, or as an object in which property names
103
+ * with truthy values are used as the class names:
104
+ * ...
105
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-cls)
106
+ */
107
+ cls? : string|object
108
+ /**
109
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
110
+ * `style` block.
111
+ * ...
112
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-color)
113
+ */
114
+ color? : string
115
+ /**
116
+ * Programmatic control over which column to start in when used in a grid layout.
117
+ */
118
+ column? : number
119
+ config? : object
120
+ /**
121
+ * *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).*
122
+ * Element, Widget or Rectangle to which this Widget is constrained.
123
+ */
124
+ constrainTo? : HTMLElement|Widget|Rectangle
125
+ /**
126
+ * The configuration for additional items associated to this field. This is typically used to add contextual
127
+ * fields related to a [checkbox](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
128
+ * these classes for examples of nested fields.
129
+ * ...
130
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-container)
131
+ */
132
+ container? : Record<string, TaskBoardContainerItemConfig>|TaskBoardContainerItemConfig[]|FieldContainerConfig|FieldContainer
133
+ /**
134
+ * The config controls how the value of nested items are handled when a parent container gets or sets its
135
+ * [values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
136
+ * ...
137
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-containValues)
138
+ * @param {Core.widget.Field} field Field instance
139
+ * @returns {boolean}
140
+ */
141
+ containValues? : boolean|string|((field: Field) => boolean)
142
+ /**
143
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
144
+ * May be specified as a space separated string, or as an object in which property names
145
+ * with truthy values are used as the class names:
146
+ * ...
147
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-contentElementCls)
148
+ */
149
+ contentElementCls? : string|object
150
+ /**
151
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
152
+ * field on the expanded record to use for populating this widget's store (if applicable)
153
+ */
154
+ dataField? : string
155
+ /**
156
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
157
+ */
158
+ dataset? : Record<string, string>
159
+ /**
160
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
161
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
162
+ */
163
+ defaultBindProperty? : string
164
+ /**
165
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
166
+ * ...
167
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-detectCSSCompatibilityIssues)
168
+ */
169
+ detectCSSCompatibilityIssues? : boolean
170
+ /**
171
+ * 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
172
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
173
+ * ...
174
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-disabled)
175
+ */
176
+ disabled? : boolean|'inert'
177
+ /**
178
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel)
179
+ * [strips collection](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
180
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
181
+ * body. Such widgets are called "edge strips".
182
+ * ...
183
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-dock)
184
+ */
185
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
186
+ /**
187
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
188
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
189
+ * property which controls when a drag should start.
190
+ * ...
191
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-draggable)
192
+ */
193
+ draggable? : boolean|{
194
+ handleSelector?: string
195
+ }
196
+ /**
197
+ * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
198
+ * [readOnly](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
199
+ * but not to type one in the field.
200
+ * ...
201
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-editable)
202
+ */
203
+ editable? : boolean
204
+ /**
205
+ * An object specifying attributes to assign to the root element of this widget.
206
+ * Set `null` value to attribute to remove it.
207
+ * ...
208
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-elementAttributes)
209
+ */
210
+ elementAttributes? : Record<string, string|null>
211
+ extraData? : any
212
+ /**
213
+ * The ColumnModel field name to filter by, defaults to `'text'`.
214
+ */
215
+ field? : string
216
+ /**
217
+ * In case the `filterId` that is used in the store needs to be referenced elsewhere, it can be configured.
218
+ * This applies to a passed [filterFunction](https://bryntum.com/products/taskboard/docs/api/Core/widget/FilterField#config-filterFunction) as well as for an internally generated filter.
219
+ * If no value is configured, an internal ID will be generated.
220
+ * ...
221
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-filterId)
222
+ */
223
+ filterId? : string|Symbol
224
+ /**
225
+ * 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
226
+ * flexbox layout. This config allows you to set this widget's
227
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
228
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
229
+ * numeric-only values are interpreted as the `flex-grow` value.
230
+ */
231
+ flex? : number|string
232
+ /**
233
+ * Set to `true` to move the widget out of the document flow and position it
234
+ * absolutely in browser viewport space.
235
+ */
236
+ floating? : boolean
237
+ /**
238
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
239
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
240
+ * cases this config is convenient.
241
+ */
242
+ height? : string|number
243
+ /**
244
+ * Configure with true to make widget initially hidden.
245
+ */
246
+ hidden? : boolean
247
+ /**
248
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
249
+ * ...
250
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hideAnimation)
251
+ */
252
+ hideAnimation? : boolean|object
253
+ /**
254
+ * Specify `true` to highlight field after external value changes
255
+ */
256
+ highlightExternalChange? : boolean
257
+ /**
258
+ * An optional string to display inside the input field as an overlay. This can be useful for displaying
259
+ * a field's units.
260
+ * ...
261
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hint)
262
+ * @param {object} data A data object
263
+ * @param {Core.widget.Field} data.source A reference to the field instance
264
+ * @param {any} data.value The current value of the field
265
+ * @returns {string}
266
+ */
267
+ hint? : string|((data: { source: Field, value: any }) => string)
268
+ /**
269
+ * 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.
270
+ * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
271
+ * encode such data (see [encodeHtml](https://bryntum.com/products/taskboard/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
272
+ * ...
273
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hintHtml)
274
+ * @param {object} data A data object
275
+ * @param {Core.widget.Field} data.source A reference to the field instance
276
+ * @param {any} data.value The current value of the field
277
+ * @returns {string}
278
+ */
279
+ hintHtml? : string|((data: { source: Field, value: any }) => string)
280
+ /**
281
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
282
+ */
283
+ id? : string
284
+ /**
285
+ * Determines if the widgets read-only state should be controlled by its parent.
286
+ * ...
287
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ignoreParentReadOnly)
288
+ */
289
+ ignoreParentReadOnly? : boolean
290
+ /**
291
+ * Set this config to `true` to always display items horizontally along with this field. This assigns an
292
+ * [hbox](https://bryntum.com/products/taskboard/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
293
+ * [container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#config-container).
294
+ * ...
295
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-inline)
296
+ */
297
+ inline? : boolean
298
+ /**
299
+ * Text alignment for the input field.
300
+ */
301
+ inputAlign? : string
302
+ /**
303
+ * Sets custom attributes of the underlying input element. For more information, please refer to
304
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
305
+ */
306
+ inputAttributes? : Record<string, string>
307
+ /**
308
+ * If you need to use something else than a default `input` element, as the input element, provide the tag
309
+ * name here. Please note that this is used for advanced usage only, for example when using WebComponents
310
+ * (custom elements), and that the configured element must fulfil the same contract as a regular input
311
+ * element.
312
+ */
313
+ inputTag? : string
314
+ /**
315
+ * Sets the `type` attribute of the underlying input element (password, hidden, date, color, etc.).
316
+ */
317
+ inputType? : string
318
+ /**
319
+ * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
320
+ * triggers. If a number is specified, `px` will be used.
321
+ */
322
+ inputWidth? : string|number
323
+ /**
324
+ * 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.
325
+ */
326
+ insertBefore? : HTMLElement|string
327
+ /**
328
+ * 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.
329
+ */
330
+ insertFirst? : HTMLElement|string
331
+ /**
332
+ * Set this flag to mark the filter as `internal` when adding it to the associated [Store](https://bryntum.com/products/taskboard/docs/api/Core/data/Store).
333
+ * This prevents the filter from being removed when [Store.clearFilters()](https://bryntum.com/products/taskboard/docs/api/Core/data/Store#function-clearFilters)
334
+ * is called.
335
+ */
336
+ internalFilter? : boolean
337
+ /**
338
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
339
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
340
+ * are the name of the instance method to call when the keystroke is received.
341
+ * ...
342
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-keyMap)
343
+ */
344
+ keyMap? : Record<string, KeyMapConfig>
345
+ /**
346
+ * The delay in milliseconds to wait after the last keystroke before triggering a change event.
347
+ * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
348
+ * immediate feedback, change will still be triggered on blur).
349
+ * ...
350
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-keyStrokeChangeDelay)
351
+ */
352
+ keyStrokeChangeDelay? : number
353
+ /**
354
+ * Label, defaults to a localized version of `'Filter columns'`.
355
+ * ...
356
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-label)
357
+ */
358
+ label? : string
359
+ /**
360
+ * 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)
361
+ */
362
+ labelCls? : string|object
363
+ /**
364
+ * Label position, either 'before' the field or 'above' the field
365
+ * ...
366
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-labelPosition)
367
+ */
368
+ labelPosition? : 'before'|'above'|null
369
+ /**
370
+ * The labels to add either before or after the input field.
371
+ * Each label may have the following properties:
372
+ * ...
373
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-labels)
374
+ */
375
+ labels? : object[]
376
+ /**
377
+ * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
378
+ */
379
+ labelWidth? : string|number
380
+ /**
381
+ * The listener set for this object.
382
+ * ...
383
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-listeners)
384
+ */
385
+ listeners? : ColumnFilterFieldListeners
386
+ /**
387
+ * A class translations of which are used for translating this entity.
388
+ * This is often used when translations of an item are defined on its container class.
389
+ * For example:
390
+ * ...
391
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-localeClass)
392
+ */
393
+ localeClass? : typeof Base
394
+ /**
395
+ * Set to `false` to disable localization of this object.
396
+ */
397
+ localizable? : boolean
398
+ /**
399
+ * List of properties which values should be translated automatically upon a locale applying.
400
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
401
+ * you could use 'localeKey' meta configuration.
402
+ * Example:
403
+ * ...
404
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-localizableProperties)
405
+ */
406
+ localizableProperties? : string[]
407
+ /**
408
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
409
+ * numeric-only values are interpreted as pixels.
410
+ */
411
+ margin? : number|string
412
+ /**
413
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) created for the
414
+ * [masked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
415
+ * values.
416
+ */
417
+ maskDefaults? : MaskConfig
418
+ /**
419
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
420
+ * [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object.
421
+ */
422
+ masked? : boolean|string|MaskConfig
423
+ /**
424
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
425
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
426
+ */
427
+ maxHeight? : string|number
428
+ /**
429
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
430
+ * ...
431
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-maximizeOnMobile)
432
+ */
433
+ maximizeOnMobile? : number|string
434
+ /**
435
+ * The max number of characters for the input field
436
+ */
437
+ maxLength? : number
438
+ /**
439
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
440
+ * like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
441
+ */
442
+ maxWidth? : string|number
443
+ /**
444
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
445
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
446
+ */
447
+ minHeight? : string|number
448
+ /**
449
+ * The min number of characters for the input field
450
+ */
451
+ minLength? : number
452
+ /**
453
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
454
+ * like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
455
+ */
456
+ minWidth? : string|number
457
+ /**
458
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
459
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
460
+ * layout.
461
+ * ...
462
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-monitorResize)
463
+ */
464
+ monitorResize? : boolean|{
465
+ immediate?: boolean
466
+ }
467
+ /**
468
+ * Name of the field which is used as a key to get/set values from/to the field.
469
+ * Used prior to [ref](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
470
+ * [Container.values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
471
+ * ...
472
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-name)
473
+ */
474
+ name? : string
475
+ /**
476
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
477
+ * [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
478
+ * the owner is <strong>always</strong> the encapsulating Container.
479
+ * ...
480
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-owner)
481
+ */
482
+ owner? : Widget|any
483
+ /**
484
+ * Text to display in empty field.
485
+ */
486
+ placeholder? : string
487
+ /**
488
+ * 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
489
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
490
+ * widget's [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
491
+ * ...
492
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-positioned)
493
+ */
494
+ positioned? : boolean
495
+ /**
496
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
497
+ * menu on click etc, since the tooltip would be displayed at the same time.
498
+ */
499
+ preventTooltipOnTouch? : boolean
500
+ /**
501
+ * Makes the field unmodifiable by user action. The input area is not editable, and triggers
502
+ * are unresponsive.
503
+ * ...
504
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-readOnly)
505
+ */
506
+ readOnly? : boolean
507
+ relayStoreEvents? : boolean
508
+ /**
509
+ * Predefined style to use for the field. Possible values are:
510
+ * ...
511
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-rendition)
512
+ */
513
+ rendition? : 'outlined'|'filled'|string
514
+ /**
515
+ * Configure as `true` to indicate that a `null` field value is to be marked as invalid. This will
516
+ * optionally append a * to the field label if [showRequiredIndicator](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
517
+ */
518
+ required? : boolean
519
+ /**
520
+ * 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
521
+ * the `ESCAPE` key after editing the field will revert the field to the value it had when
522
+ * 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)
523
+ * behaviour will be activated.
524
+ */
525
+ revertOnEscape? : boolean
526
+ /**
527
+ * Configure as `true` to have the component display a translucent ripple when its
528
+ * [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
529
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
530
+ * ...
531
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ripple)
532
+ */
533
+ ripple? : boolean|{
534
+ delegate?: string
535
+ color?: string
536
+ radius?: number
537
+ clip?: string
538
+ }
539
+ /**
540
+ * 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`
541
+ */
542
+ rootElement? : ShadowRoot|HTMLElement
543
+ /**
544
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
545
+ * ...
546
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-rtl)
547
+ */
548
+ rtl? : boolean
549
+ /**
550
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
551
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
552
+ */
553
+ scrollAction? : 'hide'|'realign'|null
554
+ /**
555
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
556
+ * ...
557
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-showAnimation)
558
+ */
559
+ showAnimation? : boolean|object
560
+ /**
561
+ * `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).
562
+ */
563
+ showRequiredIndicator? : string
564
+ /**
565
+ * 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)
566
+ */
567
+ showTooltipWhenDisabled? : boolean
568
+ /**
569
+ * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
570
+ * to the user).
571
+ */
572
+ skipValidation? : boolean
573
+ /**
574
+ * Programmatic control over how many columns to span when used in a grid layout.
575
+ */
576
+ span? : number
577
+ /**
578
+ * Sets the native `spellcheck` property of the underlying input element. For more information, please refer to
579
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck)
580
+ */
581
+ spellCheck? : boolean
582
+ /**
583
+ * 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
584
+ * [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
585
+ * this widget:
586
+ * ...
587
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tab)
588
+ */
589
+ tab? : boolean|TabConfig
590
+ /**
591
+ * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
592
+ * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
593
+ * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
594
+ * to the element programmatically.
595
+ * ...
596
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tabIndex)
597
+ */
598
+ tabIndex? : number
599
+ /**
600
+ * Auto detected when used within a TaskBoard. If you add the widget elsewhere, it will try to find an instance
601
+ * of TaskBoard on page. If that fails you have to supply this config to connect it to a TaskBoard manually.
602
+ * ...
603
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-taskBoard)
604
+ */
605
+ taskBoard? : TaskBoard
606
+ /**
607
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
608
+ * ...
609
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-textAlign)
610
+ */
611
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
612
+ /**
613
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
614
+ */
615
+ title? : string
616
+ /**
617
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
618
+ * ...
619
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tooltip)
620
+ */
621
+ tooltip? : string|TooltipConfig|null
622
+ /**
623
+ * The triggers to add either before or after the input field. Each property name is the reference by which
624
+ * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
625
+ * ...
626
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-triggers)
627
+ */
628
+ triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
629
+ type? : 'columnfilterfield'
630
+ /**
631
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
632
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
633
+ * values are used as the class names.
634
+ * ...
635
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ui)
636
+ */
637
+ ui? : string|object
638
+ /**
639
+ * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
640
+ * or similar.
641
+ */
642
+ validateOnInput? : boolean
643
+ /**
644
+ * Default value
645
+ */
646
+ value? : string
647
+ /**
648
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container).
649
+ * Higher weights go further down.
650
+ */
651
+ weight? : number
652
+ /**
653
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
654
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
655
+ * this config is convenient.
656
+ */
657
+ width? : string|number
658
+ /**
659
+ * The x position for the widget.
660
+ * ...
661
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-x)
662
+ */
663
+ x? : number
664
+ /**
665
+ * The y position for the widget.
666
+ * ...
667
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-y)
668
+ */
669
+ y? : number
670
+
671
+ // Events
672
+ /**
673
+ * User performed default action (typed into this field).
674
+ * @param {object} event Event object
675
+ * @param {Core.widget.Field,any} event.source This Field
676
+ * @param {string,number,boolean,any} event.value This field's value
677
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
678
+ * @param {boolean} event.valid True if this field is in a valid state
679
+ * @param {Event} event.event The triggering DOM event if any
680
+ * @param {Core.data.Model} event.record Selected record. Available for fields with records selection functionality
681
+ * @param {Core.data.Model[]} event.records Selected records as an array. Available for fields with records selection functionality
682
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
683
+ * @param {boolean} event.checked
684
+ */
685
+ onAction? : ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, record: Model, records: Model[], userAction: boolean, checked: boolean }) => void)|string
686
+ /**
687
+ * Fires before an object is destroyed.
688
+ * @param {object} event Event object
689
+ * @param {Core.Base} event.source The Object that is being destroyed.
690
+ */
691
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
692
+ /**
693
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
694
+ * @param {object} event Event object
695
+ * @param {Core.widget.Widget} event.source The widget being hidden.
696
+ */
697
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
698
+ /**
699
+ * Triggered before a widget is shown. Return `false` to prevent the action.
700
+ * @param {object} event Event object
701
+ * @param {Core.widget.Widget,any} event.source The widget being shown
702
+ */
703
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
704
+ /**
705
+ * Fires when any other event is fired from the object.
706
+ * ...
707
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#event-catchAll)
708
+ * @param {object} event Event object
709
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
710
+ * @param {string} event.event.type The type of the event which is caught by the listener
711
+ */
712
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
713
+ /**
714
+ * Fired when this field's value changes.
715
+ * @param {object} event Event object
716
+ * @param {Core.widget.Field,any} event.source This Field
717
+ * @param {string,number,boolean,any} event.value This field's value
718
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
719
+ * @param {boolean} event.valid True if this field is in a valid state
720
+ * @param {Event} event.event The triggering DOM event if any
721
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
722
+ * @param {boolean} event.checked
723
+ */
724
+ 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
725
+ /**
726
+ * Fired when this field is [cleared](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#function-clear).
727
+ * ...
728
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#event-clear)
729
+ * @param {object} event Event object
730
+ * @param {Core.widget.Field,any} event.source This Field
731
+ */
732
+ onClear? : ((event: { source: Field|any }) => void)|string
733
+ /**
734
+ * Fires when an object is destroyed.
735
+ * @param {object} event Event object
736
+ * @param {Core.Base} event.source The Object that is being destroyed.
737
+ */
738
+ onDestroy? : ((event: { source: Base }) => void)|string
739
+ /**
740
+ * Triggered when a widget's [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element) is available.
741
+ * @param {object} event Event object
742
+ * @param {HTMLElement} event.element The Widget's element.
743
+ */
744
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
745
+ /**
746
+ * Fired when focus enters this Widget.
747
+ * @param {object} event Event object
748
+ * @param {Core.widget.Widget} event.source This Widget
749
+ * @param {HTMLElement} event.fromElement The element which lost focus.
750
+ * @param {HTMLElement} event.toElement The element which gained focus.
751
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
752
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
753
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
754
+ */
755
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
756
+ /**
757
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
758
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
759
+ * will not trigger this event. This is when focus exits this widget completely.
760
+ * @param {object} event Event object
761
+ * @param {Core.widget.Widget} event.source This Widget
762
+ * @param {HTMLElement} event.fromElement The element which lost focus.
763
+ * @param {HTMLElement} event.toElement The element which gained focus.
764
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
765
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
766
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
767
+ */
768
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
769
+ /**
770
+ * Triggered after a widget was hidden
771
+ * @param {object} event Event object
772
+ * @param {Core.widget.Widget} event.source The widget
773
+ */
774
+ onHide? : ((event: { source: Widget }) => void)|string
775
+ /**
776
+ * Fired when the user types into this field.
777
+ * @param {object} event Event object
778
+ * @param {Core.widget.Field,any} event.source This field
779
+ * @param {string,number,boolean,any} event.value This field's value
780
+ * @param {Event} event.event The triggering DOM event
781
+ */
782
+ onInput? : ((event: { source: Field|any, value: string|number|boolean|any, event: Event }) => void)|string
783
+ /**
784
+ * Triggered when a widget which had been in a non-visible state for any reason
785
+ * achieves visibility.
786
+ * ...
787
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#event-paint)
788
+ * @param {object} event Event object
789
+ * @param {Core.widget.Widget} event.source The widget being painted.
790
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
791
+ */
792
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
793
+ /**
794
+ * Fired when a Widget's read only state is toggled
795
+ * @param {object} event Event object
796
+ * @param {boolean} event.readOnly Read only or not
797
+ */
798
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
799
+ /**
800
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
801
+ * 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.
802
+ */
803
+ onRecompose? : (() => void)|string
804
+ /**
805
+ * 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`*.
806
+ * @param {object} event Event object
807
+ * @param {Core.widget.Widget} event.source This Widget
808
+ * @param {number} event.width The new width
809
+ * @param {number} event.height The new height
810
+ * @param {number} event.oldWidth The old width
811
+ * @param {number} event.oldHeight The old height
812
+ */
813
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
814
+ /**
815
+ * Triggered after a widget is shown.
816
+ * @param {object} event Event object
817
+ * @param {Core.widget.Widget} event.source The widget
818
+ */
819
+ onShow? : ((event: { source: Widget }) => void)|string
820
+ /**
821
+ * User clicked one of this field's [triggers](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-triggers)
822
+ * @param {object} event Event object
823
+ * @param {Core.widget.Field,any} event.source This field
824
+ * @param {Core.widget.Widget} event.trigger The trigger activated by click or touch tap.
825
+ */
826
+ onTrigger? : ((event: { source: Field|any, trigger: Widget }) => void)|string
827
+
828
+ }
829
+
830
+ export class BryntumColumnFilterField extends React.Component<BryntumColumnFilterFieldProps> {
831
+
832
+ static instanceClass = ColumnFilterField;
833
+
834
+ static instanceName = 'ColumnFilterField';
835
+
836
+ processWidgetContent = processWidgetContent;
837
+
838
+ static configNames = [
839
+ 'adopt',
840
+ 'align',
841
+ 'anchor',
842
+ 'ariaDescription',
843
+ 'ariaLabel',
844
+ 'autoComplete',
845
+ 'autoSelect',
846
+ 'bubbleEvents',
847
+ 'centered',
848
+ 'clearable',
849
+ 'color',
850
+ 'config',
851
+ 'constrainTo',
852
+ 'container',
853
+ 'containValues',
854
+ 'contentElementCls',
855
+ 'dataField',
856
+ 'defaultBindProperty',
857
+ 'detectCSSCompatibilityIssues',
858
+ 'dock',
859
+ 'draggable',
860
+ 'elementAttributes',
861
+ 'field',
862
+ 'filterId',
863
+ 'floating',
864
+ 'hideAnimation',
865
+ 'highlightExternalChange',
866
+ 'hint',
867
+ 'hintHtml',
868
+ 'ignoreParentReadOnly',
869
+ 'inline',
870
+ 'inputAlign',
871
+ 'inputAttributes',
872
+ 'inputTag',
873
+ 'inputType',
874
+ 'inputWidth',
875
+ 'internalFilter',
876
+ 'keyStrokeChangeDelay',
877
+ 'labelCls',
878
+ 'labelPosition',
879
+ 'labels',
880
+ 'labelWidth',
881
+ 'listeners',
882
+ 'localeClass',
883
+ 'localizable',
884
+ 'localizableProperties',
885
+ 'maskDefaults',
886
+ 'masked',
887
+ 'maxLength',
888
+ 'minLength',
889
+ 'monitorResize',
890
+ 'name',
891
+ 'owner',
892
+ 'positioned',
893
+ 'preventTooltipOnTouch',
894
+ 'relayStoreEvents',
895
+ 'revertOnEscape',
896
+ 'ripple',
897
+ 'rootElement',
898
+ 'scrollAction',
899
+ 'showAnimation',
900
+ 'showTooltipWhenDisabled',
901
+ 'skipValidation',
902
+ 'spellCheck',
903
+ 'tab',
904
+ 'tabIndex',
905
+ 'taskBoard',
906
+ 'textAlign',
907
+ 'title',
908
+ 'type',
909
+ 'ui',
910
+ 'validateOnInput',
911
+ 'weight'
912
+ ];
913
+
914
+ static propertyConfigNames = [
915
+ 'alignSelf',
916
+ 'appendTo',
917
+ 'badge',
918
+ 'callOnFunctions',
919
+ 'catchEventHandlerExceptions',
920
+ 'cls',
921
+ 'column',
922
+ 'dataset',
923
+ 'disabled',
924
+ 'editable',
925
+ 'extraData',
926
+ 'flex',
927
+ 'height',
928
+ 'hidden',
929
+ 'id',
930
+ 'insertBefore',
931
+ 'insertFirst',
932
+ 'keyMap',
933
+ 'label',
934
+ 'margin',
935
+ 'maxHeight',
936
+ 'maximizeOnMobile',
937
+ 'maxWidth',
938
+ 'minHeight',
939
+ 'minWidth',
940
+ 'onAction',
941
+ 'onBeforeDestroy',
942
+ 'onBeforeHide',
943
+ 'onBeforeShow',
944
+ 'onCatchAll',
945
+ 'onChange',
946
+ 'onClear',
947
+ 'onDestroy',
948
+ 'onElementCreated',
949
+ 'onFocusIn',
950
+ 'onFocusOut',
951
+ 'onHide',
952
+ 'onInput',
953
+ 'onPaint',
954
+ 'onReadOnly',
955
+ 'onRecompose',
956
+ 'onResize',
957
+ 'onShow',
958
+ 'onTrigger',
959
+ 'placeholder',
960
+ 'readOnly',
961
+ 'rendition',
962
+ 'required',
963
+ 'rtl',
964
+ 'showRequiredIndicator',
965
+ 'span',
966
+ 'tooltip',
967
+ 'triggers',
968
+ 'value',
969
+ 'width',
970
+ 'x',
971
+ 'y'
972
+ ];
973
+
974
+ static propertyNames = [
975
+ 'anchorSize',
976
+ 'content',
977
+ 'focusVisible',
978
+ 'formula',
979
+ 'html',
980
+ 'input',
981
+ 'parent',
982
+ 'scrollable'
983
+ ];
984
+
985
+ // Component instance
986
+ instance!: ColumnFilterField;
987
+
988
+ // Component element
989
+ element! : HTMLElement;
990
+
991
+ componentDidMount(): void {
992
+ this.instance = createWidget(this);
993
+ }
994
+
995
+ componentWillUnmount(): void {
996
+ // @ts-ignore
997
+ this.instance?.destroy?.();
998
+ }
999
+
1000
+ /**
1001
+ * Component about to be updated, from changing a prop using state.
1002
+ * React to it depending on what changed and prevent react from re-rendering our component.
1003
+ * @param nextProps
1004
+ * @param nextState
1005
+ * @returns {boolean}
1006
+ */
1007
+ shouldComponentUpdate(nextProps: Readonly<BryntumColumnFilterFieldProps>, nextState: Readonly<{}>): boolean {
1008
+ return shouldComponentUpdate(this, nextProps, nextState);
1009
+ }
1010
+
1011
+ render(): React.ReactNode {
1012
+
1013
+ const className = `b-react-column-filter-field-container`;
1014
+ return (
1015
+ <div className={className} ref={(element) => (this.element = element!)}></div>
1016
+ );
1017
+
1018
+ }
1019
+ }