@bryntum/grid-angular-thin 7.2.4 → 7.3.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.
- package/README.md +5 -5
- package/bundles/bryntum-grid-angular-thin.umd.js +773 -230
- package/bundles/bryntum-grid-angular-thin.umd.js.map +1 -1
- package/esm2015/lib/bryntum-a-i-filter-field.component.js +66 -14
- package/esm2015/lib/bryntum-checklist-filter-combo.component.js +66 -14
- package/esm2015/lib/bryntum-grid-base.component.js +78 -35
- package/esm2015/lib/bryntum-grid-chart-designer.component.js +61 -12
- package/esm2015/lib/bryntum-grid-field-filter-picker-group.component.js +65 -21
- package/esm2015/lib/bryntum-grid-field-filter-picker.component.js +65 -21
- package/esm2015/lib/bryntum-grid.component.js +78 -35
- package/esm2015/lib/bryntum-group-bar.component.js +61 -12
- package/esm2015/lib/bryntum-tree-combo.component.js +66 -14
- package/esm2015/lib/bryntum-tree-grid.component.js +78 -35
- package/esm2015/lib/grid.module.js +5 -4
- package/esm2015/lib/shadowdom.helper.js +82 -0
- package/fesm2015/bryntum-grid-angular-thin.js +750 -207
- package/fesm2015/bryntum-grid-angular-thin.js.map +1 -1
- package/lib/bryntum-a-i-filter-field.component.d.ts +97 -133
- package/lib/bryntum-checklist-filter-combo.component.d.ts +116 -166
- package/lib/bryntum-grid-base.component.d.ts +238 -303
- package/lib/bryntum-grid-chart-designer.component.d.ts +71 -108
- package/lib/bryntum-grid-field-filter-picker-group.component.d.ts +93 -143
- package/lib/bryntum-grid-field-filter-picker.component.d.ts +94 -145
- package/lib/bryntum-grid.component.d.ts +238 -303
- package/lib/bryntum-group-bar.component.d.ts +77 -118
- package/lib/bryntum-tree-combo.component.d.ts +117 -168
- package/lib/bryntum-tree-grid.component.d.ts +238 -303
- package/lib/grid.module.d.ts +2 -1
- package/lib/shadowdom.helper.d.ts +3 -0
- package/package.json +1 -1
- package/src/lib/bryntum-a-i-filter-field.component.ts +159 -142
- package/src/lib/bryntum-checklist-filter-combo.component.ts +179 -176
- package/src/lib/bryntum-grid-base.component.ts +300 -344
- package/src/lib/bryntum-grid-chart-designer.component.ts +127 -113
- package/src/lib/bryntum-grid-field-filter-picker-group.component.ts +154 -154
- package/src/lib/bryntum-grid-field-filter-picker.component.ts +153 -154
- package/src/lib/bryntum-grid.component.ts +300 -344
- package/src/lib/bryntum-group-bar.component.ts +134 -124
- package/src/lib/bryntum-theme-combo.component.ts +127 -0
- package/src/lib/bryntum-tree-combo.component.ts +179 -177
- package/src/lib/bryntum-tree-grid.component.ts +300 -344
- package/src/lib/grid.module.ts +2 -1
- package/src/lib/shadowdom.helper.ts +91 -0
|
@@ -2,21 +2,19 @@
|
|
|
2
2
|
* Angular wrapper for Bryntum TreeCombo
|
|
3
3
|
*/
|
|
4
4
|
import { ElementRef, SimpleChanges, OnDestroy, OnInit } from '@angular/core';
|
|
5
|
-
import { AlignSpec, Base, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo,
|
|
5
|
+
import { AlignSpec, Base, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, DomConfig, Duration, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, List, ListConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
6
|
import { GridContainerItemConfig, TreeCombo, TreeComboListeners } from '@bryntum/grid-thin';
|
|
7
7
|
import * as i0 from "@angular/core";
|
|
8
8
|
export declare type BryntumTreeComboProps = {
|
|
9
9
|
/**
|
|
10
10
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
11
11
|
* content will be placed inside this element.
|
|
12
|
-
* ...
|
|
13
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-adopt)
|
|
12
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-adopt)
|
|
14
13
|
*/
|
|
15
14
|
adopt?: HTMLElement | string;
|
|
16
15
|
/**
|
|
17
16
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
18
|
-
* ...
|
|
19
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-align)
|
|
17
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-align)
|
|
20
18
|
*/
|
|
21
19
|
align?: AlignSpec | string;
|
|
22
20
|
/**
|
|
@@ -38,15 +36,13 @@ export declare type BryntumTreeComboProps = {
|
|
|
38
36
|
/**
|
|
39
37
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
40
38
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
41
|
-
* ...
|
|
42
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaDescription)
|
|
39
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaDescription)
|
|
43
40
|
*/
|
|
44
41
|
ariaDescription?: string;
|
|
45
42
|
/**
|
|
46
43
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
47
44
|
* the `aria-label` attribute.
|
|
48
|
-
* ...
|
|
49
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaLabel)
|
|
45
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaLabel)
|
|
50
46
|
*/
|
|
51
47
|
ariaLabel?: string;
|
|
52
48
|
/**
|
|
@@ -69,20 +65,17 @@ export declare type BryntumTreeComboProps = {
|
|
|
69
65
|
/**
|
|
70
66
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
71
67
|
* hierarchy when triggered.
|
|
72
|
-
* ...
|
|
73
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-bubbleEvents)
|
|
68
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-bubbleEvents)
|
|
74
69
|
*/
|
|
75
70
|
bubbleEvents?: object;
|
|
76
71
|
/**
|
|
77
72
|
* Enable caching of the last retrieved result until the timeout is reached.
|
|
78
|
-
* ...
|
|
79
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cacheLastResult)
|
|
73
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cacheLastResult)
|
|
80
74
|
*/
|
|
81
75
|
cacheLastResult?: number | string | Duration | DurationConfig;
|
|
82
76
|
/**
|
|
83
77
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
84
|
-
* ...
|
|
85
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-callOnFunctions)
|
|
78
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-callOnFunctions)
|
|
86
79
|
*/
|
|
87
80
|
callOnFunctions?: boolean;
|
|
88
81
|
/**
|
|
@@ -92,8 +85,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
92
85
|
/**
|
|
93
86
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
94
87
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
95
|
-
* ...
|
|
96
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-catchEventHandlerExceptions)
|
|
88
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-catchEventHandlerExceptions)
|
|
97
89
|
*/
|
|
98
90
|
catchEventHandlerExceptions?: boolean;
|
|
99
91
|
/**
|
|
@@ -101,11 +93,19 @@ export declare type BryntumTreeComboProps = {
|
|
|
101
93
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
102
94
|
*/
|
|
103
95
|
centered?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
98
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
99
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
100
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
101
|
+
* @param {Core.widget.Field} field The field being validated
|
|
102
|
+
* @returns {void}
|
|
103
|
+
*/
|
|
104
|
+
checkValidity?: ((field: Field) => void) | string;
|
|
104
105
|
/**
|
|
105
106
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
106
107
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
107
|
-
* ...
|
|
108
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-chipView)
|
|
108
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-chipView)
|
|
109
109
|
*/
|
|
110
110
|
chipView?: ChipViewConfig;
|
|
111
111
|
/**
|
|
@@ -130,15 +130,13 @@ export declare type BryntumTreeComboProps = {
|
|
|
130
130
|
* Custom CSS classes to add to element.
|
|
131
131
|
* May be specified as a space separated string, or as an object in which property names
|
|
132
132
|
* with truthy values are used as the class names:
|
|
133
|
-
* ...
|
|
134
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cls)
|
|
133
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cls)
|
|
135
134
|
*/
|
|
136
135
|
cls?: string | object;
|
|
137
136
|
/**
|
|
138
137
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
139
138
|
* `style` block.
|
|
140
|
-
* ...
|
|
141
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
|
|
139
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
|
|
142
140
|
*/
|
|
143
141
|
color?: Color;
|
|
144
142
|
/**
|
|
@@ -155,15 +153,13 @@ export declare type BryntumTreeComboProps = {
|
|
|
155
153
|
* The configuration for additional items associated to this field. This is typically used to add contextual
|
|
156
154
|
* fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
|
|
157
155
|
* these classes for examples of nested fields.
|
|
158
|
-
* ...
|
|
159
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
|
|
156
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
|
|
160
157
|
*/
|
|
161
|
-
container?: Record<string, GridContainerItemConfig> | GridContainerItemConfig[] | FieldContainerConfig
|
|
158
|
+
container?: Record<string, GridContainerItemConfig> | GridContainerItemConfig[] | FieldContainerConfig;
|
|
162
159
|
/**
|
|
163
160
|
* The config controls how the value of nested items are handled when a parent container gets or sets its
|
|
164
161
|
* [values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
|
|
165
|
-
* ...
|
|
166
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-containValues)
|
|
162
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-containValues)
|
|
167
163
|
* @param {Core.widget.Field} field Field instance
|
|
168
164
|
* @returns {boolean}
|
|
169
165
|
*/
|
|
@@ -172,16 +168,14 @@ export declare type BryntumTreeComboProps = {
|
|
|
172
168
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
173
169
|
* May be specified as a space separated string, or as an object in which property names
|
|
174
170
|
* with truthy values are used as the class names:
|
|
175
|
-
* ...
|
|
176
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-contentElementCls)
|
|
171
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-contentElementCls)
|
|
177
172
|
*/
|
|
178
173
|
contentElementCls?: string | object;
|
|
179
174
|
/**
|
|
180
175
|
* If configured as `true`, this means that when an unmatched string is typed into the
|
|
181
176
|
* combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
|
|
182
177
|
* a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
|
|
183
|
-
* ...
|
|
184
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
|
|
178
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
|
|
185
179
|
* @param {string} name Record name
|
|
186
180
|
* @param {Core.widget.Combo} combo Combo instance
|
|
187
181
|
* @returns {Core.data.Model} New record
|
|
@@ -202,16 +196,15 @@ export declare type BryntumTreeComboProps = {
|
|
|
202
196
|
*/
|
|
203
197
|
defaultBindProperty?: string;
|
|
204
198
|
/**
|
|
205
|
-
* Check for CSS compatibility issues
|
|
206
|
-
*
|
|
207
|
-
* [
|
|
199
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
200
|
+
* checks:
|
|
201
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-detectCSSCompatibilityIssues)
|
|
208
202
|
*/
|
|
209
203
|
detectCSSCompatibilityIssues?: boolean;
|
|
210
204
|
/**
|
|
211
205
|
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
212
206
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
213
|
-
* ...
|
|
214
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-disabled)
|
|
207
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-disabled)
|
|
215
208
|
*/
|
|
216
209
|
disabled?: boolean | 'inert';
|
|
217
210
|
/**
|
|
@@ -224,26 +217,23 @@ export declare type BryntumTreeComboProps = {
|
|
|
224
217
|
* @param {Core.widget.Combo} combo A reference to this Combo
|
|
225
218
|
* @returns {string,void}
|
|
226
219
|
*/
|
|
227
|
-
displayValueRenderer?: (record: Model
|
|
220
|
+
displayValueRenderer?: (record: Model, combo: Combo) => string | void;
|
|
228
221
|
/**
|
|
229
222
|
* Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/grid/docs/api/Core/widget/Panel)
|
|
230
223
|
* [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
231
224
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
232
225
|
* body. Such widgets are called "edge strips".
|
|
233
|
-
* ...
|
|
234
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
|
|
226
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
|
|
235
227
|
*/
|
|
236
228
|
dock?: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
|
|
237
229
|
/**
|
|
238
230
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
239
231
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
240
232
|
* property which controls when a drag should start.
|
|
241
|
-
* ...
|
|
242
|
-
*
|
|
233
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
|
|
234
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
243
235
|
*/
|
|
244
|
-
draggable?: boolean |
|
|
245
|
-
handleSelector?: string;
|
|
246
|
-
};
|
|
236
|
+
draggable?: boolean | object;
|
|
247
237
|
/**
|
|
248
238
|
* User can edit text in text field (otherwise only pick from attached picker)
|
|
249
239
|
*/
|
|
@@ -251,21 +241,18 @@ export declare type BryntumTreeComboProps = {
|
|
|
251
241
|
/**
|
|
252
242
|
* An object specifying attributes to assign to the root element of this widget.
|
|
253
243
|
* Set `null` value to attribute to remove it.
|
|
254
|
-
* ...
|
|
255
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-elementAttributes)
|
|
244
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-elementAttributes)
|
|
256
245
|
*/
|
|
257
246
|
elementAttributes?: Record<string, string | null>;
|
|
258
247
|
/**
|
|
259
248
|
* Text to display in the drop down when there are no items in the underlying store.
|
|
260
|
-
* ...
|
|
261
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-emptyText)
|
|
249
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-emptyText)
|
|
262
250
|
*/
|
|
263
251
|
emptyText?: string;
|
|
264
252
|
/**
|
|
265
253
|
* A function which creates an array of values for the [filterParamName](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-filterParamName) to pass
|
|
266
254
|
* any filters to the server upon load.
|
|
267
|
-
* ...
|
|
268
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
|
|
255
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
|
|
269
256
|
* @param {object[]} filters filters
|
|
270
257
|
* @returns {object[]} array of values
|
|
271
258
|
*/
|
|
@@ -279,8 +266,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
279
266
|
/**
|
|
280
267
|
* The name of an operator type as implemented in [operator](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter#config-operator)
|
|
281
268
|
* to use when filtering the dropdown list based upon the typed value.
|
|
282
|
-
* ...
|
|
283
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-filterOperator)
|
|
269
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-filterOperator)
|
|
284
270
|
*/
|
|
285
271
|
filterOperator?: CollectionCompareOperator;
|
|
286
272
|
/**
|
|
@@ -321,8 +307,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
321
307
|
hidden?: boolean;
|
|
322
308
|
/**
|
|
323
309
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
324
|
-
* ...
|
|
325
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hideAnimation)
|
|
310
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hideAnimation)
|
|
326
311
|
*/
|
|
327
312
|
hideAnimation?: boolean | object;
|
|
328
313
|
/**
|
|
@@ -343,8 +328,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
343
328
|
/**
|
|
344
329
|
* An optional string to display inside the input field as an overlay. This can be useful for displaying
|
|
345
330
|
* a field's units.
|
|
346
|
-
* ...
|
|
347
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
|
|
331
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
|
|
348
332
|
* @param {object} data A data object
|
|
349
333
|
* @param {Core.widget.Field} data.source A reference to the field instance
|
|
350
334
|
* @param {any} data.value The current value of the field
|
|
@@ -358,8 +342,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
358
342
|
* This config is similar to [hint](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
|
|
359
343
|
* Since this can allow malicious content to be executed, be sure not to include user-entered data or to
|
|
360
344
|
* encode such data (see [encodeHtml](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
|
|
361
|
-
* ...
|
|
362
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hintHtml)
|
|
345
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hintHtml)
|
|
363
346
|
* @param {object} data A data object
|
|
364
347
|
* @param {Core.widget.Field} data.source A reference to the field instance
|
|
365
348
|
* @param {any} data.value The current value of the field
|
|
@@ -375,23 +358,20 @@ export declare type BryntumTreeComboProps = {
|
|
|
375
358
|
id?: string;
|
|
376
359
|
/**
|
|
377
360
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
378
|
-
* ...
|
|
379
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ignoreParentReadOnly)
|
|
361
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ignoreParentReadOnly)
|
|
380
362
|
*/
|
|
381
363
|
ignoreParentReadOnly?: boolean;
|
|
382
364
|
/**
|
|
383
365
|
* Set this config to `true` to always display items horizontally along with this field. This assigns an
|
|
384
366
|
* [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
|
|
385
367
|
* [container](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-container).
|
|
386
|
-
* ...
|
|
387
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inline)
|
|
368
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inline)
|
|
388
369
|
*/
|
|
389
370
|
inline?: boolean;
|
|
390
371
|
/**
|
|
391
372
|
* Configure this as `true` to render the dropdown list as a permanently visible list
|
|
392
373
|
* in the document flow immediately below the input area instead of as a popup.
|
|
393
|
-
* ...
|
|
394
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inlinePicker)
|
|
374
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inlinePicker)
|
|
395
375
|
*/
|
|
396
376
|
inlinePicker?: boolean;
|
|
397
377
|
/**
|
|
@@ -429,30 +409,26 @@ export declare type BryntumTreeComboProps = {
|
|
|
429
409
|
insertFirst?: HTMLElement | string;
|
|
430
410
|
/**
|
|
431
411
|
* Rows to display in the dropdown (list items).
|
|
432
|
-
* ...
|
|
433
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-items)
|
|
412
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-items)
|
|
434
413
|
*/
|
|
435
414
|
items?: object[] | string[] | object;
|
|
436
415
|
/**
|
|
437
416
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
438
417
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
439
418
|
* are the name of the instance method to call when the keystroke is received.
|
|
440
|
-
* ...
|
|
441
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyMap)
|
|
419
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyMap)
|
|
442
420
|
*/
|
|
443
421
|
keyMap?: Record<string, KeyMapConfig>;
|
|
444
422
|
/**
|
|
445
423
|
* The delay in milliseconds to wait after the last keystroke before triggering a change event.
|
|
446
424
|
* Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
|
|
447
425
|
* immediate feedback, change will still be triggered on blur).
|
|
448
|
-
* ...
|
|
449
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeChangeDelay)
|
|
426
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeChangeDelay)
|
|
450
427
|
*/
|
|
451
428
|
keyStrokeChangeDelay?: number;
|
|
452
429
|
/**
|
|
453
430
|
* The delay in milliseconds to wait after the last keystroke before filtering the list.
|
|
454
|
-
* ...
|
|
455
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeFilterDelay)
|
|
431
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeFilterDelay)
|
|
456
432
|
*/
|
|
457
433
|
keyStrokeFilterDelay?: number;
|
|
458
434
|
/**
|
|
@@ -465,15 +441,15 @@ export declare type BryntumTreeComboProps = {
|
|
|
465
441
|
labelCls?: string | object;
|
|
466
442
|
/**
|
|
467
443
|
* Label position, either 'before' the field or 'above' the field
|
|
468
|
-
* ...
|
|
469
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labelPosition)
|
|
444
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labelPosition)
|
|
470
445
|
*/
|
|
471
446
|
labelPosition?: 'before' | 'above' | null;
|
|
472
447
|
/**
|
|
473
448
|
* The labels to add either before or after the input field.
|
|
474
449
|
* Each label may have the following properties:
|
|
475
|
-
* ...
|
|
476
|
-
*
|
|
450
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labels)
|
|
451
|
+
* @property {string} html Label text
|
|
452
|
+
* @property {'start','end'} align Which end of the file the label should go
|
|
477
453
|
*/
|
|
478
454
|
labels?: object[];
|
|
479
455
|
/**
|
|
@@ -486,24 +462,21 @@ export declare type BryntumTreeComboProps = {
|
|
|
486
462
|
listCls?: string;
|
|
487
463
|
/**
|
|
488
464
|
* The listener set for this object.
|
|
489
|
-
* ...
|
|
490
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
|
|
465
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
|
|
491
466
|
*/
|
|
492
467
|
listeners?: TreeComboListeners;
|
|
493
468
|
/**
|
|
494
469
|
* Template string used to render the list items in the dropdown list
|
|
495
|
-
* ...
|
|
496
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listItemTpl)
|
|
470
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listItemTpl)
|
|
497
471
|
* @param {Core.data.Model} record The record representing the item being rendered
|
|
498
472
|
* @returns {string,void}
|
|
499
473
|
*/
|
|
500
|
-
listItemTpl?: (record: Model
|
|
474
|
+
listItemTpl?: (record: Model) => string | void;
|
|
501
475
|
/**
|
|
502
476
|
* A class translations of which are used for translating this entity.
|
|
503
477
|
* This is often used when translations of an item are defined on its container class.
|
|
504
478
|
* For example:
|
|
505
|
-
* ...
|
|
506
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
|
|
479
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
|
|
507
480
|
*/
|
|
508
481
|
localeClass?: typeof Base;
|
|
509
482
|
/**
|
|
@@ -515,8 +488,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
515
488
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
516
489
|
* you could use 'localeKey' meta configuration.
|
|
517
490
|
* Example:
|
|
518
|
-
* ...
|
|
519
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
|
|
491
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
|
|
520
492
|
*/
|
|
521
493
|
localizableProperties?: string[];
|
|
522
494
|
/**
|
|
@@ -542,8 +514,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
542
514
|
maxHeight?: string | number;
|
|
543
515
|
/**
|
|
544
516
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
545
|
-
* ...
|
|
546
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-maximizeOnMobile)
|
|
517
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-maximizeOnMobile)
|
|
547
518
|
*/
|
|
548
519
|
maximizeOnMobile?: number | string;
|
|
549
520
|
/**
|
|
@@ -557,8 +528,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
557
528
|
maxWidth?: string | number;
|
|
558
529
|
/**
|
|
559
530
|
* The minimum string length to trigger the filtering, only relevant when [editable](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-editable) is `true`.
|
|
560
|
-
* ...
|
|
561
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-minChars)
|
|
531
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-minChars)
|
|
562
532
|
*/
|
|
563
533
|
minChars?: number;
|
|
564
534
|
/**
|
|
@@ -579,16 +549,13 @@ export declare type BryntumTreeComboProps = {
|
|
|
579
549
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
580
550
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
581
551
|
* layout.
|
|
582
|
-
* ...
|
|
583
|
-
*
|
|
552
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-monitorResize)
|
|
553
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
584
554
|
*/
|
|
585
|
-
monitorResize?: boolean |
|
|
586
|
-
immediate?: boolean;
|
|
587
|
-
};
|
|
555
|
+
monitorResize?: boolean | object;
|
|
588
556
|
/**
|
|
589
557
|
* Set to `true` to allow selection of multiple values from the dropdown list.
|
|
590
|
-
* ...
|
|
591
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-multiSelect)
|
|
558
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-multiSelect)
|
|
592
559
|
*/
|
|
593
560
|
multiSelect?: boolean;
|
|
594
561
|
/**
|
|
@@ -601,8 +568,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
601
568
|
* Name of the field which is used as a key to get/set values from/to the field.
|
|
602
569
|
* Used prior to [ref](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
|
|
603
570
|
* [Container.values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
|
|
604
|
-
* ...
|
|
605
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
|
|
571
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
|
|
606
572
|
*/
|
|
607
573
|
name?: string;
|
|
608
574
|
/**
|
|
@@ -613,10 +579,9 @@ export declare type BryntumTreeComboProps = {
|
|
|
613
579
|
/**
|
|
614
580
|
* Configuration object for the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) on initialization. Returns the
|
|
615
581
|
* [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) instance at runtime.
|
|
616
|
-
* ...
|
|
617
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-picker)
|
|
582
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-picker)
|
|
618
583
|
*/
|
|
619
|
-
picker?: ListConfig
|
|
584
|
+
picker?: ListConfig;
|
|
620
585
|
/**
|
|
621
586
|
* The name of the element property to which the picker should size and align itself.
|
|
622
587
|
*/
|
|
@@ -633,8 +598,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
633
598
|
* Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement), but must
|
|
634
599
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
635
600
|
* widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
636
|
-
* ...
|
|
637
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-positioned)
|
|
601
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-positioned)
|
|
638
602
|
*/
|
|
639
603
|
positioned?: boolean;
|
|
640
604
|
/**
|
|
@@ -646,22 +610,19 @@ export declare type BryntumTreeComboProps = {
|
|
|
646
610
|
* Optionally a [Filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config object which the combo should use for
|
|
647
611
|
* filtering using the typed value.
|
|
648
612
|
* This may use a `filterBy` property to test its `value` against any field in the passed record.
|
|
649
|
-
* ...
|
|
650
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-primaryFilter)
|
|
613
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-primaryFilter)
|
|
651
614
|
*/
|
|
652
615
|
primaryFilter?: CollectionFilterConfig;
|
|
653
616
|
/**
|
|
654
617
|
* Makes the field unmodifiable by user action. The input area is not editable, and triggers
|
|
655
618
|
* are unresponsive.
|
|
656
|
-
* ...
|
|
657
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
|
|
619
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
|
|
658
620
|
*/
|
|
659
621
|
readOnly?: boolean;
|
|
660
622
|
relayStoreEvents?: boolean;
|
|
661
623
|
/**
|
|
662
624
|
* Predefined style to use for the field. Possible values are:
|
|
663
|
-
* ...
|
|
664
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rendition)
|
|
625
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rendition)
|
|
665
626
|
*/
|
|
666
627
|
rendition?: 'outlined' | 'filled' | string;
|
|
667
628
|
/**
|
|
@@ -680,23 +641,26 @@ export declare type BryntumTreeComboProps = {
|
|
|
680
641
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
681
642
|
* [focusElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
|
|
682
643
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
683
|
-
* ...
|
|
684
|
-
* [
|
|
644
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ripple)
|
|
645
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
646
|
+
* @property {string} [color] A CSS color name or specification.
|
|
647
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
648
|
+
* @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
|
|
649
|
+
*/
|
|
650
|
+
ripple?: boolean | object;
|
|
651
|
+
/**
|
|
652
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
653
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
654
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-role)
|
|
685
655
|
*/
|
|
686
|
-
|
|
687
|
-
delegate?: string;
|
|
688
|
-
color?: string;
|
|
689
|
-
radius?: number;
|
|
690
|
-
clip?: string;
|
|
691
|
-
};
|
|
656
|
+
role?: string;
|
|
692
657
|
/**
|
|
693
658
|
* 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`
|
|
694
659
|
*/
|
|
695
660
|
rootElement?: ShadowRoot | HTMLElement;
|
|
696
661
|
/**
|
|
697
662
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
698
|
-
* ...
|
|
699
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rtl)
|
|
663
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rtl)
|
|
700
664
|
*/
|
|
701
665
|
rtl?: boolean;
|
|
702
666
|
/**
|
|
@@ -706,8 +670,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
706
670
|
scrollAction?: 'hide' | 'realign' | null;
|
|
707
671
|
/**
|
|
708
672
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
709
|
-
* ...
|
|
710
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-showAnimation)
|
|
673
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-showAnimation)
|
|
711
674
|
*/
|
|
712
675
|
showAnimation?: boolean | object;
|
|
713
676
|
/**
|
|
@@ -740,8 +703,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
740
703
|
* A configuration for the [tab](https://bryntum.com/products/grid/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
741
704
|
* [TabPanel](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
742
705
|
* this widget:
|
|
743
|
-
* ...
|
|
744
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
|
|
706
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
|
|
745
707
|
*/
|
|
746
708
|
tab?: boolean | TabConfig;
|
|
747
709
|
/**
|
|
@@ -749,14 +711,12 @@ export declare type BryntumTreeComboProps = {
|
|
|
749
711
|
* is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
|
|
750
712
|
* (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
|
|
751
713
|
* to the element programmatically.
|
|
752
|
-
* ...
|
|
753
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
|
|
714
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
|
|
754
715
|
*/
|
|
755
716
|
tabIndex?: number;
|
|
756
717
|
/**
|
|
757
718
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
758
|
-
* ...
|
|
759
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-textAlign)
|
|
719
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-textAlign)
|
|
760
720
|
*/
|
|
761
721
|
textAlign?: 'left' | 'center' | 'right' | 'start' | 'end';
|
|
762
722
|
/**
|
|
@@ -765,30 +725,26 @@ export declare type BryntumTreeComboProps = {
|
|
|
765
725
|
title?: string;
|
|
766
726
|
/**
|
|
767
727
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
768
|
-
* ...
|
|
769
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tooltip)
|
|
728
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tooltip)
|
|
770
729
|
*/
|
|
771
730
|
tooltip?: string | TooltipConfig | null;
|
|
772
731
|
/**
|
|
773
732
|
* How to query the store upon click of the expand trigger. Specify one of these values:
|
|
774
|
-
* ...
|
|
775
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggerAction)
|
|
733
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggerAction)
|
|
776
734
|
*/
|
|
777
735
|
triggerAction?: 'all' | 'last' | null;
|
|
778
736
|
/**
|
|
779
737
|
* The triggers to add either before or after the input field. Each property name is the reference by which
|
|
780
738
|
* an instantiated Trigger Widget may be retrieved from the live `triggers` property.
|
|
781
|
-
* ...
|
|
782
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggers)
|
|
739
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggers)
|
|
783
740
|
*/
|
|
784
|
-
triggers?: Record<string, FieldTriggerConfig
|
|
741
|
+
triggers?: Record<string, FieldTriggerConfig>;
|
|
785
742
|
type?: 'treecombo';
|
|
786
743
|
/**
|
|
787
744
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
788
745
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
789
746
|
* values are used as the class names.
|
|
790
|
-
* ...
|
|
791
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
|
|
747
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
|
|
792
748
|
*/
|
|
793
749
|
ui?: string | object;
|
|
794
750
|
/**
|
|
@@ -808,8 +764,7 @@ export declare type BryntumTreeComboProps = {
|
|
|
808
764
|
/**
|
|
809
765
|
* Field used for item value when populating from store. Setting this to `null` will
|
|
810
766
|
* yield the selected record as the Combo's [value](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#property-value).
|
|
811
|
-
* ...
|
|
812
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-valueField)
|
|
767
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-valueField)
|
|
813
768
|
*/
|
|
814
769
|
valueField?: string | null;
|
|
815
770
|
/**
|
|
@@ -825,14 +780,12 @@ export declare type BryntumTreeComboProps = {
|
|
|
825
780
|
width?: string | number;
|
|
826
781
|
/**
|
|
827
782
|
* The x position for the widget.
|
|
828
|
-
* ...
|
|
829
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
|
|
783
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
|
|
830
784
|
*/
|
|
831
785
|
x?: number;
|
|
832
786
|
/**
|
|
833
787
|
* The y position for the widget.
|
|
834
|
-
* ...
|
|
835
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
|
|
788
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
|
|
836
789
|
*/
|
|
837
790
|
y?: number;
|
|
838
791
|
};
|
|
@@ -860,6 +813,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
860
813
|
cacheLastResult: number | string | Duration | DurationConfig;
|
|
861
814
|
caseSensitive: boolean;
|
|
862
815
|
centered: boolean;
|
|
816
|
+
checkValidity: ((field: Field) => void) | string;
|
|
863
817
|
chipView: ChipViewConfig;
|
|
864
818
|
clearable: boolean | FieldTriggerConfig;
|
|
865
819
|
clearTextOnPickerHide: boolean;
|
|
@@ -868,7 +822,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
868
822
|
color: Color;
|
|
869
823
|
config: object;
|
|
870
824
|
constrainTo: HTMLElement | Widget | Rectangle;
|
|
871
|
-
container: Record<string, GridContainerItemConfig> | GridContainerItemConfig[] | FieldContainerConfig
|
|
825
|
+
container: Record<string, GridContainerItemConfig> | GridContainerItemConfig[] | FieldContainerConfig;
|
|
872
826
|
containValues: boolean | string | ((field: Field) => boolean);
|
|
873
827
|
contentElementCls: string | object;
|
|
874
828
|
createOnUnmatched: ((name: string, combo: Combo) => Model) | string | boolean;
|
|
@@ -876,11 +830,9 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
876
830
|
defaultBindProperty: string;
|
|
877
831
|
detectCSSCompatibilityIssues: boolean;
|
|
878
832
|
displayField: string;
|
|
879
|
-
displayValueRenderer: (record: Model
|
|
833
|
+
displayValueRenderer: (record: Model, combo: Combo) => string | void;
|
|
880
834
|
dock: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
|
|
881
|
-
draggable: boolean |
|
|
882
|
-
handleSelector?: string;
|
|
883
|
-
};
|
|
835
|
+
draggable: boolean | object;
|
|
884
836
|
elementAttributes: Record<string, string | null>;
|
|
885
837
|
emptyText: string;
|
|
886
838
|
encodeFilterParams: (filters: object[]) => object[];
|
|
@@ -917,7 +869,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
917
869
|
labelWidth: string | number;
|
|
918
870
|
listCls: string;
|
|
919
871
|
listeners: TreeComboListeners;
|
|
920
|
-
listItemTpl: (record: Model
|
|
872
|
+
listItemTpl: (record: Model) => string | void;
|
|
921
873
|
localeClass: typeof Base;
|
|
922
874
|
localizable: boolean;
|
|
923
875
|
localizableProperties: string[];
|
|
@@ -926,9 +878,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
926
878
|
maxLength: number;
|
|
927
879
|
minChars: number;
|
|
928
880
|
minLength: number;
|
|
929
|
-
monitorResize: boolean |
|
|
930
|
-
immediate?: boolean;
|
|
931
|
-
};
|
|
881
|
+
monitorResize: boolean | object;
|
|
932
882
|
multiValueSeparator: string;
|
|
933
883
|
name: string;
|
|
934
884
|
overlayAnchor: boolean;
|
|
@@ -939,12 +889,8 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
939
889
|
primaryFilter: CollectionFilterConfig;
|
|
940
890
|
relayStoreEvents: boolean;
|
|
941
891
|
revertOnEscape: boolean;
|
|
942
|
-
ripple: boolean |
|
|
943
|
-
|
|
944
|
-
color?: string;
|
|
945
|
-
radius?: number;
|
|
946
|
-
clip?: string;
|
|
947
|
-
};
|
|
892
|
+
ripple: boolean | object;
|
|
893
|
+
role: string;
|
|
948
894
|
rootElement: ShadowRoot | HTMLElement;
|
|
949
895
|
scrollAction: 'hide' | 'realign' | null;
|
|
950
896
|
showAnimation: boolean | object;
|
|
@@ -1004,11 +950,9 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1004
950
|
width: number | string;
|
|
1005
951
|
x: number;
|
|
1006
952
|
y: number;
|
|
1007
|
-
anchorSize: number[];
|
|
1008
953
|
content: string;
|
|
1009
|
-
focusVisible: boolean;
|
|
1010
954
|
formula: string;
|
|
1011
|
-
html: string | ((widget: Widget) =>
|
|
955
|
+
html: string | ((widget: Widget) => void) | DomConfig | DomConfig[] | VueConfig | ReactJSX;
|
|
1012
956
|
input: HTMLElement;
|
|
1013
957
|
parent: Widget;
|
|
1014
958
|
scrollable: Scroller;
|
|
@@ -1042,8 +986,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1042
986
|
onBeforeShow: any;
|
|
1043
987
|
/**
|
|
1044
988
|
* Fires when any other event is fired from the object.
|
|
1045
|
-
* ...
|
|
1046
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-catchAll)
|
|
989
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-catchAll)
|
|
1047
990
|
* @param {object} event Event object
|
|
1048
991
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
1049
992
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -1063,8 +1006,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1063
1006
|
onChange: any;
|
|
1064
1007
|
/**
|
|
1065
1008
|
* Fired when this field is [cleared](https://bryntum.com/products/grid/docs/api/Core/widget/Field#function-clear).
|
|
1066
|
-
* ...
|
|
1067
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-clear)
|
|
1009
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-clear)
|
|
1068
1010
|
* @param {object} event Event object
|
|
1069
1011
|
* @param {Core.widget.Field,any} event.source This Field
|
|
1070
1012
|
*/
|
|
@@ -1123,8 +1065,7 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1123
1065
|
/**
|
|
1124
1066
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
1125
1067
|
* achieves visibility.
|
|
1126
|
-
* ...
|
|
1127
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
|
|
1068
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
|
|
1128
1069
|
* @param {object} event Event object
|
|
1129
1070
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
1130
1071
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -1177,6 +1118,14 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1177
1118
|
* Create and append the underlying widget
|
|
1178
1119
|
*/
|
|
1179
1120
|
ngOnInit(): void;
|
|
1121
|
+
/**
|
|
1122
|
+
* Extracts all @font-face declarations from a shadow root's stylesheets and adds them to
|
|
1123
|
+
* document.head as a single <style> element. This is needed because @font-face rules inside
|
|
1124
|
+
* a shadow root are not reliably included in document.fonts across all browsers, causing
|
|
1125
|
+
* Bryntum's CSS compatibility check to incorrectly report missing fonts.
|
|
1126
|
+
* Safe to call multiple times — the extraction runs only once per page.
|
|
1127
|
+
*/
|
|
1128
|
+
private static ensureFontsInDocument;
|
|
1180
1129
|
/**
|
|
1181
1130
|
* Watch for changes
|
|
1182
1131
|
* @param changes
|
|
@@ -1187,5 +1136,5 @@ export declare class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1187
1136
|
*/
|
|
1188
1137
|
ngOnDestroy(): void;
|
|
1189
1138
|
static ɵfac: i0.ɵɵFactoryDeclaration<BryntumTreeComboComponent, never>;
|
|
1190
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<BryntumTreeComboComponent, "bryntum-tree-combo", never, { "adopt": "adopt"; "align": "align"; "anchor": "anchor"; "ariaDescription": "ariaDescription"; "ariaLabel": "ariaLabel"; "autoComplete": "autoComplete"; "autoExpand": "autoExpand"; "autoSelect": "autoSelect"; "bubbleEvents": "bubbleEvents"; "cacheLastResult": "cacheLastResult"; "caseSensitive": "caseSensitive"; "centered": "centered"; "chipView": "chipView"; "clearable": "clearable"; "clearTextOnPickerHide": "clearTextOnPickerHide"; "clearTextOnSelection": "clearTextOnSelection"; "clearWhenInputEmpty": "clearWhenInputEmpty"; "color": "color"; "config": "config"; "constrainTo": "constrainTo"; "container": "container"; "containValues": "containValues"; "contentElementCls": "contentElementCls"; "createOnUnmatched": "createOnUnmatched"; "dataField": "dataField"; "defaultBindProperty": "defaultBindProperty"; "detectCSSCompatibilityIssues": "detectCSSCompatibilityIssues"; "displayField": "displayField"; "displayValueRenderer": "displayValueRenderer"; "dock": "dock"; "draggable": "draggable"; "elementAttributes": "elementAttributes"; "emptyText": "emptyText"; "encodeFilterParams": "encodeFilterParams"; "filterOnEnter": "filterOnEnter"; "filterParamName": "filterParamName"; "filterSelected": "filterSelected"; "floating": "floating"; "hideAnimation": "hideAnimation"; "hidePickerOnSelect": "hidePickerOnSelect"; "hideTrigger": "hideTrigger"; "highlightExternalChange": "highlightExternalChange"; "hint": "hint"; "hintHtml": "hintHtml"; "ignoreParentReadOnly": "ignoreParentReadOnly"; "inline": "inline"; "inlinePicker": "inlinePicker"; "inputAlign": "inputAlign"; "inputAttributes": "inputAttributes"; "inputTag": "inputTag"; "inputType": "inputType"; "inputWidth": "inputWidth"; "items": "items"; "keyStrokeChangeDelay": "keyStrokeChangeDelay"; "keyStrokeFilterDelay": "keyStrokeFilterDelay"; "labelCls": "labelCls"; "labelPosition": "labelPosition"; "labels": "labels"; "labelWidth": "labelWidth"; "listCls": "listCls"; "listeners": "listeners"; "listItemTpl": "listItemTpl"; "localeClass": "localeClass"; "localizable": "localizable"; "localizableProperties": "localizableProperties"; "maskDefaults": "maskDefaults"; "masked": "masked"; "maxLength": "maxLength"; "minChars": "minChars"; "minLength": "minLength"; "monitorResize": "monitorResize"; "multiValueSeparator": "multiValueSeparator"; "name": "name"; "overlayAnchor": "overlayAnchor"; "pickerAlignElement": "pickerAlignElement"; "pickerWidth": "pickerWidth"; "positioned": "positioned"; "preventTooltipOnTouch": "preventTooltipOnTouch"; "primaryFilter": "primaryFilter"; "relayStoreEvents": "relayStoreEvents"; "revertOnEscape": "revertOnEscape"; "ripple": "ripple"; "rootElement": "rootElement"; "scrollAction": "scrollAction"; "showAnimation": "showAnimation"; "showTooltipWhenDisabled": "showTooltipWhenDisabled"; "skipValidation": "skipValidation"; "spellCheck": "spellCheck"; "tab": "tab"; "tabIndex": "tabIndex"; "textAlign": "textAlign"; "title": "title"; "triggerAction": "triggerAction"; "type": "type"; "ui": "ui"; "validateFilter": "validateFilter"; "validateOnInput": "validateOnInput"; "valueField": "valueField"; "weight": "weight"; "alignSelf": "alignSelf"; "appendTo": "appendTo"; "badge": "badge"; "callOnFunctions": "callOnFunctions"; "catchEventHandlerExceptions": "catchEventHandlerExceptions"; "cls": "cls"; "column": "column"; "dataset": "dataset"; "disabled": "disabled"; "editable": "editable"; "extraData": "extraData"; "filterOperator": "filterOperator"; "flex": "flex"; "height": "height"; "hidden": "hidden"; "id": "id"; "insertBefore": "insertBefore"; "insertFirst": "insertFirst"; "keyMap": "keyMap"; "label": "label"; "margin": "margin"; "maxHeight": "maxHeight"; "maximizeOnMobile": "maximizeOnMobile"; "maxWidth": "maxWidth"; "minHeight": "minHeight"; "minWidth": "minWidth"; "multiSelect": "multiSelect"; "picker": "picker"; "placeholder": "placeholder"; "readOnly": "readOnly"; "rendition": "rendition"; "required": "required"; "rtl": "rtl"; "showRequiredIndicator": "showRequiredIndicator"; "span": "span"; "store": "store"; "tooltip": "tooltip"; "triggers": "triggers"; "value": "value"; "width": "width"; "x": "x"; "y": "y"; "
|
|
1139
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<BryntumTreeComboComponent, "bryntum-tree-combo", never, { "adopt": "adopt"; "align": "align"; "anchor": "anchor"; "ariaDescription": "ariaDescription"; "ariaLabel": "ariaLabel"; "autoComplete": "autoComplete"; "autoExpand": "autoExpand"; "autoSelect": "autoSelect"; "bubbleEvents": "bubbleEvents"; "cacheLastResult": "cacheLastResult"; "caseSensitive": "caseSensitive"; "centered": "centered"; "checkValidity": "checkValidity"; "chipView": "chipView"; "clearable": "clearable"; "clearTextOnPickerHide": "clearTextOnPickerHide"; "clearTextOnSelection": "clearTextOnSelection"; "clearWhenInputEmpty": "clearWhenInputEmpty"; "color": "color"; "config": "config"; "constrainTo": "constrainTo"; "container": "container"; "containValues": "containValues"; "contentElementCls": "contentElementCls"; "createOnUnmatched": "createOnUnmatched"; "dataField": "dataField"; "defaultBindProperty": "defaultBindProperty"; "detectCSSCompatibilityIssues": "detectCSSCompatibilityIssues"; "displayField": "displayField"; "displayValueRenderer": "displayValueRenderer"; "dock": "dock"; "draggable": "draggable"; "elementAttributes": "elementAttributes"; "emptyText": "emptyText"; "encodeFilterParams": "encodeFilterParams"; "filterOnEnter": "filterOnEnter"; "filterParamName": "filterParamName"; "filterSelected": "filterSelected"; "floating": "floating"; "hideAnimation": "hideAnimation"; "hidePickerOnSelect": "hidePickerOnSelect"; "hideTrigger": "hideTrigger"; "highlightExternalChange": "highlightExternalChange"; "hint": "hint"; "hintHtml": "hintHtml"; "ignoreParentReadOnly": "ignoreParentReadOnly"; "inline": "inline"; "inlinePicker": "inlinePicker"; "inputAlign": "inputAlign"; "inputAttributes": "inputAttributes"; "inputTag": "inputTag"; "inputType": "inputType"; "inputWidth": "inputWidth"; "items": "items"; "keyStrokeChangeDelay": "keyStrokeChangeDelay"; "keyStrokeFilterDelay": "keyStrokeFilterDelay"; "labelCls": "labelCls"; "labelPosition": "labelPosition"; "labels": "labels"; "labelWidth": "labelWidth"; "listCls": "listCls"; "listeners": "listeners"; "listItemTpl": "listItemTpl"; "localeClass": "localeClass"; "localizable": "localizable"; "localizableProperties": "localizableProperties"; "maskDefaults": "maskDefaults"; "masked": "masked"; "maxLength": "maxLength"; "minChars": "minChars"; "minLength": "minLength"; "monitorResize": "monitorResize"; "multiValueSeparator": "multiValueSeparator"; "name": "name"; "overlayAnchor": "overlayAnchor"; "pickerAlignElement": "pickerAlignElement"; "pickerWidth": "pickerWidth"; "positioned": "positioned"; "preventTooltipOnTouch": "preventTooltipOnTouch"; "primaryFilter": "primaryFilter"; "relayStoreEvents": "relayStoreEvents"; "revertOnEscape": "revertOnEscape"; "ripple": "ripple"; "role": "role"; "rootElement": "rootElement"; "scrollAction": "scrollAction"; "showAnimation": "showAnimation"; "showTooltipWhenDisabled": "showTooltipWhenDisabled"; "skipValidation": "skipValidation"; "spellCheck": "spellCheck"; "tab": "tab"; "tabIndex": "tabIndex"; "textAlign": "textAlign"; "title": "title"; "triggerAction": "triggerAction"; "type": "type"; "ui": "ui"; "validateFilter": "validateFilter"; "validateOnInput": "validateOnInput"; "valueField": "valueField"; "weight": "weight"; "alignSelf": "alignSelf"; "appendTo": "appendTo"; "badge": "badge"; "callOnFunctions": "callOnFunctions"; "catchEventHandlerExceptions": "catchEventHandlerExceptions"; "cls": "cls"; "column": "column"; "dataset": "dataset"; "disabled": "disabled"; "editable": "editable"; "extraData": "extraData"; "filterOperator": "filterOperator"; "flex": "flex"; "height": "height"; "hidden": "hidden"; "id": "id"; "insertBefore": "insertBefore"; "insertFirst": "insertFirst"; "keyMap": "keyMap"; "label": "label"; "margin": "margin"; "maxHeight": "maxHeight"; "maximizeOnMobile": "maximizeOnMobile"; "maxWidth": "maxWidth"; "minHeight": "minHeight"; "minWidth": "minWidth"; "multiSelect": "multiSelect"; "picker": "picker"; "placeholder": "placeholder"; "readOnly": "readOnly"; "rendition": "rendition"; "required": "required"; "rtl": "rtl"; "showRequiredIndicator": "showRequiredIndicator"; "span": "span"; "store": "store"; "tooltip": "tooltip"; "triggers": "triggers"; "value": "value"; "width": "width"; "x": "x"; "y": "y"; "content": "content"; "formula": "formula"; "html": "html"; "input": "input"; "parent": "parent"; "scrollable": "scrollable"; }, { "onAction": "onAction"; "onBeforeDestroy": "onBeforeDestroy"; "onBeforeHide": "onBeforeHide"; "onBeforeShow": "onBeforeShow"; "onCatchAll": "onCatchAll"; "onChange": "onChange"; "onClear": "onClear"; "onDestroy": "onDestroy"; "onElementCreated": "onElementCreated"; "onFocusIn": "onFocusIn"; "onFocusOut": "onFocusOut"; "onHide": "onHide"; "onInput": "onInput"; "onPaint": "onPaint"; "onReadOnly": "onReadOnly"; "onRecompose": "onRecompose"; "onResize": "onResize"; "onSelect": "onSelect"; "onShow": "onShow"; "onTrigger": "onTrigger"; }, never, never>;
|
|
1191
1140
|
}
|