@bryntum/taskboard-vue-3-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 (138) hide show
  1. package/README.md +53 -0
  2. package/lib/chunks/-hGMKDT-.js +279 -0
  3. package/lib/chunks/-hGMKDT-.js.map +1 -0
  4. package/lib/chunks/2MugSr70.js +382 -0
  5. package/lib/chunks/2MugSr70.js.map +1 -0
  6. package/lib/chunks/2RRMFKHJ.js +306 -0
  7. package/lib/chunks/2RRMFKHJ.js.map +1 -0
  8. package/lib/chunks/B13cxldI.js +279 -0
  9. package/lib/chunks/B13cxldI.js.map +1 -0
  10. package/lib/chunks/B32q-UcS.js +277 -0
  11. package/lib/chunks/B32q-UcS.js.map +1 -0
  12. package/lib/chunks/BP22d7g9.js +279 -0
  13. package/lib/chunks/BP22d7g9.js.map +1 -0
  14. package/lib/chunks/BS3VqRMT.js +382 -0
  15. package/lib/chunks/BS3VqRMT.js.map +1 -0
  16. package/lib/chunks/BUqJrgcM.js +279 -0
  17. package/lib/chunks/BUqJrgcM.js.map +1 -0
  18. package/lib/chunks/BZslhDhE.js +320 -0
  19. package/lib/chunks/BZslhDhE.js.map +1 -0
  20. package/lib/chunks/BkWE4YMJ.js +295 -0
  21. package/lib/chunks/BkWE4YMJ.js.map +1 -0
  22. package/lib/chunks/C8Ls3rwH.js +267 -0
  23. package/lib/chunks/C8Ls3rwH.js.map +1 -0
  24. package/lib/chunks/CIGedStG.js +320 -0
  25. package/lib/chunks/CIGedStG.js.map +1 -0
  26. package/lib/chunks/CPFlJHkf.js +313 -0
  27. package/lib/chunks/CPFlJHkf.js.map +1 -0
  28. package/lib/chunks/CQPtNMld.js +549 -0
  29. package/lib/chunks/CQPtNMld.js.map +1 -0
  30. package/lib/chunks/CaXNovsW.js +237 -0
  31. package/lib/chunks/CaXNovsW.js.map +1 -0
  32. package/lib/chunks/ComLVoEW.js +384 -0
  33. package/lib/chunks/ComLVoEW.js.map +1 -0
  34. package/lib/chunks/DO9RkP9d.js +547 -0
  35. package/lib/chunks/DO9RkP9d.js.map +1 -0
  36. package/lib/chunks/DT9dLbVS.js +382 -0
  37. package/lib/chunks/DT9dLbVS.js.map +1 -0
  38. package/lib/chunks/imR2_gHl.js +316 -0
  39. package/lib/chunks/imR2_gHl.js.map +1 -0
  40. package/lib/chunks/ujL-F7eG.js +307 -0
  41. package/lib/chunks/ujL-F7eG.js.map +1 -0
  42. package/lib/chunks/wXZJ9FAX.js +384 -0
  43. package/lib/chunks/wXZJ9FAX.js.map +1 -0
  44. package/lib/components/BryntumColumnCombo.js +5 -0
  45. package/lib/components/BryntumColumnCombo.js.map +1 -0
  46. package/lib/components/BryntumColumnFilterField.js +5 -0
  47. package/lib/components/BryntumColumnFilterField.js.map +1 -0
  48. package/lib/components/BryntumColumnPickerButton.js +5 -0
  49. package/lib/components/BryntumColumnPickerButton.js.map +1 -0
  50. package/lib/components/BryntumColumnScrollButton.js +5 -0
  51. package/lib/components/BryntumColumnScrollButton.js.map +1 -0
  52. package/lib/components/BryntumProjectCombo.js +5 -0
  53. package/lib/components/BryntumProjectCombo.js.map +1 -0
  54. package/lib/components/BryntumResourcesCombo.js +5 -0
  55. package/lib/components/BryntumResourcesCombo.js.map +1 -0
  56. package/lib/components/BryntumSwimlaneCombo.js +5 -0
  57. package/lib/components/BryntumSwimlaneCombo.js.map +1 -0
  58. package/lib/components/BryntumSwimlaneFilterField.js +5 -0
  59. package/lib/components/BryntumSwimlaneFilterField.js.map +1 -0
  60. package/lib/components/BryntumSwimlanePickerButton.js +5 -0
  61. package/lib/components/BryntumSwimlanePickerButton.js.map +1 -0
  62. package/lib/components/BryntumSwimlaneScrollButton.js +5 -0
  63. package/lib/components/BryntumSwimlaneScrollButton.js.map +1 -0
  64. package/lib/components/BryntumTagCombo.js +5 -0
  65. package/lib/components/BryntumTagCombo.js.map +1 -0
  66. package/lib/components/BryntumTaskBoard.js +5 -0
  67. package/lib/components/BryntumTaskBoard.js.map +1 -0
  68. package/lib/components/BryntumTaskBoardBase.js +5 -0
  69. package/lib/components/BryntumTaskBoardBase.js.map +1 -0
  70. package/lib/components/BryntumTaskBoardFieldFilterPicker.js +5 -0
  71. package/lib/components/BryntumTaskBoardFieldFilterPicker.js.map +1 -0
  72. package/lib/components/BryntumTaskBoardFieldFilterPickerGroup.js +5 -0
  73. package/lib/components/BryntumTaskBoardFieldFilterPickerGroup.js.map +1 -0
  74. package/lib/components/BryntumTaskBoardProjectModel.js +5 -0
  75. package/lib/components/BryntumTaskBoardProjectModel.js.map +1 -0
  76. package/lib/components/BryntumTaskColorCombo.js +5 -0
  77. package/lib/components/BryntumTaskColorCombo.js.map +1 -0
  78. package/lib/components/BryntumTaskFilterField.js +5 -0
  79. package/lib/components/BryntumTaskFilterField.js.map +1 -0
  80. package/lib/components/BryntumTodoListField.js +5 -0
  81. package/lib/components/BryntumTodoListField.js.map +1 -0
  82. package/lib/components/BryntumUndoRedo.js +5 -0
  83. package/lib/components/BryntumUndoRedo.js.map +1 -0
  84. package/lib/components/BryntumZoomSlider.js +5 -0
  85. package/lib/components/BryntumZoomSlider.js.map +1 -0
  86. package/lib/helper/WrapperHelper.js +291 -0
  87. package/lib/helper/WrapperHelper.js.map +1 -0
  88. package/lib/index.d.ts +5 -0
  89. package/lib/index.js +45 -0
  90. package/lib/index.js.map +1 -0
  91. package/license.pdf +0 -0
  92. package/licenses.md +310 -0
  93. package/package.json +27 -0
  94. package/src/components/BryntumColumnCombo.vue +1346 -0
  95. package/src/components/BryntumColumnComboProps.ts +846 -0
  96. package/src/components/BryntumColumnFilterField.vue +1120 -0
  97. package/src/components/BryntumColumnFilterFieldProps.ts +664 -0
  98. package/src/components/BryntumColumnPickerButton.vue +997 -0
  99. package/src/components/BryntumColumnPickerButtonProps.ts +563 -0
  100. package/src/components/BryntumColumnScrollButton.vue +997 -0
  101. package/src/components/BryntumColumnScrollButtonProps.ts +563 -0
  102. package/src/components/BryntumProjectCombo.vue +1347 -0
  103. package/src/components/BryntumProjectComboProps.ts +846 -0
  104. package/src/components/BryntumResourcesCombo.vue +1345 -0
  105. package/src/components/BryntumResourcesComboProps.ts +845 -0
  106. package/src/components/BryntumSwimlaneCombo.vue +1345 -0
  107. package/src/components/BryntumSwimlaneComboProps.ts +845 -0
  108. package/src/components/BryntumSwimlaneFilterField.vue +1133 -0
  109. package/src/components/BryntumSwimlaneFilterFieldProps.ts +675 -0
  110. package/src/components/BryntumSwimlanePickerButton.vue +997 -0
  111. package/src/components/BryntumSwimlanePickerButtonProps.ts +563 -0
  112. package/src/components/BryntumSwimlaneScrollButton.vue +997 -0
  113. package/src/components/BryntumSwimlaneScrollButtonProps.ts +563 -0
  114. package/src/components/BryntumTagCombo.vue +1350 -0
  115. package/src/components/BryntumTagComboProps.ts +849 -0
  116. package/src/components/BryntumTaskBoard.vue +2432 -0
  117. package/src/components/BryntumTaskBoardBase.vue +2430 -0
  118. package/src/components/BryntumTaskBoardBaseProps.ts +976 -0
  119. package/src/components/BryntumTaskBoardFieldFilterPicker.vue +1021 -0
  120. package/src/components/BryntumTaskBoardFieldFilterPickerGroup.vue +1079 -0
  121. package/src/components/BryntumTaskBoardFieldFilterPickerGroupProps.ts +651 -0
  122. package/src/components/BryntumTaskBoardFieldFilterPickerProps.ts +612 -0
  123. package/src/components/BryntumTaskBoardProjectModel.vue +894 -0
  124. package/src/components/BryntumTaskBoardProjectModelProps.ts +409 -0
  125. package/src/components/BryntumTaskBoardProps.ts +977 -0
  126. package/src/components/BryntumTaskColorCombo.vue +1097 -0
  127. package/src/components/BryntumTaskColorComboProps.ts +642 -0
  128. package/src/components/BryntumTaskFilterField.vue +1133 -0
  129. package/src/components/BryntumTaskFilterFieldProps.ts +675 -0
  130. package/src/components/BryntumTodoListField.vue +1087 -0
  131. package/src/components/BryntumTodoListFieldProps.ts +636 -0
  132. package/src/components/BryntumUndoRedo.vue +957 -0
  133. package/src/components/BryntumUndoRedoProps.ts +570 -0
  134. package/src/components/BryntumZoomSlider.vue +910 -0
  135. package/src/components/BryntumZoomSliderProps.ts +530 -0
  136. package/src/helper/WrapperHelper.ts +573 -0
  137. package/src/index.ts +46 -0
  138. package/src/vite-env.d.ts +1 -0
@@ -0,0 +1,664 @@
1
+ import type { AlignSpec, Base, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Rectangle, TabConfig, TooltipConfig, Widget } from '@bryntum/core-thin';
2
+ import type { ColumnFilterFieldListeners, TaskBoardContainerItemConfig, TaskBoard } from '@bryntum/taskboard-thin';
3
+
4
+ export declare type BryntumColumnFilterFieldProps = {
5
+ // Configs
6
+ /**
7
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
8
+ * content will be placed inside this element.
9
+ * ...
10
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-adopt)
11
+ */
12
+ adopt ? : HTMLElement|string
13
+ /**
14
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
15
+ * ...
16
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-align)
17
+ */
18
+ align ? : AlignSpec|string
19
+ /**
20
+ * 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
21
+ * flexbox layout. This config allows you to set this widget's
22
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
23
+ */
24
+ alignSelf ? : string
25
+ /**
26
+ * *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).*
27
+ * `true` to show a connector arrow pointing to the align target.
28
+ */
29
+ anchor ? : Boolean
30
+ /**
31
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
32
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element).
33
+ */
34
+ appendTo ? : HTMLElement|string
35
+ /**
36
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
37
+ * into an element which will be linked using the `aria-describedby` attribute.
38
+ * ...
39
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ariaDescription)
40
+ */
41
+ ariaDescription ? : string
42
+ /**
43
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
44
+ * the `aria-label` attribute.
45
+ * ...
46
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ariaLabel)
47
+ */
48
+ ariaLabel ? : string
49
+ /**
50
+ * Sets the native `autocomplete` property of the underlying input element. For more information, please refer to
51
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
52
+ */
53
+ autoComplete ? : string
54
+ /**
55
+ * Specify `true` to auto select field contents on focus
56
+ */
57
+ autoSelect ? : Boolean
58
+ /**
59
+ * Initial text to show in badge.
60
+ */
61
+ badge ? : string
62
+ /**
63
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
64
+ * hierarchy when triggered.
65
+ * ...
66
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-bubbleEvents)
67
+ */
68
+ bubbleEvents ? : object
69
+ /**
70
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
71
+ * ...
72
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-callOnFunctions)
73
+ */
74
+ callOnFunctions ? : Boolean
75
+ /**
76
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
77
+ * application state is undefined. Code which follows the event handler will *not* be executed.
78
+ * ...
79
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-catchEventHandlerExceptions)
80
+ */
81
+ catchEventHandlerExceptions ? : Boolean
82
+ /**
83
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
84
+ * Set to `true` to centre the Widget in browser viewport space.
85
+ */
86
+ centered ? : Boolean
87
+ /**
88
+ * 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
89
+ * 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
90
+ * configures the `clear` [trigger](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-triggers).
91
+ */
92
+ clearable ? : Boolean|FieldTriggerConfig
93
+ /**
94
+ * Custom CSS classes to add to element.
95
+ * May be specified as a space separated string, or as an object in which property names
96
+ * with truthy values are used as the class names:
97
+ * ...
98
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-cls)
99
+ */
100
+ cls ? : string|object
101
+ /**
102
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
103
+ * `style` block.
104
+ * ...
105
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-color)
106
+ */
107
+ color ? : string
108
+ /**
109
+ * Programmatic control over which column to start in when used in a grid layout.
110
+ */
111
+ column ? : number
112
+ config ? : object
113
+ /**
114
+ * *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).*
115
+ * Element, Widget or Rectangle to which this Widget is constrained.
116
+ */
117
+ constrainTo ? : HTMLElement|Widget|Rectangle
118
+ /**
119
+ * The configuration for additional items associated to this field. This is typically used to add contextual
120
+ * fields related to a [checkbox](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
121
+ * these classes for examples of nested fields.
122
+ * ...
123
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-container)
124
+ */
125
+ container ? : Record<string, TaskBoardContainerItemConfig>|TaskBoardContainerItemConfig[]|FieldContainerConfig|FieldContainer
126
+ /**
127
+ * The config controls how the value of nested items are handled when a parent container gets or sets its
128
+ * [values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
129
+ * ...
130
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-containValues)
131
+ * @param {Core.widget.Field} field Field instance
132
+ * @returns {boolean}
133
+ */
134
+ containValues ? : Boolean|string|((field: Field) => Boolean)
135
+ /**
136
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
137
+ * May be specified as a space separated string, or as an object in which property names
138
+ * with truthy values are used as the class names:
139
+ * ...
140
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-contentElementCls)
141
+ */
142
+ contentElementCls ? : string|object
143
+ /**
144
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
145
+ * field on the expanded record to use for populating this widget's store (if applicable)
146
+ */
147
+ dataField ? : string
148
+ /**
149
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
150
+ */
151
+ dataset ? : Record<string, string>
152
+ /**
153
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
154
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
155
+ */
156
+ defaultBindProperty ? : string
157
+ /**
158
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
159
+ * ...
160
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-detectCSSCompatibilityIssues)
161
+ */
162
+ detectCSSCompatibilityIssues ? : Boolean
163
+ /**
164
+ * 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
165
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
166
+ * ...
167
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-disabled)
168
+ */
169
+ disabled ? : Boolean|'inert'
170
+ /**
171
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel)
172
+ * [strips collection](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
173
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
174
+ * body. Such widgets are called "edge strips".
175
+ * ...
176
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-dock)
177
+ */
178
+ dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
179
+ /**
180
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
181
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
182
+ * property which controls when a drag should start.
183
+ * ...
184
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-draggable)
185
+ */
186
+ draggable ? : Boolean|{
187
+ handleSelector?: string
188
+ }
189
+ /**
190
+ * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
191
+ * [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
192
+ * but not to type one in the field.
193
+ * ...
194
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-editable)
195
+ */
196
+ editable ? : Boolean
197
+ /**
198
+ * An object specifying attributes to assign to the root element of this widget.
199
+ * Set `null` value to attribute to remove it.
200
+ * ...
201
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-elementAttributes)
202
+ */
203
+ elementAttributes ? : Record<string, string|null>
204
+ extraData ? : any
205
+ /**
206
+ * The ColumnModel field name to filter by, defaults to `'text'`.
207
+ */
208
+ field ? : string
209
+ /**
210
+ * In case the `filterId` that is used in the store needs to be referenced elsewhere, it can be configured.
211
+ * 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.
212
+ * If no value is configured, an internal ID will be generated.
213
+ * ...
214
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-filterId)
215
+ */
216
+ filterId ? : string|Symbol
217
+ /**
218
+ * 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
219
+ * flexbox layout. This config allows you to set this widget's
220
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
221
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
222
+ * numeric-only values are interpreted as the `flex-grow` value.
223
+ */
224
+ flex ? : number|string
225
+ /**
226
+ * Set to `true` to move the widget out of the document flow and position it
227
+ * absolutely in browser viewport space.
228
+ */
229
+ floating ? : Boolean
230
+ /**
231
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
232
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
233
+ * cases this config is convenient.
234
+ */
235
+ height ? : string|number
236
+ /**
237
+ * Configure with true to make widget initially hidden.
238
+ */
239
+ hidden ? : Boolean
240
+ /**
241
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
242
+ * ...
243
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hideAnimation)
244
+ */
245
+ hideAnimation ? : Boolean|object
246
+ /**
247
+ * Specify `true` to highlight field after external value changes
248
+ */
249
+ highlightExternalChange ? : Boolean
250
+ /**
251
+ * An optional string to display inside the input field as an overlay. This can be useful for displaying
252
+ * a field's units.
253
+ * ...
254
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hint)
255
+ * @param {object} data A data object
256
+ * @param {Core.widget.Field} data.source A reference to the field instance
257
+ * @param {any} data.value The current value of the field
258
+ * @returns {string}
259
+ */
260
+ hint ? : string|((data: { source: Field, value: any }) => string)
261
+ /**
262
+ * 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.
263
+ * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
264
+ * encode such data (see [encodeHtml](https://bryntum.com/products/taskboard/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
265
+ * ...
266
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-hintHtml)
267
+ * @param {object} data A data object
268
+ * @param {Core.widget.Field} data.source A reference to the field instance
269
+ * @param {any} data.value The current value of the field
270
+ * @returns {string}
271
+ */
272
+ hintHtml ? : string|((data: { source: Field, value: any }) => string)
273
+ /**
274
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
275
+ */
276
+ id ? : string
277
+ /**
278
+ * Determines if the widgets read-only state should be controlled by its parent.
279
+ * ...
280
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ignoreParentReadOnly)
281
+ */
282
+ ignoreParentReadOnly ? : Boolean
283
+ /**
284
+ * Set this config to `true` to always display items horizontally along with this field. This assigns an
285
+ * [hbox](https://bryntum.com/products/taskboard/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
286
+ * [container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#config-container).
287
+ * ...
288
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-inline)
289
+ */
290
+ inline ? : Boolean
291
+ /**
292
+ * Text alignment for the input field.
293
+ */
294
+ inputAlign ? : string
295
+ /**
296
+ * Sets custom attributes of the underlying input element. For more information, please refer to
297
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
298
+ */
299
+ inputAttributes ? : Record<string, string>
300
+ /**
301
+ * If you need to use something else than a default `input` element, as the input element, provide the tag
302
+ * name here. Please note that this is used for advanced usage only, for example when using WebComponents
303
+ * (custom elements), and that the configured element must fulfil the same contract as a regular input
304
+ * element.
305
+ */
306
+ inputTag ? : string
307
+ /**
308
+ * Sets the `type` attribute of the underlying input element (password, hidden, date, color, etc.).
309
+ */
310
+ inputType ? : string
311
+ /**
312
+ * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
313
+ * triggers. If a number is specified, `px` will be used.
314
+ */
315
+ inputWidth ? : string|number
316
+ /**
317
+ * 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.
318
+ */
319
+ insertBefore ? : HTMLElement|string
320
+ /**
321
+ * 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.
322
+ */
323
+ insertFirst ? : HTMLElement|string
324
+ /**
325
+ * 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).
326
+ * This prevents the filter from being removed when [Store.clearFilters()](https://bryntum.com/products/taskboard/docs/api/Core/data/Store#function-clearFilters)
327
+ * is called.
328
+ */
329
+ internalFilter ? : Boolean
330
+ /**
331
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
332
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
333
+ * are the name of the instance method to call when the keystroke is received.
334
+ * ...
335
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-keyMap)
336
+ */
337
+ keyMap ? : Record<string, KeyMapConfig>
338
+ /**
339
+ * The delay in milliseconds to wait after the last keystroke before triggering a change event.
340
+ * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
341
+ * immediate feedback, change will still be triggered on blur).
342
+ * ...
343
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-keyStrokeChangeDelay)
344
+ */
345
+ keyStrokeChangeDelay ? : number
346
+ /**
347
+ * Label, defaults to a localized version of `'Filter columns'`.
348
+ * ...
349
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-label)
350
+ */
351
+ label ? : string
352
+ /**
353
+ * 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)
354
+ */
355
+ labelCls ? : string|object
356
+ /**
357
+ * Label position, either 'before' the field or 'above' the field
358
+ * ...
359
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-labelPosition)
360
+ */
361
+ labelPosition ? : 'before'|'above'|null
362
+ /**
363
+ * The labels to add either before or after the input field.
364
+ * Each label may have the following properties:
365
+ * ...
366
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-labels)
367
+ */
368
+ labels ? : object[]
369
+ /**
370
+ * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
371
+ */
372
+ labelWidth ? : string|number
373
+ /**
374
+ * The listener set for this object.
375
+ * ...
376
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-listeners)
377
+ */
378
+ listeners ? : ColumnFilterFieldListeners
379
+ /**
380
+ * A class translations of which are used for translating this entity.
381
+ * This is often used when translations of an item are defined on its container class.
382
+ * For example:
383
+ * ...
384
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-localeClass)
385
+ */
386
+ localeClass ? : typeof Base
387
+ /**
388
+ * Set to `false` to disable localization of this object.
389
+ */
390
+ localizable ? : Boolean
391
+ /**
392
+ * List of properties which values should be translated automatically upon a locale applying.
393
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
394
+ * you could use 'localeKey' meta configuration.
395
+ * Example:
396
+ * ...
397
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-localizableProperties)
398
+ */
399
+ localizableProperties ? : string[]
400
+ /**
401
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
402
+ * numeric-only values are interpreted as pixels.
403
+ */
404
+ margin ? : number|string
405
+ /**
406
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) created for the
407
+ * [masked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
408
+ * values.
409
+ */
410
+ maskDefaults ? : MaskConfig
411
+ /**
412
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
413
+ * [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object.
414
+ */
415
+ masked ? : Boolean|string|MaskConfig
416
+ /**
417
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
418
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
419
+ */
420
+ maxHeight ? : string|number
421
+ /**
422
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
423
+ * ...
424
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-maximizeOnMobile)
425
+ */
426
+ maximizeOnMobile ? : number|string
427
+ /**
428
+ * The max number of characters for the input field
429
+ */
430
+ maxLength ? : number
431
+ /**
432
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
433
+ * like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
434
+ */
435
+ maxWidth ? : string|number
436
+ /**
437
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
438
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
439
+ */
440
+ minHeight ? : string|number
441
+ /**
442
+ * The min number of characters for the input field
443
+ */
444
+ minLength ? : number
445
+ /**
446
+ * The elements minWidth. 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
+ minWidth ? : string|number
450
+ /**
451
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
452
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
453
+ * layout.
454
+ * ...
455
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-monitorResize)
456
+ */
457
+ monitorResize ? : Boolean|{
458
+ immediate?: Boolean
459
+ }
460
+ /**
461
+ * Name of the field which is used as a key to get/set values from/to the field.
462
+ * Used prior to [ref](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
463
+ * [Container.values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
464
+ * ...
465
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-name)
466
+ */
467
+ name ? : string
468
+ /**
469
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
470
+ * [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
471
+ * the owner is <strong>always</strong> the encapsulating Container.
472
+ * ...
473
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-owner)
474
+ */
475
+ owner ? : Widget|any
476
+ /**
477
+ * Text to display in empty field.
478
+ */
479
+ placeholder ? : string
480
+ /**
481
+ * 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
482
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
483
+ * widget's [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
484
+ * ...
485
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-positioned)
486
+ */
487
+ positioned ? : Boolean
488
+ /**
489
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
490
+ * menu on click etc, since the tooltip would be displayed at the same time.
491
+ */
492
+ preventTooltipOnTouch ? : Boolean
493
+ /**
494
+ * Makes the field unmodifiable by user action. The input area is not editable, and triggers
495
+ * are unresponsive.
496
+ * ...
497
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-readOnly)
498
+ */
499
+ readOnly ? : Boolean
500
+ relayStoreEvents ? : Boolean
501
+ /**
502
+ * Predefined style to use for the field. Possible values are:
503
+ * ...
504
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-rendition)
505
+ */
506
+ rendition ? : 'outlined'|'filled'|string
507
+ /**
508
+ * Configure as `true` to indicate that a `null` field value is to be marked as invalid. This will
509
+ * optionally append a * to the field label if [showRequiredIndicator](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
510
+ */
511
+ required ? : Boolean
512
+ /**
513
+ * 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
514
+ * the `ESCAPE` key after editing the field will revert the field to the value it had when
515
+ * 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)
516
+ * behaviour will be activated.
517
+ */
518
+ revertOnEscape ? : Boolean
519
+ /**
520
+ * Configure as `true` to have the component display a translucent ripple when its
521
+ * [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
522
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
523
+ * ...
524
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ripple)
525
+ */
526
+ ripple ? : Boolean|{
527
+ delegate?: string
528
+ color?: string
529
+ radius?: number
530
+ clip?: string
531
+ }
532
+ /**
533
+ * 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`
534
+ */
535
+ rootElement ? : ShadowRoot|HTMLElement
536
+ /**
537
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
538
+ * ...
539
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-rtl)
540
+ */
541
+ rtl ? : Boolean
542
+ /**
543
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
544
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
545
+ */
546
+ scrollAction ? : 'hide'|'realign'|null
547
+ /**
548
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
549
+ * ...
550
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-showAnimation)
551
+ */
552
+ showAnimation ? : Boolean|object
553
+ /**
554
+ * `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).
555
+ */
556
+ showRequiredIndicator ? : string
557
+ /**
558
+ * 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)
559
+ */
560
+ showTooltipWhenDisabled ? : Boolean
561
+ /**
562
+ * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
563
+ * to the user).
564
+ */
565
+ skipValidation ? : Boolean
566
+ /**
567
+ * Programmatic control over how many columns to span when used in a grid layout.
568
+ */
569
+ span ? : number
570
+ /**
571
+ * Sets the native `spellcheck` property of the underlying input element. For more information, please refer to
572
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck)
573
+ */
574
+ spellCheck ? : Boolean
575
+ /**
576
+ * 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
577
+ * [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
578
+ * this widget:
579
+ * ...
580
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tab)
581
+ */
582
+ tab ? : Boolean|TabConfig
583
+ /**
584
+ * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
585
+ * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
586
+ * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
587
+ * to the element programmatically.
588
+ * ...
589
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tabIndex)
590
+ */
591
+ tabIndex ? : number
592
+ /**
593
+ * Auto detected when used within a TaskBoard. If you add the widget elsewhere, it will try to find an instance
594
+ * of TaskBoard on page. If that fails you have to supply this config to connect it to a TaskBoard manually.
595
+ * ...
596
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-taskBoard)
597
+ */
598
+ taskBoard ? : TaskBoard
599
+ /**
600
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
601
+ * ...
602
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-textAlign)
603
+ */
604
+ textAlign ? : 'left'|'center'|'right'|'start'|'end'
605
+ /**
606
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
607
+ */
608
+ title ? : string
609
+ /**
610
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
611
+ * ...
612
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-tooltip)
613
+ */
614
+ tooltip ? : string|TooltipConfig|null
615
+ /**
616
+ * The triggers to add either before or after the input field. Each property name is the reference by which
617
+ * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
618
+ * ...
619
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-triggers)
620
+ */
621
+ triggers ? : Record<string, FieldTriggerConfig>|Record<string, Widget>
622
+ type ? : 'columnfilterfield'
623
+ /**
624
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
625
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
626
+ * values are used as the class names.
627
+ * ...
628
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-ui)
629
+ */
630
+ ui ? : string|object
631
+ /**
632
+ * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
633
+ * or similar.
634
+ */
635
+ validateOnInput ? : Boolean
636
+ /**
637
+ * Default value
638
+ */
639
+ value ? : string
640
+ /**
641
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container).
642
+ * Higher weights go further down.
643
+ */
644
+ weight ? : number
645
+ /**
646
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
647
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
648
+ * this config is convenient.
649
+ */
650
+ width ? : string|number
651
+ /**
652
+ * The x position for the widget.
653
+ * ...
654
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-x)
655
+ */
656
+ x ? : number
657
+ /**
658
+ * The y position for the widget.
659
+ * ...
660
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/widget/ColumnFilterField#config-y)
661
+ */
662
+ y ? : number
663
+
664
+ }