@bryntum/core-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.
Files changed (204) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +262 -0
  2. package/lib/BryntumBooleanCombo.js +205 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +9 -17
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +9 -16
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +19 -23
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +10 -17
  14. package/lib/BryntumCheckbox.js +2 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +12 -24
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +8 -16
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +12 -23
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +9 -16
  26. package/lib/BryntumColorField.js +2 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +12 -19
  29. package/lib/BryntumCombo.js +2 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +8 -15
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +9 -16
  35. package/lib/BryntumDateField.js +2 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +12 -23
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +12 -19
  41. package/lib/BryntumDateRangeField.js +2 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +9 -16
  44. package/lib/BryntumDateTimeField.js +2 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +12 -23
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +9 -16
  50. package/lib/BryntumDisplayField.js +2 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +9 -16
  53. package/lib/BryntumDurationField.js +2 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +14 -24
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +8 -15
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +9 -16
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +12 -24
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +9 -16
  68. package/lib/BryntumFileField.js +2 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +8 -15
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +9 -16
  74. package/lib/BryntumFilterField.js +2 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +24 -33
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +7 -15
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +8 -16
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +23 -28
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +12 -23
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +9 -16
  92. package/lib/BryntumNumberField.js +2 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +12 -19
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +12 -23
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +9 -16
  101. package/lib/BryntumPasswordField.js +2 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +7 -15
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +10 -17
  107. package/lib/BryntumRadio.js +2 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +12 -24
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +10 -17
  113. package/lib/BryntumSlideToggle.js +2 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +8 -15
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +7 -15
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +13 -24
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +10 -16
  125. package/lib/BryntumTextAreaField.js +3 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +10 -17
  128. package/lib/BryntumTextAreaPickerField.js +2 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +9 -16
  131. package/lib/BryntumTextField.js +2 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +10 -17
  134. package/lib/BryntumTimeField.js +2 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +8 -15
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +12 -19
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +7 -15
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +12 -23
  146. package/lib/BryntumYearPicker.js +2 -5
  147. package/lib/BryntumYearPicker.js.map +1 -1
  148. package/lib/WrapperHelper.js +2 -2
  149. package/lib/WrapperHelper.js.map +1 -1
  150. package/lib/index.d.ts +1 -0
  151. package/lib/index.js +1 -0
  152. package/lib/index.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/BryntumBooleanCombo.tsx +1190 -0
  155. package/src/BryntumButton.tsx +72 -118
  156. package/src/BryntumButtonGroup.tsx +79 -124
  157. package/src/BryntumChatPanel.tsx +142 -172
  158. package/src/BryntumCheckbox.tsx +85 -119
  159. package/src/BryntumCheckboxGroup.tsx +112 -182
  160. package/src/BryntumChipView.tsx +67 -107
  161. package/src/BryntumCodeEditor.tsx +109 -170
  162. package/src/BryntumColorField.tsx +84 -118
  163. package/src/BryntumCombo.tsx +103 -153
  164. package/src/BryntumContainer.tsx +79 -125
  165. package/src/BryntumDateField.tsx +91 -124
  166. package/src/BryntumDatePicker.tsx +122 -196
  167. package/src/BryntumDateRangeField.tsx +90 -127
  168. package/src/BryntumDateTimeField.tsx +84 -118
  169. package/src/BryntumDemoCodeEditor.tsx +109 -170
  170. package/src/BryntumDisplayField.tsx +85 -120
  171. package/src/BryntumDurationField.tsx +91 -126
  172. package/src/BryntumEditor.tsx +95 -145
  173. package/src/BryntumFieldFilterPicker.tsx +81 -129
  174. package/src/BryntumFieldFilterPickerGroup.tsx +84 -134
  175. package/src/BryntumFieldSet.tsx +108 -175
  176. package/src/BryntumFileField.tsx +84 -118
  177. package/src/BryntumFilePicker.tsx +79 -125
  178. package/src/BryntumFilterField.tsx +87 -124
  179. package/src/BryntumHint.tsx +136 -193
  180. package/src/BryntumLabel.tsx +60 -96
  181. package/src/BryntumList.tsx +64 -103
  182. package/src/BryntumMenu.tsx +131 -191
  183. package/src/BryntumMonthPicker.tsx +109 -170
  184. package/src/BryntumNumberField.tsx +88 -122
  185. package/src/BryntumPagingToolbar.tsx +84 -131
  186. package/src/BryntumPanel.tsx +109 -170
  187. package/src/BryntumPasswordField.tsx +84 -118
  188. package/src/BryntumProgressBar.tsx +59 -94
  189. package/src/BryntumRadio.tsx +85 -119
  190. package/src/BryntumRadioGroup.tsx +112 -181
  191. package/src/BryntumSlideToggle.tsx +85 -119
  192. package/src/BryntumSlider.tsx +68 -102
  193. package/src/BryntumSplitter.tsx +62 -100
  194. package/src/BryntumTabPanel.tsx +111 -173
  195. package/src/BryntumTextAreaField.tsx +92 -120
  196. package/src/BryntumTextAreaPickerField.tsx +86 -121
  197. package/src/BryntumTextField.tsx +85 -120
  198. package/src/BryntumTimeField.tsx +90 -121
  199. package/src/BryntumTimePicker.tsx +79 -125
  200. package/src/BryntumToolbar.tsx +84 -131
  201. package/src/BryntumWidget.tsx +60 -96
  202. package/src/BryntumYearPicker.tsx +110 -172
  203. package/src/WrapperHelper.tsx +2 -2
  204. package/src/index.ts +1 -0
@@ -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, CoreContainerItemConfig, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, FilterField, FilterFieldListeners, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, Store, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, FilterField, FilterFieldListeners, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, Store, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
7
 
8
8
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
9
 
@@ -12,14 +12,12 @@ export type BryntumFilterFieldProps = {
12
12
  /**
13
13
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
14
14
  * content will be placed inside this element.
15
- * ...
16
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-adopt)
17
16
  */
18
17
  adopt? : HTMLElement|string
19
18
  /**
20
19
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
21
- * ...
22
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumFilterFieldProps = {
41
39
  /**
42
40
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
43
41
  * into an element which will be linked using the `aria-describedby` attribute.
44
- * ...
45
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ariaDescription)
46
43
  */
47
44
  ariaDescription? : string
48
45
  /**
49
46
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
50
47
  * the `aria-label` attribute.
51
- * ...
52
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -68,21 +64,18 @@ export type BryntumFilterFieldProps = {
68
64
  /**
69
65
  * An object where property names with a truthy value indicate which events should bubble up the ownership
70
66
  * hierarchy when triggered.
71
- * ...
72
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-bubbleEvents)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-bubbleEvents)
73
68
  */
74
69
  bubbleEvents? : object
75
70
  /**
76
71
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
77
- * ...
78
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-callOnFunctions)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-callOnFunctions)
79
73
  */
80
74
  callOnFunctions? : boolean
81
75
  /**
82
76
  * By default, if an event handler throws an exception, the error propagates up the stack and the
83
77
  * application state is undefined. Code which follows the event handler will *not* be executed.
84
- * ...
85
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-catchEventHandlerExceptions)
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-catchEventHandlerExceptions)
86
79
  */
87
80
  catchEventHandlerExceptions? : boolean
88
81
  /**
@@ -90,6 +83,15 @@ export type BryntumFilterFieldProps = {
90
83
  * Set to `true` to centre the Widget in browser viewport space.
91
84
  */
92
85
  centered? : boolean
86
+ /**
87
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
88
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
89
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-checkValidity)
91
+ * @param {Core.widget.Field} field The field being validated
92
+ * @returns {void}
93
+ */
94
+ checkValidity? : ((field: Field) => void)|string
93
95
  /**
94
96
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
95
97
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -100,15 +102,13 @@ export type BryntumFilterFieldProps = {
100
102
  * Custom CSS classes to add to element.
101
103
  * May be specified as a space separated string, or as an object in which property names
102
104
  * with truthy values are used as the class names:
103
- * ...
104
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-cls)
105
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-cls)
105
106
  */
106
107
  cls? : string|object
107
108
  /**
108
109
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
109
110
  * `style` block.
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-color)
111
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-color)
112
112
  */
113
113
  color? : Color
114
114
  /**
@@ -125,15 +125,13 @@ export type BryntumFilterFieldProps = {
125
125
  * The configuration for additional items associated to this field. This is typically used to add contextual
126
126
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
127
127
  * these classes for examples of nested fields.
128
- * ...
129
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-container)
128
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-container)
130
129
  */
131
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
130
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
132
131
  /**
133
132
  * The config controls how the value of nested items are handled when a parent container gets or sets its
134
133
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
135
- * ...
136
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-containValues)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-containValues)
137
135
  * @param {Core.widget.Field} field Field instance
138
136
  * @returns {boolean}
139
137
  */
@@ -142,8 +140,7 @@ export type BryntumFilterFieldProps = {
142
140
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
143
141
  * May be specified as a space separated string, or as an object in which property names
144
142
  * with truthy values are used as the class names:
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-contentElementCls)
143
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-contentElementCls)
147
144
  */
148
145
  contentElementCls? : string|object
149
146
  /**
@@ -161,16 +158,15 @@ export type BryntumFilterFieldProps = {
161
158
  */
162
159
  defaultBindProperty? : string
163
160
  /**
164
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
165
- * ...
166
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-detectCSSCompatibilityIssues)
161
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
162
+ * checks:
163
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-detectCSSCompatibilityIssues)
167
164
  */
168
165
  detectCSSCompatibilityIssues? : boolean
169
166
  /**
170
167
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
171
168
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
172
- * ...
173
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-disabled)
169
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-disabled)
174
170
  */
175
171
  disabled? : boolean|'inert'
176
172
  /**
@@ -178,33 +174,28 @@ export type BryntumFilterFieldProps = {
178
174
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
179
175
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
180
176
  * body. Such widgets are called "edge strips".
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-dock)
177
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-dock)
183
178
  */
184
179
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
185
180
  /**
186
181
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
187
182
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
188
183
  * property which controls when a drag should start.
189
- * ...
190
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-draggable)
184
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-draggable)
185
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
191
186
  */
192
- draggable? : boolean|{
193
- handleSelector?: string
194
- }
187
+ draggable? : boolean|object
195
188
  /**
196
189
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
197
190
  * [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
198
191
  * but not to type one in the field.
199
- * ...
200
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-editable)
192
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-editable)
201
193
  */
202
194
  editable? : boolean
203
195
  /**
204
196
  * An object specifying attributes to assign to the root element of this widget.
205
197
  * Set `null` value to attribute to remove it.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-elementAttributes)
198
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-elementAttributes)
208
199
  */
209
200
  elementAttributes? : Record<string, string|null>
210
201
  extraData? : any
@@ -214,8 +205,7 @@ export type BryntumFilterFieldProps = {
214
205
  field? : string
215
206
  /**
216
207
  * Optional filter function to be called with record and value as parameters for store filtering.
217
- * ...
218
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterFunction)
208
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterFunction)
219
209
  * @param {Core.data.Model} record Record for comparison
220
210
  * @param {string} value Value to compare with
221
211
  * @returns {boolean} Returns `true` if record matches comparison requirements
@@ -225,8 +215,7 @@ export type BryntumFilterFieldProps = {
225
215
  * In case the `filterId` that is used in the store needs to be referenced elsewhere, it can be configured.
226
216
  * This applies to a passed [filterFunction](https://bryntum.com/products/core/docs/api/Core/widget/FilterField#config-filterFunction) as well as for an internally generated filter.
227
217
  * If no value is configured, an internal ID will be generated.
228
- * ...
229
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterId)
218
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterId)
230
219
  */
231
220
  filterId? : string|Symbol
232
221
  /**
@@ -254,8 +243,7 @@ export type BryntumFilterFieldProps = {
254
243
  hidden? : boolean
255
244
  /**
256
245
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
257
- * ...
258
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hideAnimation)
246
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hideAnimation)
259
247
  */
260
248
  hideAnimation? : boolean|object
261
249
  /**
@@ -265,8 +253,7 @@ export type BryntumFilterFieldProps = {
265
253
  /**
266
254
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
267
255
  * a field's units.
268
- * ...
269
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hint)
256
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hint)
270
257
  * @param {object} data A data object
271
258
  * @param {Core.widget.Field} data.source A reference to the field instance
272
259
  * @param {any} data.value The current value of the field
@@ -277,8 +264,7 @@ export type BryntumFilterFieldProps = {
277
264
  * This config is similar to [hint](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
278
265
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
279
266
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
280
- * ...
281
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hintHtml)
267
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hintHtml)
282
268
  * @param {object} data A data object
283
269
  * @param {Core.widget.Field} data.source A reference to the field instance
284
270
  * @param {any} data.value The current value of the field
@@ -291,16 +277,14 @@ export type BryntumFilterFieldProps = {
291
277
  id? : string
292
278
  /**
293
279
  * Determines if the widgets read-only state should be controlled by its parent.
294
- * ...
295
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ignoreParentReadOnly)
280
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ignoreParentReadOnly)
296
281
  */
297
282
  ignoreParentReadOnly? : boolean
298
283
  /**
299
284
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
300
285
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
301
286
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
302
- * ...
303
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-inline)
287
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-inline)
304
288
  */
305
289
  inline? : boolean
306
290
  /**
@@ -346,16 +330,14 @@ export type BryntumFilterFieldProps = {
346
330
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
347
331
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
348
332
  * are the name of the instance method to call when the keystroke is received.
349
- * ...
350
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyMap)
333
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyMap)
351
334
  */
352
335
  keyMap? : Record<string, KeyMapConfig>
353
336
  /**
354
337
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
355
338
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
356
339
  * immediate feedback, change will still be triggered on blur).
357
- * ...
358
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyStrokeChangeDelay)
340
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyStrokeChangeDelay)
359
341
  */
360
342
  keyStrokeChangeDelay? : number
361
343
  /**
@@ -368,15 +350,15 @@ export type BryntumFilterFieldProps = {
368
350
  labelCls? : string|object
369
351
  /**
370
352
  * Label position, either 'before' the field or 'above' the field
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labelPosition)
353
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labelPosition)
373
354
  */
374
355
  labelPosition? : 'before'|'above'|null
375
356
  /**
376
357
  * The labels to add either before or after the input field.
377
358
  * Each label may have the following properties:
378
- * ...
379
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labels)
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labels)
360
+ * @property {string} html Label text
361
+ * @property {'start','end'} align Which end of the file the label should go
380
362
  */
381
363
  labels? : object[]
382
364
  /**
@@ -385,16 +367,14 @@ export type BryntumFilterFieldProps = {
385
367
  labelWidth? : string|number
386
368
  /**
387
369
  * The listener set for this object.
388
- * ...
389
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-listeners)
370
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-listeners)
390
371
  */
391
372
  listeners? : FilterFieldListeners
392
373
  /**
393
374
  * A class translations of which are used for translating this entity.
394
375
  * This is often used when translations of an item are defined on its container class.
395
376
  * For example:
396
- * ...
397
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localeClass)
377
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localeClass)
398
378
  */
399
379
  localeClass? : typeof Base
400
380
  /**
@@ -406,8 +386,7 @@ export type BryntumFilterFieldProps = {
406
386
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
407
387
  * you could use 'localeKey' meta configuration.
408
388
  * Example:
409
- * ...
410
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localizableProperties)
389
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localizableProperties)
411
390
  */
412
391
  localizableProperties? : string[]
413
392
  /**
@@ -433,8 +412,7 @@ export type BryntumFilterFieldProps = {
433
412
  maxHeight? : string|number
434
413
  /**
435
414
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
436
- * ...
437
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-maximizeOnMobile)
415
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-maximizeOnMobile)
438
416
  */
439
417
  maximizeOnMobile? : number|string
440
418
  /**
@@ -464,18 +442,15 @@ export type BryntumFilterFieldProps = {
464
442
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
465
443
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
466
444
  * layout.
467
- * ...
468
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-monitorResize)
445
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-monitorResize)
446
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
469
447
  */
470
- monitorResize? : boolean|{
471
- immediate?: boolean
472
- }
448
+ monitorResize? : boolean|object
473
449
  /**
474
450
  * Name of the field which is used as a key to get/set values from/to the field.
475
451
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
476
452
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
477
- * ...
478
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-name)
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-name)
479
454
  */
480
455
  name? : string
481
456
  /**
@@ -486,8 +461,7 @@ export type BryntumFilterFieldProps = {
486
461
  * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement), but must
487
462
  * not participate in the standard layout of that widget, and must be positioned relatively to that
488
463
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
489
- * ...
490
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-positioned)
464
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-positioned)
491
465
  */
492
466
  positioned? : boolean
493
467
  /**
@@ -498,15 +472,13 @@ export type BryntumFilterFieldProps = {
498
472
  /**
499
473
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
500
474
  * are unresponsive.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-readOnly)
475
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-readOnly)
503
476
  */
504
477
  readOnly? : boolean
505
478
  relayStoreEvents? : boolean
506
479
  /**
507
480
  * Predefined style to use for the field. Possible values are:
508
- * ...
509
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rendition)
481
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rendition)
510
482
  */
511
483
  rendition? : 'outlined'|'filled'|string
512
484
  /**
@@ -525,23 +497,26 @@ export type BryntumFilterFieldProps = {
525
497
  * Configure as `true` to have the component display a translucent ripple when its
526
498
  * [focusElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
527
499
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
528
- * ...
529
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ripple)
530
- */
531
- ripple? : boolean|{
532
- delegate?: string
533
- color?: string
534
- radius?: number
535
- clip?: string
536
- }
500
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ripple)
501
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
502
+ * @property {string} [color] A CSS color name or specification.
503
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
504
+ * @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.
505
+ */
506
+ ripple? : boolean|object
507
+ /**
508
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
509
+ * accidentally applying a role which may interfere with screen readers.
510
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-role)
511
+ */
512
+ role? : string
537
513
  /**
538
514
  * 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`
539
515
  */
540
516
  rootElement? : ShadowRoot|HTMLElement
541
517
  /**
542
518
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
543
- * ...
544
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rtl)
519
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rtl)
545
520
  */
546
521
  rtl? : boolean
547
522
  /**
@@ -551,8 +526,7 @@ export type BryntumFilterFieldProps = {
551
526
  scrollAction? : 'hide'|'realign'|null
552
527
  /**
553
528
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
554
- * ...
555
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-showAnimation)
529
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-showAnimation)
556
530
  */
557
531
  showAnimation? : boolean|object
558
532
  /**
@@ -585,8 +559,7 @@ export type BryntumFilterFieldProps = {
585
559
  * A configuration for the [tab](https://bryntum.com/products/core/docs/api/Core/widget/Tab) created for this widget when it is placed in a
586
560
  * [TabPanel](https://bryntum.com/products/core/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
587
561
  * this widget:
588
- * ...
589
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tab)
562
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tab)
590
563
  */
591
564
  tab? : boolean|TabConfig
592
565
  /**
@@ -594,14 +567,12 @@ export type BryntumFilterFieldProps = {
594
567
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
595
568
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
596
569
  * to the element programmatically.
597
- * ...
598
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tabIndex)
570
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tabIndex)
599
571
  */
600
572
  tabIndex? : number
601
573
  /**
602
574
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
603
- * ...
604
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-textAlign)
575
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-textAlign)
605
576
  */
606
577
  textAlign? : 'left'|'center'|'right'|'start'|'end'
607
578
  /**
@@ -610,24 +581,21 @@ export type BryntumFilterFieldProps = {
610
581
  title? : string
611
582
  /**
612
583
  * Tooltip for the widget, either as a string or as a Tooltip config object.
613
- * ...
614
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tooltip)
584
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tooltip)
615
585
  */
616
586
  tooltip? : string|TooltipConfig|null
617
587
  /**
618
588
  * The triggers to add either before or after the input field. Each property name is the reference by which
619
589
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
620
- * ...
621
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-triggers)
590
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-triggers)
622
591
  */
623
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
592
+ triggers? : Record<string, FieldTriggerConfig>
624
593
  type? : 'filterfield'
625
594
  /**
626
595
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
627
596
  * as a space separated string, an array of strings, or as an object in which property names with truthy
628
597
  * values are used as the class names.
629
- * ...
630
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ui)
598
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ui)
631
599
  */
632
600
  ui? : string|object
633
601
  /**
@@ -652,14 +620,12 @@ export type BryntumFilterFieldProps = {
652
620
  width? : string|number
653
621
  /**
654
622
  * The x position for the widget.
655
- * ...
656
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-x)
623
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-x)
657
624
  */
658
625
  x? : number
659
626
  /**
660
627
  * The y position for the widget.
661
- * ...
662
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-y)
628
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-y)
663
629
  */
664
630
  y? : number
665
631
 
@@ -689,7 +655,7 @@ export type BryntumFilterFieldProps = {
689
655
  * @param {object} event Event object
690
656
  * @param {Core.widget.Widget} event.source The widget being hidden.
691
657
  */
692
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
658
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
693
659
  /**
694
660
  * Triggered before a widget is shown. Return `false` to prevent the action.
695
661
  * @param {object} event Event object
@@ -698,8 +664,7 @@ export type BryntumFilterFieldProps = {
698
664
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
699
665
  /**
700
666
  * Fires when any other event is fired from the object.
701
- * ...
702
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-catchAll)
667
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-catchAll)
703
668
  * @param {object} event Event object
704
669
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
705
670
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -719,8 +684,7 @@ export type BryntumFilterFieldProps = {
719
684
  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
720
685
  /**
721
686
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
722
- * ...
723
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-clear)
687
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-clear)
724
688
  * @param {object} event Event object
725
689
  * @param {Core.widget.Field,any} event.source This Field
726
690
  */
@@ -778,8 +742,7 @@ export type BryntumFilterFieldProps = {
778
742
  /**
779
743
  * Triggered when a widget which had been in a non-visible state for any reason
780
744
  * achieves visibility.
781
- * ...
782
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-paint)
745
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-paint)
783
746
  * @param {object} event Event object
784
747
  * @param {Core.widget.Widget} event.source The widget being painted.
785
748
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -840,6 +803,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
840
803
  'autoSelect',
841
804
  'bubbleEvents',
842
805
  'centered',
806
+ 'checkValidity',
843
807
  'clearable',
844
808
  'color',
845
809
  'config',
@@ -889,6 +853,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
889
853
  'relayStoreEvents',
890
854
  'revertOnEscape',
891
855
  'ripple',
856
+ 'role',
892
857
  'rootElement',
893
858
  'scrollAction',
894
859
  'showAnimation',
@@ -967,9 +932,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
967
932
  ];
968
933
 
969
934
  static propertyNames = [
970
- 'anchorSize',
971
935
  'content',
972
- 'focusVisible',
973
936
  'formula',
974
937
  'html',
975
938
  'input',