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