@bryntum/grid-react-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/lib/BryntumAIFilterField.d.ts +9 -16
- package/lib/BryntumAIFilterField.js +2 -2
- package/lib/BryntumAIFilterField.js.map +1 -1
- package/lib/BryntumChecklistFilterCombo.d.ts +12 -19
- package/lib/BryntumChecklistFilterCombo.js +2 -2
- package/lib/BryntumChecklistFilterCombo.js.map +1 -1
- package/lib/BryntumGrid.d.ts +47 -58
- package/lib/BryntumGrid.js +2 -2
- package/lib/BryntumGrid.js.map +1 -1
- package/lib/BryntumGridBase.d.ts +47 -58
- package/lib/BryntumGridBase.js +2 -2
- package/lib/BryntumGridBase.js.map +1 -1
- package/lib/BryntumGridChartDesigner.d.ts +7 -15
- package/lib/BryntumGridChartDesigner.js +1 -2
- package/lib/BryntumGridChartDesigner.js.map +1 -1
- package/lib/BryntumGridFieldFilterPicker.d.ts +8 -15
- package/lib/BryntumGridFieldFilterPicker.js +2 -5
- package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
- package/lib/BryntumGridFieldFilterPickerGroup.d.ts +9 -16
- package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
- package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumGroupBar.d.ts +8 -16
- package/lib/BryntumGroupBar.js +1 -2
- package/lib/BryntumGroupBar.js.map +1 -1
- package/lib/BryntumTreeCombo.d.ts +12 -19
- package/lib/BryntumTreeCombo.js +2 -2
- package/lib/BryntumTreeCombo.js.map +1 -1
- package/lib/BryntumTreeGrid.d.ts +47 -58
- package/lib/BryntumTreeGrid.js +2 -2
- package/lib/BryntumTreeGrid.js.map +1 -1
- package/lib/WrapperHelper.js +2 -2
- package/lib/WrapperHelper.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumAIFilterField.tsx +85 -120
- package/src/BryntumChecklistFilterCombo.tsx +102 -151
- package/src/BryntumGrid.tsx +229 -316
- package/src/BryntumGridBase.tsx +229 -316
- package/src/BryntumGridChartDesigner.tsx +60 -96
- package/src/BryntumGridFieldFilterPicker.tsx +83 -133
- package/src/BryntumGridFieldFilterPickerGroup.tsx +83 -132
- package/src/BryntumGroupBar.tsx +67 -107
- package/src/BryntumTreeCombo.tsx +103 -153
- package/src/BryntumTreeGrid.tsx +229 -316
- package/src/WrapperHelper.tsx +2 -2
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
5
|
import React, { RefObject } from 'react';
|
|
6
|
-
import { AlignSpec, Base, Color, DomConfig, Field,
|
|
6
|
+
import { AlignSpec, Base, Color, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
7
7
|
import { AIFilterField, AIFilterFieldListeners, GridContainerItemConfig, Grid } from '@bryntum/grid-thin';
|
|
8
8
|
|
|
9
9
|
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
@@ -13,14 +13,12 @@ export type BryntumAIFilterFieldProps = {
|
|
|
13
13
|
/**
|
|
14
14
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
15
15
|
* content will be placed inside this element.
|
|
16
|
-
* ...
|
|
17
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-adopt)
|
|
16
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-adopt)
|
|
18
17
|
*/
|
|
19
18
|
adopt? : HTMLElement|string
|
|
20
19
|
/**
|
|
21
20
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
22
|
-
* ...
|
|
23
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-align)
|
|
21
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-align)
|
|
24
22
|
*/
|
|
25
23
|
align? : AlignSpec|string
|
|
26
24
|
/**
|
|
@@ -42,15 +40,13 @@ export type BryntumAIFilterFieldProps = {
|
|
|
42
40
|
/**
|
|
43
41
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
44
42
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
45
|
-
* ...
|
|
46
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ariaDescription)
|
|
43
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ariaDescription)
|
|
47
44
|
*/
|
|
48
45
|
ariaDescription? : string
|
|
49
46
|
/**
|
|
50
47
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
51
48
|
* the `aria-label` attribute.
|
|
52
|
-
* ...
|
|
53
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ariaLabel)
|
|
49
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ariaLabel)
|
|
54
50
|
*/
|
|
55
51
|
ariaLabel? : string
|
|
56
52
|
/**
|
|
@@ -69,21 +65,18 @@ export type BryntumAIFilterFieldProps = {
|
|
|
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/AIFilterField#config-bubbleEvents)
|
|
68
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-bubbleEvents)
|
|
74
69
|
*/
|
|
75
70
|
bubbleEvents? : object
|
|
76
71
|
/**
|
|
77
72
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
78
|
-
* ...
|
|
79
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-callOnFunctions)
|
|
73
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-callOnFunctions)
|
|
80
74
|
*/
|
|
81
75
|
callOnFunctions? : boolean
|
|
82
76
|
/**
|
|
83
77
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
84
78
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
85
|
-
* ...
|
|
86
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-catchEventHandlerExceptions)
|
|
79
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-catchEventHandlerExceptions)
|
|
87
80
|
*/
|
|
88
81
|
catchEventHandlerExceptions? : boolean
|
|
89
82
|
/**
|
|
@@ -91,6 +84,15 @@ export type BryntumAIFilterFieldProps = {
|
|
|
91
84
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
92
85
|
*/
|
|
93
86
|
centered? : boolean
|
|
87
|
+
/**
|
|
88
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
89
|
+
* 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)
|
|
90
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
91
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
92
|
+
* @param {Core.widget.Field} field The field being validated
|
|
93
|
+
* @returns {void}
|
|
94
|
+
*/
|
|
95
|
+
checkValidity? : ((field: Field) => void)|string
|
|
94
96
|
/**
|
|
95
97
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
96
98
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -106,15 +108,13 @@ export type BryntumAIFilterFieldProps = {
|
|
|
106
108
|
* Custom CSS classes to add to element.
|
|
107
109
|
* May be specified as a space separated string, or as an object in which property names
|
|
108
110
|
* with truthy values are used as the class names:
|
|
109
|
-
* ...
|
|
110
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-cls)
|
|
111
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-cls)
|
|
111
112
|
*/
|
|
112
113
|
cls? : string|object
|
|
113
114
|
/**
|
|
114
115
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
115
116
|
* `style` block.
|
|
116
|
-
* ...
|
|
117
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
|
|
117
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
|
|
118
118
|
*/
|
|
119
119
|
color? : Color
|
|
120
120
|
/**
|
|
@@ -131,15 +131,13 @@ export type BryntumAIFilterFieldProps = {
|
|
|
131
131
|
* The configuration for additional items associated to this field. This is typically used to add contextual
|
|
132
132
|
* fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
|
|
133
133
|
* these classes for examples of nested fields.
|
|
134
|
-
* ...
|
|
135
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-container)
|
|
134
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-container)
|
|
136
135
|
*/
|
|
137
|
-
container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
|
|
136
|
+
container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
|
|
138
137
|
/**
|
|
139
138
|
* The config controls how the value of nested items are handled when a parent container gets or sets its
|
|
140
139
|
* [values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
|
|
141
|
-
* ...
|
|
142
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-containValues)
|
|
140
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-containValues)
|
|
143
141
|
* @param {Core.widget.Field} field Field instance
|
|
144
142
|
* @returns {boolean}
|
|
145
143
|
*/
|
|
@@ -148,8 +146,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
148
146
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
149
147
|
* May be specified as a space separated string, or as an object in which property names
|
|
150
148
|
* with truthy values are used as the class names:
|
|
151
|
-
* ...
|
|
152
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-contentElementCls)
|
|
149
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-contentElementCls)
|
|
153
150
|
*/
|
|
154
151
|
contentElementCls? : string|object
|
|
155
152
|
/**
|
|
@@ -167,16 +164,15 @@ export type BryntumAIFilterFieldProps = {
|
|
|
167
164
|
*/
|
|
168
165
|
defaultBindProperty? : string
|
|
169
166
|
/**
|
|
170
|
-
* Check for CSS compatibility issues
|
|
171
|
-
*
|
|
172
|
-
* [
|
|
167
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
168
|
+
* checks:
|
|
169
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-detectCSSCompatibilityIssues)
|
|
173
170
|
*/
|
|
174
171
|
detectCSSCompatibilityIssues? : boolean
|
|
175
172
|
/**
|
|
176
173
|
* 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
|
|
177
174
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
178
|
-
* ...
|
|
179
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-disabled)
|
|
175
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-disabled)
|
|
180
176
|
*/
|
|
181
177
|
disabled? : boolean|'inert'
|
|
182
178
|
/**
|
|
@@ -184,33 +180,28 @@ export type BryntumAIFilterFieldProps = {
|
|
|
184
180
|
* [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
185
181
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
186
182
|
* body. Such widgets are called "edge strips".
|
|
187
|
-
* ...
|
|
188
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-dock)
|
|
183
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-dock)
|
|
189
184
|
*/
|
|
190
185
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
191
186
|
/**
|
|
192
187
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
193
188
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
194
189
|
* property which controls when a drag should start.
|
|
195
|
-
* ...
|
|
196
|
-
*
|
|
190
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
|
|
191
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
197
192
|
*/
|
|
198
|
-
draggable? : boolean|
|
|
199
|
-
handleSelector?: string
|
|
200
|
-
}
|
|
193
|
+
draggable? : boolean|object
|
|
201
194
|
/**
|
|
202
195
|
* Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
|
|
203
196
|
* [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
|
|
204
197
|
* but not to type one in the field.
|
|
205
|
-
* ...
|
|
206
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-editable)
|
|
198
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-editable)
|
|
207
199
|
*/
|
|
208
200
|
editable? : boolean
|
|
209
201
|
/**
|
|
210
202
|
* An object specifying attributes to assign to the root element of this widget.
|
|
211
203
|
* Set `null` value to attribute to remove it.
|
|
212
|
-
* ...
|
|
213
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-elementAttributes)
|
|
204
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-elementAttributes)
|
|
214
205
|
*/
|
|
215
206
|
elementAttributes? : Record<string, string|null>
|
|
216
207
|
extraData? : any
|
|
@@ -239,8 +230,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
239
230
|
hidden? : boolean
|
|
240
231
|
/**
|
|
241
232
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
242
|
-
* ...
|
|
243
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hideAnimation)
|
|
233
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hideAnimation)
|
|
244
234
|
*/
|
|
245
235
|
hideAnimation? : boolean|object
|
|
246
236
|
/**
|
|
@@ -250,8 +240,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
250
240
|
/**
|
|
251
241
|
* An optional string to display inside the input field as an overlay. This can be useful for displaying
|
|
252
242
|
* a field's units.
|
|
253
|
-
* ...
|
|
254
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hint)
|
|
243
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hint)
|
|
255
244
|
* @param {object} data A data object
|
|
256
245
|
* @param {Core.widget.Field} data.source A reference to the field instance
|
|
257
246
|
* @param {any} data.value The current value of the field
|
|
@@ -262,8 +251,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
262
251
|
* 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.
|
|
263
252
|
* Since this can allow malicious content to be executed, be sure not to include user-entered data or to
|
|
264
253
|
* encode such data (see [encodeHtml](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
|
|
265
|
-
* ...
|
|
266
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hintHtml)
|
|
254
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hintHtml)
|
|
267
255
|
* @param {object} data A data object
|
|
268
256
|
* @param {Core.widget.Field} data.source A reference to the field instance
|
|
269
257
|
* @param {any} data.value The current value of the field
|
|
@@ -276,16 +264,14 @@ export type BryntumAIFilterFieldProps = {
|
|
|
276
264
|
id? : string
|
|
277
265
|
/**
|
|
278
266
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
279
|
-
* ...
|
|
280
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ignoreParentReadOnly)
|
|
267
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ignoreParentReadOnly)
|
|
281
268
|
*/
|
|
282
269
|
ignoreParentReadOnly? : boolean
|
|
283
270
|
/**
|
|
284
271
|
* Set this config to `true` to always display items horizontally along with this field. This assigns an
|
|
285
272
|
* [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
|
|
286
273
|
* [container](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-container).
|
|
287
|
-
* ...
|
|
288
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-inline)
|
|
274
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-inline)
|
|
289
275
|
*/
|
|
290
276
|
inline? : boolean
|
|
291
277
|
/**
|
|
@@ -325,16 +311,14 @@ export type BryntumAIFilterFieldProps = {
|
|
|
325
311
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
326
312
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
327
313
|
* are the name of the instance method to call when the keystroke is received.
|
|
328
|
-
* ...
|
|
329
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyMap)
|
|
314
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyMap)
|
|
330
315
|
*/
|
|
331
316
|
keyMap? : Record<string, KeyMapConfig>
|
|
332
317
|
/**
|
|
333
318
|
* The delay in milliseconds to wait after the last keystroke before triggering a change event.
|
|
334
319
|
* Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
|
|
335
320
|
* immediate feedback, change will still be triggered on blur).
|
|
336
|
-
* ...
|
|
337
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyStrokeChangeDelay)
|
|
321
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyStrokeChangeDelay)
|
|
338
322
|
*/
|
|
339
323
|
keyStrokeChangeDelay? : number
|
|
340
324
|
/**
|
|
@@ -347,15 +331,15 @@ export type BryntumAIFilterFieldProps = {
|
|
|
347
331
|
labelCls? : string|object
|
|
348
332
|
/**
|
|
349
333
|
* Label position, either 'before' the field or 'above' the field
|
|
350
|
-
* ...
|
|
351
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labelPosition)
|
|
334
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labelPosition)
|
|
352
335
|
*/
|
|
353
336
|
labelPosition? : 'before'|'above'|null
|
|
354
337
|
/**
|
|
355
338
|
* The labels to add either before or after the input field.
|
|
356
339
|
* Each label may have the following properties:
|
|
357
|
-
* ...
|
|
358
|
-
*
|
|
340
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labels)
|
|
341
|
+
* @property {string} html Label text
|
|
342
|
+
* @property {'start','end'} align Which end of the file the label should go
|
|
359
343
|
*/
|
|
360
344
|
labels? : object[]
|
|
361
345
|
/**
|
|
@@ -364,16 +348,14 @@ export type BryntumAIFilterFieldProps = {
|
|
|
364
348
|
labelWidth? : string|number
|
|
365
349
|
/**
|
|
366
350
|
* The listener set for this object.
|
|
367
|
-
* ...
|
|
368
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-listeners)
|
|
351
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-listeners)
|
|
369
352
|
*/
|
|
370
353
|
listeners? : AIFilterFieldListeners
|
|
371
354
|
/**
|
|
372
355
|
* A class translations of which are used for translating this entity.
|
|
373
356
|
* This is often used when translations of an item are defined on its container class.
|
|
374
357
|
* For example:
|
|
375
|
-
* ...
|
|
376
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localeClass)
|
|
358
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localeClass)
|
|
377
359
|
*/
|
|
378
360
|
localeClass? : typeof Base
|
|
379
361
|
/**
|
|
@@ -385,8 +367,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
385
367
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
386
368
|
* you could use 'localeKey' meta configuration.
|
|
387
369
|
* Example:
|
|
388
|
-
* ...
|
|
389
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localizableProperties)
|
|
370
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localizableProperties)
|
|
390
371
|
*/
|
|
391
372
|
localizableProperties? : string[]
|
|
392
373
|
/**
|
|
@@ -412,8 +393,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
412
393
|
maxHeight? : string|number
|
|
413
394
|
/**
|
|
414
395
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
415
|
-
* ...
|
|
416
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-maximizeOnMobile)
|
|
396
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-maximizeOnMobile)
|
|
417
397
|
*/
|
|
418
398
|
maximizeOnMobile? : number|string
|
|
419
399
|
/**
|
|
@@ -443,18 +423,15 @@ export type BryntumAIFilterFieldProps = {
|
|
|
443
423
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
444
424
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
445
425
|
* layout.
|
|
446
|
-
* ...
|
|
447
|
-
*
|
|
426
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-monitorResize)
|
|
427
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
448
428
|
*/
|
|
449
|
-
monitorResize? : boolean|
|
|
450
|
-
immediate?: boolean
|
|
451
|
-
}
|
|
429
|
+
monitorResize? : boolean|object
|
|
452
430
|
/**
|
|
453
431
|
* Name of the field which is used as a key to get/set values from/to the field.
|
|
454
432
|
* Used prior to [ref](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
|
|
455
433
|
* [Container.values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
|
|
456
|
-
* ...
|
|
457
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-name)
|
|
434
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-name)
|
|
458
435
|
*/
|
|
459
436
|
name? : string
|
|
460
437
|
/**
|
|
@@ -465,8 +442,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
465
442
|
* 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
|
|
466
443
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
467
444
|
* widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
468
|
-
* ...
|
|
469
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-positioned)
|
|
445
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-positioned)
|
|
470
446
|
*/
|
|
471
447
|
positioned? : boolean
|
|
472
448
|
/**
|
|
@@ -481,15 +457,13 @@ export type BryntumAIFilterFieldProps = {
|
|
|
481
457
|
/**
|
|
482
458
|
* Makes the field unmodifiable by user action. The input area is not editable, and triggers
|
|
483
459
|
* are unresponsive.
|
|
484
|
-
* ...
|
|
485
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-readOnly)
|
|
460
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-readOnly)
|
|
486
461
|
*/
|
|
487
462
|
readOnly? : boolean
|
|
488
463
|
relayStoreEvents? : boolean
|
|
489
464
|
/**
|
|
490
465
|
* Predefined style to use for the field. Possible values are:
|
|
491
|
-
* ...
|
|
492
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rendition)
|
|
466
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rendition)
|
|
493
467
|
*/
|
|
494
468
|
rendition? : 'outlined'|'filled'|string
|
|
495
469
|
/**
|
|
@@ -508,23 +482,26 @@ export type BryntumAIFilterFieldProps = {
|
|
|
508
482
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
509
483
|
* [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
|
|
510
484
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
511
|
-
* ...
|
|
512
|
-
* [
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
485
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ripple)
|
|
486
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
487
|
+
* @property {string} [color] A CSS color name or specification.
|
|
488
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
489
|
+
* @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.
|
|
490
|
+
*/
|
|
491
|
+
ripple? : boolean|object
|
|
492
|
+
/**
|
|
493
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
494
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
495
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-role)
|
|
496
|
+
*/
|
|
497
|
+
role? : string
|
|
520
498
|
/**
|
|
521
499
|
* 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`
|
|
522
500
|
*/
|
|
523
501
|
rootElement? : ShadowRoot|HTMLElement
|
|
524
502
|
/**
|
|
525
503
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
526
|
-
* ...
|
|
527
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rtl)
|
|
504
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rtl)
|
|
528
505
|
*/
|
|
529
506
|
rtl? : boolean
|
|
530
507
|
/**
|
|
@@ -534,8 +511,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
534
511
|
scrollAction? : 'hide'|'realign'|null
|
|
535
512
|
/**
|
|
536
513
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
537
|
-
* ...
|
|
538
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-showAnimation)
|
|
514
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-showAnimation)
|
|
539
515
|
*/
|
|
540
516
|
showAnimation? : boolean|object
|
|
541
517
|
/**
|
|
@@ -564,8 +540,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
564
540
|
* 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
|
|
565
541
|
* [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
|
|
566
542
|
* this widget:
|
|
567
|
-
* ...
|
|
568
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tab)
|
|
543
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tab)
|
|
569
544
|
*/
|
|
570
545
|
tab? : boolean|TabConfig
|
|
571
546
|
/**
|
|
@@ -573,14 +548,12 @@ export type BryntumAIFilterFieldProps = {
|
|
|
573
548
|
* is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
|
|
574
549
|
* (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
|
|
575
550
|
* to the element programmatically.
|
|
576
|
-
* ...
|
|
577
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tabIndex)
|
|
551
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tabIndex)
|
|
578
552
|
*/
|
|
579
553
|
tabIndex? : number
|
|
580
554
|
/**
|
|
581
555
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
582
|
-
* ...
|
|
583
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-textAlign)
|
|
556
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-textAlign)
|
|
584
557
|
*/
|
|
585
558
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
586
559
|
/**
|
|
@@ -589,24 +562,21 @@ export type BryntumAIFilterFieldProps = {
|
|
|
589
562
|
title? : string
|
|
590
563
|
/**
|
|
591
564
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
592
|
-
* ...
|
|
593
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tooltip)
|
|
565
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tooltip)
|
|
594
566
|
*/
|
|
595
567
|
tooltip? : string|TooltipConfig|null
|
|
596
568
|
/**
|
|
597
569
|
* The triggers to add either before or after the input field. Each property name is the reference by which
|
|
598
570
|
* an instantiated Trigger Widget may be retrieved from the live `triggers` property.
|
|
599
|
-
* ...
|
|
600
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-triggers)
|
|
571
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-triggers)
|
|
601
572
|
*/
|
|
602
|
-
triggers? : Record<string, FieldTriggerConfig
|
|
573
|
+
triggers? : Record<string, FieldTriggerConfig>
|
|
603
574
|
type? : 'aifilterfield'
|
|
604
575
|
/**
|
|
605
576
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
606
577
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
607
578
|
* values are used as the class names.
|
|
608
|
-
* ...
|
|
609
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ui)
|
|
579
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ui)
|
|
610
580
|
*/
|
|
611
581
|
ui? : string|object
|
|
612
582
|
/**
|
|
@@ -631,14 +601,12 @@ export type BryntumAIFilterFieldProps = {
|
|
|
631
601
|
width? : string|number
|
|
632
602
|
/**
|
|
633
603
|
* The x position for the widget.
|
|
634
|
-
* ...
|
|
635
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-x)
|
|
604
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-x)
|
|
636
605
|
*/
|
|
637
606
|
x? : number
|
|
638
607
|
/**
|
|
639
608
|
* The y position for the widget.
|
|
640
|
-
* ...
|
|
641
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-y)
|
|
609
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-y)
|
|
642
610
|
*/
|
|
643
611
|
y? : number
|
|
644
612
|
|
|
@@ -668,7 +636,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
668
636
|
* @param {object} event Event object
|
|
669
637
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
670
638
|
*/
|
|
671
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
639
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
672
640
|
/**
|
|
673
641
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
674
642
|
* @param {object} event Event object
|
|
@@ -677,8 +645,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
677
645
|
onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
|
|
678
646
|
/**
|
|
679
647
|
* Fires when any other event is fired from the object.
|
|
680
|
-
* ...
|
|
681
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-catchAll)
|
|
648
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-catchAll)
|
|
682
649
|
* @param {object} event Event object
|
|
683
650
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
684
651
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -698,8 +665,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
698
665
|
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
|
|
699
666
|
/**
|
|
700
667
|
* Fired when this field is [cleared](https://bryntum.com/products/grid/docs/api/Core/widget/Field#function-clear).
|
|
701
|
-
* ...
|
|
702
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-clear)
|
|
668
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-clear)
|
|
703
669
|
* @param {object} event Event object
|
|
704
670
|
* @param {Core.widget.Field,any} event.source This Field
|
|
705
671
|
*/
|
|
@@ -757,8 +723,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
757
723
|
/**
|
|
758
724
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
759
725
|
* achieves visibility.
|
|
760
|
-
* ...
|
|
761
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-paint)
|
|
726
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-paint)
|
|
762
727
|
* @param {object} event Event object
|
|
763
728
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
764
729
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -819,6 +784,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
|
|
|
819
784
|
'autoSelect',
|
|
820
785
|
'bubbleEvents',
|
|
821
786
|
'centered',
|
|
787
|
+
'checkValidity',
|
|
822
788
|
'clearable',
|
|
823
789
|
'client',
|
|
824
790
|
'color',
|
|
@@ -866,6 +832,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
|
|
|
866
832
|
'relayStoreEvents',
|
|
867
833
|
'revertOnEscape',
|
|
868
834
|
'ripple',
|
|
835
|
+
'role',
|
|
869
836
|
'rootElement',
|
|
870
837
|
'scrollAction',
|
|
871
838
|
'showAnimation',
|
|
@@ -943,9 +910,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
|
|
|
943
910
|
];
|
|
944
911
|
|
|
945
912
|
static propertyNames = [
|
|
946
|
-
'anchorSize',
|
|
947
913
|
'content',
|
|
948
|
-
'focusVisible',
|
|
949
914
|
'formula',
|
|
950
915
|
'html',
|
|
951
916
|
'input',
|