@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,976 @@
1
+ import type { AlignSpec, Base, BryntumScrollOptions, DomConfig, KeyMapConfig, Mask, MaskConfig, Model, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Rectangle, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, Widget } from '@bryntum/core-thin';
2
+ import type { AssignmentModel, AssignmentModelConfig, CardSize, ColumnDrag, ColumnDragConfig, ColumnFilter, ColumnFilterConfig, ColumnHeaderMenu, ColumnHeaderMenuConfig, ColumnLock, ColumnLockConfig, ColumnModel, ColumnModelConfig, ColumnRename, ColumnRenameConfig, ColumnResize, ColumnResizeConfig, ColumnSort, ColumnSortConfig, ColumnToolbars, ColumnToolbarsConfig, TaskBoardContainerItemConfig, FilterBar, FilterBarConfig, ProjectModel, ProjectModelConfig, ResourceModel, ResourceModelConfig, SimpleTaskEdit, SimpleTaskEditConfig, SwimlaneDrag, SwimlaneDragConfig, SwimlaneModel, SwimlaneModelConfig, TaskBoardBaseListeners, TaskDrag, TaskDragConfig, TaskDragSelect, TaskDragSelectConfig, TaskEdit, TaskEditConfig, TaskItemOptions, TaskMenu, TaskMenuConfig, TaskModel, TaskModelConfig, TaskTooltip, TaskTooltipConfig } from '@bryntum/taskboard-thin';
3
+
4
+ export declare type BryntumTaskBoardBaseProps = {
5
+ // Configs
6
+ /**
7
+ * The name of the event that should activate a task and trigger editing (if an editing feature is active).
8
+ * Available options are: 'taskClick', 'taskDblClick' or null (disable)
9
+ */
10
+ activateTaskEvent ? : 'taskClick'|'taskDblClick'|null
11
+ /**
12
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
13
+ * content will be placed inside this element.
14
+ * ...
15
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-adopt)
16
+ */
17
+ adopt ? : HTMLElement|string
18
+ /**
19
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
20
+ * ...
21
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-align)
22
+ */
23
+ align ? : AlignSpec|string
24
+ /**
25
+ * 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
26
+ * flexbox layout. This config allows you to set this widget's
27
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
28
+ */
29
+ alignSelf ? : string
30
+ /**
31
+ * *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).*
32
+ * `true` to show a connector arrow pointing to the align target.
33
+ */
34
+ anchor ? : Boolean
35
+ /**
36
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
37
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element).
38
+ */
39
+ appendTo ? : HTMLElement|string
40
+ /**
41
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
42
+ * into an element which will be linked using the `aria-describedby` attribute.
43
+ * ...
44
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ariaDescription)
45
+ */
46
+ ariaDescription ? : string
47
+ /**
48
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
49
+ * the `aria-label` attribute.
50
+ * ...
51
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ariaLabel)
52
+ */
53
+ ariaLabel ? : string
54
+ /**
55
+ * Inline [assignments](https://bryntum.com/products/scheduler/docs#Scheduler/model/AssignmentModel), will be loaded into an internally created
56
+ * [AssignmentStore](https://bryntum.com/products/scheduler/docs#Scheduler/data/AssignmentStore) as a part of a [project](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel).
57
+ */
58
+ assignments ? : AssignmentModel[]|object[]|AssignmentModelConfig[]
59
+ /**
60
+ * Set to `true` to auto generate columns when [columns](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardColumns#config-columns) is undefined.
61
+ * ...
62
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-autoGenerateColumns)
63
+ */
64
+ autoGenerateColumns ? : Boolean
65
+ /**
66
+ * Set to `true` to auto generate swimlanes when [swimlanes](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardSwimlanes#config-swimlanes) is undefined.
67
+ * ...
68
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-autoGenerateSwimlanes)
69
+ */
70
+ autoGenerateSwimlanes ? : Boolean
71
+ /**
72
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar),
73
+ * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips).
74
+ * ...
75
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bbar)
76
+ */
77
+ bbar ? : (TaskBoardContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
78
+ /**
79
+ * Custom CSS classes to add to the panel's body element.
80
+ * ...
81
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bodyCls)
82
+ */
83
+ bodyCls ? : string|object
84
+ /**
85
+ * Items to add to each card's body.
86
+ * ...
87
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bodyItems)
88
+ */
89
+ bodyItems ? : Record<string, TaskItemOptions>
90
+ /**
91
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
92
+ * hierarchy when triggered.
93
+ * ...
94
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bubbleEvents)
95
+ */
96
+ bubbleEvents ? : object
97
+ /**
98
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
99
+ * ...
100
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-callOnFunctions)
101
+ */
102
+ callOnFunctions ? : Boolean
103
+ /**
104
+ * An array of [CardSize](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/ResponsiveCards#typedef-CardSize) objects to use as responsive levels based on card widths.
105
+ * ...
106
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cardSizes)
107
+ */
108
+ cardSizes ? : CardSize
109
+ /**
110
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
111
+ * application state is undefined. Code which follows the event handler will *not* be executed.
112
+ * ...
113
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-catchEventHandlerExceptions)
114
+ */
115
+ catchEventHandlerExceptions ? : Boolean
116
+ /**
117
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
118
+ * Set to `true` to centre the Widget in browser viewport space.
119
+ */
120
+ centered ? : Boolean
121
+ /**
122
+ * Columns hold their tasks in stores chained off the project's task store. Filters applied to the project store
123
+ * are by default not applied to the column stores; they are only affected by their own filters. By configuring
124
+ * `chainFilters : true`, the filters from the project store will also be taken into account when filtering the
125
+ * columns.
126
+ * ...
127
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-chainFilters)
128
+ */
129
+ chainFilters ? : Boolean
130
+ /**
131
+ * Custom CSS classes to add to element.
132
+ * May be specified as a space separated string, or as an object in which property names
133
+ * with truthy values are used as the class names:
134
+ * ...
135
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cls)
136
+ */
137
+ cls ? : string|object
138
+ /**
139
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
140
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsible).
141
+ */
142
+ collapsed ? : Boolean
143
+ /**
144
+ * Specify `true` to hide the column title instead of rotating it on collapse.
145
+ * ...
146
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-collapseTitle)
147
+ */
148
+ collapseTitle ? : Boolean
149
+ /**
150
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsed).
151
+ * ...
152
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-collapsible)
153
+ */
154
+ collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
155
+ /**
156
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
157
+ * `style` block.
158
+ * ...
159
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-color)
160
+ */
161
+ color ? : string
162
+ /**
163
+ * Programmatic control over which column to start in when used in a grid layout.
164
+ */
165
+ column ? : number
166
+ /**
167
+ * Field on a task record used to determine which column the task belongs to.
168
+ * ...
169
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columnField)
170
+ */
171
+ columnField ? : string
172
+ /**
173
+ * Store containing the TaskBoard columns. A tasks [columnField](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardColumns#config-columnField) is matched against the `id` of a
174
+ * column to determine in which column it is displayed.
175
+ * ...
176
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columns)
177
+ */
178
+ columns ? : ColumnModel[]|ColumnModelConfig[]|string[]|Store|string|StoreConfig
179
+ /**
180
+ * A function which renders the text, HTML, or `DomConfig` object to show as the column title. If you provide a
181
+ * `DomConfig` object, it will replace the title element and you are responsible for styling it + laying it out.
182
+ * ...
183
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columnTitleRenderer)
184
+ * @param {object} renderData
185
+ * @param {TaskBoard.model.ColumnModel} columnRecord The column instance
186
+ * @returns {string,DomConfig}
187
+ */
188
+ columnTitleRenderer ? : (renderData: object, columnRecord: ColumnModel) => string|DomConfig
189
+ config ? : object
190
+ /**
191
+ * *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).*
192
+ * Element, Widget or Rectangle to which this Widget is constrained.
193
+ */
194
+ constrainTo ? : HTMLElement|Widget|Rectangle
195
+ /**
196
+ * Initial CSS variables to set.
197
+ * ...
198
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-css)
199
+ */
200
+ css ? : Record<string, string>
201
+ /**
202
+ * CSS variable prefix, appended to the keys used in [css](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-css).
203
+ * ...
204
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cssVarPrefix)
205
+ */
206
+ cssVarPrefix ? : string
207
+ /**
208
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
209
+ * field on the expanded record to use for populating this widget's store (if applicable)
210
+ */
211
+ dataField ? : string
212
+ /**
213
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
214
+ */
215
+ dataset ? : Record<string, string>
216
+ /**
217
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
218
+ * ...
219
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-detectCSSCompatibilityIssues)
220
+ */
221
+ detectCSSCompatibilityIssues ? : Boolean
222
+ /**
223
+ * 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
224
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
225
+ * ...
226
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-disabled)
227
+ */
228
+ disabled ? : Boolean|'inert'
229
+ /**
230
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel)
231
+ * [strips collection](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
232
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
233
+ * body. Such widgets are called "edge strips".
234
+ * ...
235
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-dock)
236
+ */
237
+ dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
238
+ /**
239
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
240
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
241
+ * property which controls when a drag should start.
242
+ * ...
243
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-draggable)
244
+ */
245
+ draggable ? : Boolean|{
246
+ handleSelector?: string
247
+ }
248
+ /**
249
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
250
+ * ...
251
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-drawer)
252
+ * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
253
+ * @param {string,number} size The size of the drawer in its collapsible axis.
254
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
255
+ * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
256
+ * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
257
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
258
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
259
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
260
+ */
261
+ drawer ? : Boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: Boolean, autoClose: { mousedown?: Boolean|string, focusout?: Boolean|string, mouseout?: string }, autoCloseDelay?: number}
262
+ /**
263
+ * Whether to draw cards on scroll, or only when scrolling ends.
264
+ * ...
265
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-drawOnScroll)
266
+ */
267
+ drawOnScroll ? : Boolean
268
+ /**
269
+ * An object specifying attributes to assign to the root element of this widget.
270
+ * Set `null` value to attribute to remove it.
271
+ * ...
272
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-elementAttributes)
273
+ */
274
+ elementAttributes ? : Record<string, string|null>
275
+ extraData ? : any
276
+ /**
277
+ * 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
278
+ * flexbox layout. This config allows you to set this widget's
279
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
280
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
281
+ * numeric-only values are interpreted as the `flex-grow` value.
282
+ */
283
+ flex ? : number|string
284
+ /**
285
+ * Set to `true` to move the widget out of the document flow and position it
286
+ * absolutely in browser viewport space.
287
+ */
288
+ floating ? : Boolean
289
+ /**
290
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
291
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips).
292
+ * ...
293
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-footer)
294
+ */
295
+ footer ? : {
296
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
297
+ html?: string
298
+ cls?: string
299
+ }|string
300
+ /**
301
+ * Items to add to each card's footer.
302
+ * ...
303
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-footerItems)
304
+ */
305
+ footerItems ? : Record<string, TaskItemOptions>
306
+ /**
307
+ * The function is called for each task as part of the render loop, and is expected to return the height in
308
+ * pixels for the task. Using this function is only recommended when using partial virtualized rendering, see
309
+ * the [virtualize](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardVirtualization#config-virtualize) setting.
310
+ * ...
311
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-getTaskHeight)
312
+ * @param {TaskBoard.model.TaskModel} taskRecord The task record
313
+ * @returns {number} The height of the task in pixels
314
+ */
315
+ getTaskHeight ? : (taskRecord: TaskModel) => number
316
+ /**
317
+ * A config [object](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
318
+ * ...
319
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-header)
320
+ */
321
+ header ? : string|Boolean|PanelHeader
322
+ /**
323
+ * Items to add to each card's header.
324
+ * ...
325
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-headerItems)
326
+ */
327
+ headerItems ? : Record<string, TaskItemOptions>
328
+ /**
329
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
330
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
331
+ * cases this config is convenient.
332
+ */
333
+ height ? : string|number
334
+ /**
335
+ * Configure with true to make widget initially hidden.
336
+ */
337
+ hidden ? : Boolean
338
+ /**
339
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
340
+ * ...
341
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-hideAnimation)
342
+ */
343
+ hideAnimation ? : Boolean|object
344
+ /**
345
+ * By default, the header text is HTML-encoded. Set this flag to `false` disable this and allow html
346
+ * elements in the column headers. Can also be specified on a single
347
+ * [column](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-htmlEncodeHeaderText).
348
+ */
349
+ htmlEncodeHeaderText ? : Boolean
350
+ /**
351
+ * An icon to show before the [title](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
352
+ * [DomConfig](https://bryntum.com/products/taskboard/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
353
+ */
354
+ icon ? : string|DomConfig
355
+ /**
356
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
357
+ */
358
+ id ? : string
359
+ /**
360
+ * Determines if the widgets read-only state should be controlled by its parent.
361
+ * ...
362
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ignoreParentReadOnly)
363
+ */
364
+ ignoreParentReadOnly ? : Boolean
365
+ /**
366
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
367
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
368
+ * right, set this config to `'end'`.
369
+ * ...
370
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-inputFieldAlign)
371
+ */
372
+ inputFieldAlign ? : 'start'|'end'
373
+ /**
374
+ * 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.
375
+ */
376
+ insertBefore ? : HTMLElement|string
377
+ /**
378
+ * 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.
379
+ */
380
+ insertFirst ? : HTMLElement|string
381
+ /**
382
+ * A template method (empty by default) allowing you to control if a task can be selected or not.
383
+ * ...
384
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-isTaskSelectable)
385
+ * @param {TaskBoard.model.TaskModel} taskRecord The task record
386
+ * @returns {boolean} `true` if the task can be selected, otherwise `false`
387
+ */
388
+ isTaskSelectable ? : (taskRecord: TaskModel) => Boolean
389
+ /**
390
+ * See [Keyboard shortcuts](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoard#keyboard-shortcuts) for details
391
+ */
392
+ keyMap ? : Record<string, KeyMapConfig>
393
+ /**
394
+ * Convenience setting to use same label placement on all child widgets.
395
+ * ...
396
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-labelPosition)
397
+ */
398
+ labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
399
+ /**
400
+ * The listener set for this object.
401
+ * ...
402
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-listeners)
403
+ */
404
+ listeners ? : TaskBoardBaseListeners
405
+ /**
406
+ * A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
407
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
408
+ */
409
+ loadMask ? : string|MaskConfig|null
410
+ /**
411
+ * A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
412
+ * when data is loading. The message and optional configuration from the
413
+ * [loadMask](https://bryntum.com/products/taskboard/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
414
+ * for `maskDefaults`, respectively.
415
+ * ...
416
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-loadMaskDefaults)
417
+ */
418
+ loadMaskDefaults ? : MaskConfig
419
+ /**
420
+ * A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
421
+ * when an error occurs loading data.
422
+ * ...
423
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-loadMaskError)
424
+ */
425
+ loadMaskError ? : MaskConfig|Mask|Boolean
426
+ /**
427
+ * A class translations of which are used for translating this entity.
428
+ * This is often used when translations of an item are defined on its container class.
429
+ * For example:
430
+ * ...
431
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-localeClass)
432
+ */
433
+ localeClass ? : typeof Base
434
+ /**
435
+ * Set to `false` to disable localization of this object.
436
+ */
437
+ localizable ? : Boolean
438
+ /**
439
+ * List of properties which values should be translated automatically upon a locale applying.
440
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
441
+ * you could use 'localeKey' meta configuration.
442
+ * Example:
443
+ * ...
444
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-localizableProperties)
445
+ */
446
+ localizableProperties ? : string[]
447
+ /**
448
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
449
+ * numeric-only values are interpreted as pixels.
450
+ */
451
+ margin ? : number|string
452
+ /**
453
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) created for the
454
+ * [masked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
455
+ * values.
456
+ */
457
+ maskDefaults ? : MaskConfig
458
+ /**
459
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
460
+ * [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object.
461
+ */
462
+ masked ? : Boolean|string|MaskConfig
463
+ /**
464
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
465
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
466
+ */
467
+ maxHeight ? : string|number
468
+ /**
469
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
470
+ * ...
471
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-maximizeOnMobile)
472
+ */
473
+ maximizeOnMobile ? : number|string
474
+ /**
475
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
476
+ * like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
477
+ */
478
+ maxWidth ? : string|number
479
+ /**
480
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
481
+ * like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
482
+ */
483
+ minHeight ? : string|number
484
+ /**
485
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
486
+ * like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
487
+ */
488
+ minWidth ? : string|number
489
+ /**
490
+ * Default values to apply to task records created by task boards features (such as the column header menu and
491
+ * the column toolbar)
492
+ */
493
+ newTaskDefaults ? : TaskModelConfig
494
+ /**
495
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
496
+ * [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
497
+ * the owner is <strong>always</strong> the encapsulating Container.
498
+ * ...
499
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-owner)
500
+ */
501
+ owner ? : Widget|any
502
+ /**
503
+ * Specify plugins (an array of classes) in config
504
+ */
505
+ plugins ? : Function[]
506
+ /**
507
+ * 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
508
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
509
+ * widget's [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
510
+ * ...
511
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-positioned)
512
+ */
513
+ positioned ? : Boolean
514
+ /**
515
+ * A function called on each render before adding items to a tasks card, allowing runtime manipulation of them.
516
+ * ...
517
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-processItems)
518
+ * @param {object} context
519
+ * @param {Record<string, TaskItemOptions>} context.headerItems Item config objects for the task header, keyed by ref
520
+ * @param {Record<string, TaskItemOptions>} context.bodyItems Item config objects for the task body, keyed by ref
521
+ * @param {Record<string, TaskItemOptions>} context.footerItems Item config objects for the task footer, keyed by ref
522
+ * @param {TaskBoard.model.TaskModel} context.taskRecord Record representing task to be rendered
523
+ * @returns {boolean,void} Returning `false` from this function prevents the menu being shown
524
+ */
525
+ processItems ? : (context: { headerItems: Record<string, TaskItemOptions>, bodyItems: Record<string, TaskItemOptions>, footerItems: Record<string, TaskItemOptions>, taskRecord: TaskModel }) => Boolean|void
526
+ /**
527
+ * A [project config object](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel#configs) or an instance that holds all stores and
528
+ * data used by the TaskBoard.
529
+ * ...
530
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-project)
531
+ */
532
+ project ? : ProjectModel|ProjectModelConfig|object
533
+ /**
534
+ * Whether this widget is read-only. This is only valid if the widget is an input
535
+ * field, <strong>or contains input fields at any depth</strong>.
536
+ * ...
537
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-readOnly)
538
+ */
539
+ readOnly ? : Boolean
540
+ /**
541
+ * [Record](https://bryntum.com/products/taskboard/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
542
+ * ...
543
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-record)
544
+ */
545
+ record ? : Model
546
+ relayStoreEvents ? : Boolean
547
+ /**
548
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
549
+ * `type`.
550
+ * ...
551
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-rendition)
552
+ */
553
+ rendition ? : string|Record<string, string>|null
554
+ /**
555
+ * Path to load resource images from. Used by the for example the resource picker in the task editor and by the
556
+ * ResourceAvatars task item. Set this to display miniature images for each resource using their `image` field.
557
+ * ...
558
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-resourceImagePath)
559
+ */
560
+ resourceImagePath ? : string
561
+ /**
562
+ * Inline [resources](https://bryntum.com/products/scheduler/docs#Scheduler/model/ResourceModel), will be loaded into an internally created
563
+ * [ResourceStore](https://bryntum.com/products/scheduler/docs#Scheduler/data/ResourceStore) as a part of a [project](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel).
564
+ */
565
+ resources ? : ResourceModel[]|object[]|ResourceModelConfig[]
566
+ /**
567
+ * Specifies the various responsive state objects keyed by their name. Each key (except `'*'`, see below) in
568
+ * this object is a state name (see [responsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveState)) and its corresponding value is the
569
+ * associated [ResponsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#typedef-ResponsiveState) object.
570
+ * ...
571
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-responsive)
572
+ */
573
+ responsive ? : object
574
+ /**
575
+ * Set to `true` to mark this instance as the default [responsiveTarget](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) for descendants that do
576
+ * not specify an explicit [responsiveTarget](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) of their own.
577
+ */
578
+ responsiveRoot ? : Boolean
579
+ /**
580
+ * The name of the active state of the [responsive](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsive) config. This is assigned internally
581
+ * and should not be assigned directly.
582
+ */
583
+ responsiveState ? : string
584
+ /**
585
+ * The widget whose size and other properties drive this object's responsive behavior. If this config is not
586
+ * specified, the closest ancestor that specified [responsiveRoot=true](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveRoot) will be
587
+ * used. If there is no such ancestor, then the instance using this mixin is used.
588
+ * ...
589
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-responsiveTarget)
590
+ */
591
+ responsiveTarget ? : string|Widget
592
+ /**
593
+ * 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`
594
+ */
595
+ rootElement ? : ShadowRoot|HTMLElement
596
+ /**
597
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
598
+ * ...
599
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-rtl)
600
+ */
601
+ rtl ? : Boolean
602
+ /**
603
+ * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
604
+ * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
605
+ * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
606
+ * CSS overflow properties thus:
607
+ * ...
608
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollable)
609
+ */
610
+ scrollable ? : Boolean|ScrollerConfig|Scroller
611
+ /**
612
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
613
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
614
+ */
615
+ scrollAction ? : 'hide'|'realign'|null
616
+ /**
617
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/taskboard/docs/api/Core/util/ScrollManager) class. It is used to manage column/body
618
+ * scrolling during task, column or swimlane drag.
619
+ * ...
620
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollManager)
621
+ */
622
+ scrollManager ? : ScrollManagerConfig
623
+ /**
624
+ * Default scroll options, see the options for [scrollIntoView](https://bryntum.com/products/taskboard/docs/api/Core/helper/util/Scroller#function-scrollIntoView)
625
+ * ...
626
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollOptions)
627
+ */
628
+ scrollOptions ? : BryntumScrollOptions
629
+ /**
630
+ * Selected tasks.
631
+ */
632
+ selectedTasks ? : TaskModel[]
633
+ /**
634
+ * Configure with `true` to change the default behaviour of keyboard navigation from moving focus to selecting
635
+ * tasks:
636
+ * ...
637
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-selectOnNavigation)
638
+ */
639
+ selectOnNavigation ? : Boolean|string
640
+ /**
641
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
642
+ * ...
643
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showAnimation)
644
+ */
645
+ showAnimation ? : Boolean|object
646
+ /**
647
+ * Show an icon to expand/collapse columns and swimlanes in their headers.
648
+ * ...
649
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showCollapseInHeader)
650
+ */
651
+ showCollapseInHeader ? : Boolean
652
+ /**
653
+ * By default, a tooltip showing `Expand XX`/`Collapse XX` is shown when hovering the expand/collapse icon for
654
+ * a column or swimlane. To disable the tooltip, set this to `false`.
655
+ */
656
+ showCollapseTooltip ? : Boolean
657
+ /**
658
+ * Show task count for a column in its header, appended after the title
659
+ * ...
660
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showCountInHeader)
661
+ */
662
+ showCountInHeader ? : Boolean
663
+ /**
664
+ * Programmatic control over how many columns to span when used in a grid layout.
665
+ */
666
+ span ? : number
667
+ /**
668
+ * This value can be one of the following:
669
+ * ...
670
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateful)
671
+ */
672
+ stateful ? : Boolean|object|string[]
673
+ /**
674
+ * The events that, when fired by this component, should trigger it to save its state by calling
675
+ * [saveState](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#function-saveState).
676
+ * ...
677
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-statefulEvents)
678
+ */
679
+ statefulEvents ? : object|string[]
680
+ /**
681
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#config-stateProvider). If this config is
682
+ * not assigned, and [stateful](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
683
+ * (if explicitly specified) will be used as the `stateId`.
684
+ * ...
685
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateId)
686
+ */
687
+ stateId ? : string
688
+ /**
689
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#property-state). By default, `state`
690
+ * will be saved using the [default state provider](https://bryntum.com/products/taskboard/docs/api/Core/state/StateProvider#property-instance-static).
691
+ * ...
692
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateProvider)
693
+ */
694
+ stateProvider ? : StateProvider
695
+ /**
696
+ * Makes column and swimlane headers sticky
697
+ * ...
698
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stickyHeaders)
699
+ */
700
+ stickyHeaders ? : Boolean
701
+ /**
702
+ * Setting this will cause cards to expand to share the available width if there are fewer than
703
+ * [tasksPerRow](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tasksPerRow).
704
+ * ...
705
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stretchCards)
706
+ */
707
+ stretchCards ? : Boolean
708
+ /**
709
+ * Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#config-record),
710
+ * without falling back to `ref`.
711
+ */
712
+ strictRecordMapping ? : Boolean
713
+ /**
714
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
715
+ * [toolbars](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
716
+ * the toolbar's [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#config-items).
717
+ * ...
718
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-strips)
719
+ */
720
+ strips ? : Record<string, TaskBoardContainerItemConfig>
721
+ /**
722
+ * Field on a task record used to determine which swimlane the task belongs to.
723
+ * ...
724
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlaneField)
725
+ */
726
+ swimlaneField ? : string
727
+ /**
728
+ * An empty function by default, but provided so that you can override it. This function is called each time
729
+ * a swimlane is rendered into the task board. It allows you to manipulate the DOM config object used for the
730
+ * swimlane before it is synced to DOM, thus giving you control over styling and contents.
731
+ * ...
732
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlaneRenderer)
733
+ * @param {object} detail An object containing the information needed to render a swimlane.
734
+ * @param {TaskBoard.model.SwimlaneModel} detail.swimlaneRecord The swimlane.
735
+ * @param {DomConfig} detail.swimlaneConfig DOM config object for the swimlane
736
+ * @returns {void}
737
+ */
738
+ swimlaneRenderer ? : (detail: { swimlaneRecord: SwimlaneModel, swimlaneConfig: DomConfig }) => void
739
+ /**
740
+ * Store containing the TaskBoard swimlanes. A tasks [swimlaneField](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardSwimlanes#config-swimlaneField) is matched against the `id`
741
+ * of a swimlane to determine in which swimlane it is displayed.
742
+ * ...
743
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlanes)
744
+ */
745
+ swimlanes ? : SwimlaneModel[]|SwimlaneModelConfig[]|Store|string|StoreConfig
746
+ /**
747
+ * TaskBoard does not use a sync mask by default. If you want one, see
748
+ * [syncMask](https://bryntum.com/products/taskboard/docs/api/Core/mixin/LoadMaskable#config-syncMask) for configuration options.
749
+ */
750
+ syncMask ? : string|object|null
751
+ /**
752
+ * 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
753
+ * [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
754
+ * this widget:
755
+ * ...
756
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tab)
757
+ */
758
+ tab ? : Boolean|TabConfig
759
+ /**
760
+ * When this container is used as a tab in a TabPanel, these items are added to the
761
+ * [TabBar](https://bryntum.com/products/taskboard/docs/api/Core/widget/TabBar) when this container is the active tab.
762
+ * ...
763
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tabBarItems)
764
+ */
765
+ tabBarItems ? : ToolbarItems[]|Widget[]
766
+ /**
767
+ * An empty function by default, but provided so that you can override it. This function is called each time
768
+ * a task is rendered into the task board. It allows you to manipulate the DOM config object used for the card
769
+ * before it is synced to DOM, thus giving you control over styling and contents.
770
+ * ...
771
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-taskRenderer)
772
+ * @param {object} detail An object containing the information needed to render a task.
773
+ * @param {TaskBoard.model.TaskModel} detail.taskRecord The task record.
774
+ * @param {TaskBoard.model.ColumnModel} detail.columnRecord The column the task will be displayed in.
775
+ * @param {TaskBoard.model.SwimlaneModel} detail.swimlaneRecord The swimlane the task will be displayed in.
776
+ * @param {DomConfig} detail.cardConfig DOM config object for the cards element
777
+ * @returns {void}
778
+ */
779
+ taskRenderer ? : (detail: { taskRecord: TaskModel, columnRecord: ColumnModel, swimlaneRecord: SwimlaneModel, cardConfig: DomConfig }) => void
780
+ /**
781
+ * Inline [tasks](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/TaskModel), will be loaded into an internally created
782
+ * [TaskStore](https://bryntum.com/products/taskboard/docs/api/TaskBoard/store/TaskStore) as a part of a [project](#TaskBoard/model/ProjectModel).
783
+ */
784
+ tasks ? : TaskModel[]|object[]|TaskModelConfig[]
785
+ /**
786
+ * Allows sorting tasks in the UI independent of how they are sorted in the task store.
787
+ * ...
788
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-taskSorterFn)
789
+ * @param {TaskBoard.model.TaskModel} first The first task to compare
790
+ * @param {TaskBoard.model.TaskModel} second The second task to compare
791
+ * @returns {number} Return `1` if first task is greater than second task, `-1` if the opposite is true or `0` if they are equal
792
+ */
793
+ taskSorterFn ? : Boolean|((first: TaskModel, second: TaskModel) => number)
794
+ /**
795
+ * Controls how many cards are rendered to a row in each column. Can be controlled on a per column basis by
796
+ * setting [tasksPerRow](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-tasksPerRow)
797
+ * ...
798
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tasksPerRow)
799
+ */
800
+ tasksPerRow ? : number
801
+ /**
802
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar),
803
+ * or array of config objects representing the child items of a Toolbar.
804
+ * This creates a toolbar docked to the top of the panel immediately below the header.
805
+ * ...
806
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tbar)
807
+ */
808
+ tbar ? : (TaskBoardContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
809
+ /**
810
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
811
+ * to the top if no header is configured.
812
+ * ...
813
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-title)
814
+ */
815
+ title ? : string
816
+ /**
817
+ * The [tools](https://bryntum.com/products/taskboard/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
818
+ * property name is the reference by which an instantiated tool may be retrieved from the live
819
+ * `[tools](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
820
+ * ...
821
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tools)
822
+ */
823
+ tools ? : Record<string, ToolConfig>|null
824
+ /**
825
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
826
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
827
+ * values are used as the class names.
828
+ * ...
829
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ui)
830
+ */
831
+ ui ? : 'plain'|'toolbar'|string|object
832
+ /**
833
+ * Experimental, animate actions that cannot be animated using CSS transitions. Currently includes:
834
+ * ...
835
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-useDomTransition)
836
+ */
837
+ useDomTransition ? : Boolean
838
+ /**
839
+ * By turning on this setting you enable partial virtualized rendering for the board, which reduces initial
840
+ * rendering time and makes interaction less sluggish when using thousands of tasks. The tradeoff is that
841
+ * scrolling in most cases will be slower.
842
+ * ...
843
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-virtualize)
844
+ */
845
+ virtualize ? : Boolean
846
+ /**
847
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container).
848
+ * Higher weights go further down.
849
+ */
850
+ weight ? : number
851
+ /**
852
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
853
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
854
+ * this config is convenient.
855
+ */
856
+ width ? : string|number
857
+ /**
858
+ * The x position for the widget.
859
+ * ...
860
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-x)
861
+ */
862
+ x ? : number
863
+ /**
864
+ * The y position for the widget.
865
+ * ...
866
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-y)
867
+ */
868
+ y ? : number
869
+
870
+ // Features
871
+ /**
872
+ * This feature allows users to drag columns on the TaskBoard to change the column order. Drag is initiated upon
873
+ * mouse down in the column header. Try it out below!
874
+ * ...
875
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnDrag)
876
+ */
877
+ columnDragFeature ? : object|Boolean|string|ColumnDrag|ColumnDragConfig
878
+ /**
879
+ * Adds the ability to filter each column of the TaskBoard.
880
+ * ...
881
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnFilter)
882
+ */
883
+ columnFilterFeature ? : object|Boolean|string|ColumnFilter|ColumnFilterConfig
884
+ /**
885
+ * Adds a menu button (`···`) to column headers, clicking it displays a menu. Items are populated by other features
886
+ * and/or application code.
887
+ * ...
888
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnHeaderMenu)
889
+ */
890
+ columnHeaderMenuFeature ? : object|Boolean|string|ColumnHeaderMenu|ColumnHeaderMenuConfig
891
+ /**
892
+ * Allows user to lock columns to the left or right using the new [locked](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-locked) field
893
+ * on columns.
894
+ * ...
895
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnLock)
896
+ */
897
+ columnLockFeature ? : object|Boolean|string|ColumnLock|ColumnLockConfig
898
+ /**
899
+ * Allows user to rename columns by either double-clicking column text, or via the column header menu.
900
+ * ...
901
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnRename)
902
+ */
903
+ columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
904
+ /**
905
+ * This feature allows users to change the width of individual TaskBoard columns. Resize is initiated upon mouse down on
906
+ * the separator element between column headers. Try it out below!
907
+ * ...
908
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnResize)
909
+ */
910
+ columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
911
+ /**
912
+ * Adds the ability to sort each column of the TaskBoard.
913
+ * ...
914
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnSort)
915
+ */
916
+ columnSortFeature ? : object|Boolean|string|ColumnSort|ColumnSortConfig
917
+ /**
918
+ * Adds toolbars to the top and/or bottom of each column. By default it adds a bottom toolbar containing a single button
919
+ * for adding events to that column/swimlane:
920
+ * ...
921
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnToolbars)
922
+ */
923
+ columnToolbarsFeature ? : object|Boolean|string|ColumnToolbars|ColumnToolbarsConfig
924
+ /**
925
+ * Adds the ability to quick search in configured fields of tasks.
926
+ * Renders a filter bar below each column's header.
927
+ * ...
928
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/FilterBar)
929
+ */
930
+ filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
931
+ /**
932
+ * This feature allows inline editing of tasks. Double-clicking an item starts editing it:
933
+ * ...
934
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/SimpleTaskEdit)
935
+ */
936
+ simpleTaskEditFeature ? : object|Boolean|string|SimpleTaskEdit|SimpleTaskEditConfig
937
+ /**
938
+ * This feature allows users to drag drop swimlanes on the TaskBoard changing their order (by grabbing their header).
939
+ * ...
940
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/SwimlaneDrag)
941
+ */
942
+ swimlaneDragFeature ? : object|Boolean|string|SwimlaneDrag|SwimlaneDragConfig
943
+ /**
944
+ * This feature allows cards on the TaskBoard to be dragged across swimlanes and columns but also vertically in the
945
+ * same column to change the order:
946
+ * ...
947
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskDrag)
948
+ */
949
+ taskDragFeature ? : object|Boolean|string|TaskDrag|TaskDragConfig
950
+ /**
951
+ * Enables users to click and drag to select cards on the TaskBoard (marquee selection).
952
+ * ...
953
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskDragSelect)
954
+ */
955
+ taskDragSelectFeature ? : object|Boolean|string|TaskDragSelect|TaskDragSelectConfig
956
+ /**
957
+ * This features allows the user to edit tasks in a popup editor that can either be shown centered on screen (the
958
+ * default, double click a task to show the editor):
959
+ * ...
960
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskEdit)
961
+ */
962
+ taskEditFeature ? : object|Boolean|string|TaskEdit|TaskEditConfig
963
+ /**
964
+ * Displays a context menu for tasks. Items are populated by other features and/or application code.
965
+ * ...
966
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskMenu)
967
+ */
968
+ taskMenuFeature ? : object|Boolean|string|TaskMenu|TaskMenuConfig
969
+ /**
970
+ * Displays a tooltip when hovering a task. By default the tooltip displays:
971
+ * ...
972
+ * [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskTooltip)
973
+ */
974
+ taskTooltipFeature ? : object|Boolean|string|TaskTooltip|TaskTooltipConfig
975
+
976
+ }