@bryntum/gantt-react-thin 7.1.1

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