@bryntum/core-react-thin 7.2.3 → 7.3.0

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 +261 -0
  2. package/lib/BryntumBooleanCombo.js +204 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +6 -14
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +8 -15
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +16 -20
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +7 -15
  14. package/lib/BryntumCheckbox.js +1 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +9 -21
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +6 -14
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +9 -20
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +7 -15
  26. package/lib/BryntumColorField.js +1 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +10 -18
  29. package/lib/BryntumCombo.js +1 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +7 -14
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +7 -15
  35. package/lib/BryntumDateField.js +1 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +9 -20
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +10 -18
  41. package/lib/BryntumDateRangeField.js +1 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +7 -15
  44. package/lib/BryntumDateTimeField.js +1 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +9 -20
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +7 -15
  50. package/lib/BryntumDisplayField.js +1 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +7 -15
  53. package/lib/BryntumDurationField.js +1 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +9 -19
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +7 -14
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +7 -14
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +9 -21
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +7 -15
  68. package/lib/BryntumFileField.js +1 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +7 -14
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +7 -15
  74. package/lib/BryntumFilterField.js +1 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +21 -30
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +6 -14
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +6 -14
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +20 -25
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +9 -20
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +7 -15
  92. package/lib/BryntumNumberField.js +1 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +10 -17
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +9 -20
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +7 -15
  101. package/lib/BryntumPasswordField.js +1 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +6 -14
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +7 -15
  107. package/lib/BryntumRadio.js +1 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +9 -21
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +7 -15
  113. package/lib/BryntumSlideToggle.js +1 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +7 -14
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +6 -14
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +9 -20
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +8 -15
  125. package/lib/BryntumTextAreaField.js +2 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +8 -16
  128. package/lib/BryntumTextAreaPickerField.js +1 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +7 -15
  131. package/lib/BryntumTextField.js +1 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +8 -16
  134. package/lib/BryntumTimeField.js +1 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +7 -14
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +10 -17
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +6 -14
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +9 -20
  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 +1180 -0
  155. package/src/BryntumButton.tsx +69 -115
  156. package/src/BryntumButtonGroup.tsx +78 -123
  157. package/src/BryntumChatPanel.tsx +139 -169
  158. package/src/BryntumCheckbox.tsx +73 -117
  159. package/src/BryntumCheckboxGroup.tsx +109 -179
  160. package/src/BryntumChipView.tsx +65 -105
  161. package/src/BryntumCodeEditor.tsx +106 -167
  162. package/src/BryntumColorField.tsx +73 -117
  163. package/src/BryntumCombo.tsx +92 -152
  164. package/src/BryntumContainer.tsx +78 -124
  165. package/src/BryntumDateField.tsx +80 -123
  166. package/src/BryntumDatePicker.tsx +119 -193
  167. package/src/BryntumDateRangeField.tsx +79 -126
  168. package/src/BryntumDateTimeField.tsx +73 -117
  169. package/src/BryntumDemoCodeEditor.tsx +106 -167
  170. package/src/BryntumDisplayField.tsx +74 -119
  171. package/src/BryntumDurationField.tsx +80 -125
  172. package/src/BryntumEditor.tsx +90 -140
  173. package/src/BryntumFieldFilterPicker.tsx +80 -128
  174. package/src/BryntumFieldFilterPickerGroup.tsx +82 -132
  175. package/src/BryntumFieldSet.tsx +105 -172
  176. package/src/BryntumFileField.tsx +73 -117
  177. package/src/BryntumFilePicker.tsx +78 -124
  178. package/src/BryntumFilterField.tsx +76 -123
  179. package/src/BryntumHint.tsx +133 -190
  180. package/src/BryntumLabel.tsx +59 -95
  181. package/src/BryntumList.tsx +62 -101
  182. package/src/BryntumMenu.tsx +128 -188
  183. package/src/BryntumMonthPicker.tsx +106 -167
  184. package/src/BryntumNumberField.tsx +77 -121
  185. package/src/BryntumPagingToolbar.tsx +82 -129
  186. package/src/BryntumPanel.tsx +106 -167
  187. package/src/BryntumPasswordField.tsx +73 -117
  188. package/src/BryntumProgressBar.tsx +58 -93
  189. package/src/BryntumRadio.tsx +73 -117
  190. package/src/BryntumRadioGroup.tsx +109 -178
  191. package/src/BryntumSlideToggle.tsx +73 -117
  192. package/src/BryntumSlider.tsx +67 -101
  193. package/src/BryntumSplitter.tsx +61 -99
  194. package/src/BryntumTabPanel.tsx +107 -169
  195. package/src/BryntumTextAreaField.tsx +81 -119
  196. package/src/BryntumTextAreaPickerField.tsx +75 -120
  197. package/src/BryntumTextField.tsx +74 -119
  198. package/src/BryntumTimeField.tsx +79 -120
  199. package/src/BryntumTimePicker.tsx +78 -124
  200. package/src/BryntumToolbar.tsx +82 -129
  201. package/src/BryntumWidget.tsx +59 -95
  202. package/src/BryntumYearPicker.tsx +107 -169
  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
  /**
@@ -100,15 +93,13 @@ export type BryntumFilterFieldProps = {
100
93
  * Custom CSS classes to add to element.
101
94
  * May be specified as a space separated string, or as an object in which property names
102
95
  * 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)
96
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-cls)
105
97
  */
106
98
  cls? : string|object
107
99
  /**
108
100
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
109
101
  * `style` block.
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-color)
102
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-color)
112
103
  */
113
104
  color? : Color
114
105
  /**
@@ -125,15 +116,13 @@ export type BryntumFilterFieldProps = {
125
116
  * The configuration for additional items associated to this field. This is typically used to add contextual
126
117
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
127
118
  * these classes for examples of nested fields.
128
- * ...
129
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-container)
119
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-container)
130
120
  */
131
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
121
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
132
122
  /**
133
123
  * The config controls how the value of nested items are handled when a parent container gets or sets its
134
124
  * [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)
125
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-containValues)
137
126
  * @param {Core.widget.Field} field Field instance
138
127
  * @returns {boolean}
139
128
  */
@@ -142,8 +131,7 @@ export type BryntumFilterFieldProps = {
142
131
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
143
132
  * May be specified as a space separated string, or as an object in which property names
144
133
  * 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)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-contentElementCls)
147
135
  */
148
136
  contentElementCls? : string|object
149
137
  /**
@@ -161,16 +149,15 @@ export type BryntumFilterFieldProps = {
161
149
  */
162
150
  defaultBindProperty? : string
163
151
  /**
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)
152
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
153
+ * checks:
154
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-detectCSSCompatibilityIssues)
167
155
  */
168
156
  detectCSSCompatibilityIssues? : boolean
169
157
  /**
170
158
  * 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
159
  * 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)
160
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-disabled)
174
161
  */
175
162
  disabled? : boolean|'inert'
176
163
  /**
@@ -178,33 +165,28 @@ export type BryntumFilterFieldProps = {
178
165
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
179
166
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
180
167
  * body. Such widgets are called "edge strips".
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-dock)
168
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-dock)
183
169
  */
184
170
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
185
171
  /**
186
172
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
187
173
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
188
174
  * 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)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-draggable)
176
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
191
177
  */
192
- draggable? : boolean|{
193
- handleSelector?: string
194
- }
178
+ draggable? : boolean|object
195
179
  /**
196
180
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
197
181
  * [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
182
  * 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)
183
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-editable)
201
184
  */
202
185
  editable? : boolean
203
186
  /**
204
187
  * An object specifying attributes to assign to the root element of this widget.
205
188
  * 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)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-elementAttributes)
208
190
  */
209
191
  elementAttributes? : Record<string, string|null>
210
192
  extraData? : any
@@ -214,8 +196,7 @@ export type BryntumFilterFieldProps = {
214
196
  field? : string
215
197
  /**
216
198
  * 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)
199
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterFunction)
219
200
  * @param {Core.data.Model} record Record for comparison
220
201
  * @param {string} value Value to compare with
221
202
  * @returns {boolean} Returns `true` if record matches comparison requirements
@@ -225,8 +206,7 @@ export type BryntumFilterFieldProps = {
225
206
  * In case the `filterId` that is used in the store needs to be referenced elsewhere, it can be configured.
226
207
  * 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
208
  * 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)
209
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-filterId)
230
210
  */
231
211
  filterId? : string|Symbol
232
212
  /**
@@ -254,8 +234,7 @@ export type BryntumFilterFieldProps = {
254
234
  hidden? : boolean
255
235
  /**
256
236
  * *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)
237
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hideAnimation)
259
238
  */
260
239
  hideAnimation? : boolean|object
261
240
  /**
@@ -265,8 +244,7 @@ export type BryntumFilterFieldProps = {
265
244
  /**
266
245
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
267
246
  * a field's units.
268
- * ...
269
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hint)
247
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hint)
270
248
  * @param {object} data A data object
271
249
  * @param {Core.widget.Field} data.source A reference to the field instance
272
250
  * @param {any} data.value The current value of the field
@@ -277,8 +255,7 @@ export type BryntumFilterFieldProps = {
277
255
  * 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
256
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
279
257
  * 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)
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-hintHtml)
282
259
  * @param {object} data A data object
283
260
  * @param {Core.widget.Field} data.source A reference to the field instance
284
261
  * @param {any} data.value The current value of the field
@@ -291,16 +268,14 @@ export type BryntumFilterFieldProps = {
291
268
  id? : string
292
269
  /**
293
270
  * 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)
271
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ignoreParentReadOnly)
296
272
  */
297
273
  ignoreParentReadOnly? : boolean
298
274
  /**
299
275
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
300
276
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
301
277
  * [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)
278
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-inline)
304
279
  */
305
280
  inline? : boolean
306
281
  /**
@@ -346,16 +321,14 @@ export type BryntumFilterFieldProps = {
346
321
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
347
322
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
348
323
  * 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)
324
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyMap)
351
325
  */
352
326
  keyMap? : Record<string, KeyMapConfig>
353
327
  /**
354
328
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
355
329
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
356
330
  * 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)
331
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-keyStrokeChangeDelay)
359
332
  */
360
333
  keyStrokeChangeDelay? : number
361
334
  /**
@@ -368,15 +341,15 @@ export type BryntumFilterFieldProps = {
368
341
  labelCls? : string|object
369
342
  /**
370
343
  * 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)
344
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labelPosition)
373
345
  */
374
346
  labelPosition? : 'before'|'above'|null
375
347
  /**
376
348
  * The labels to add either before or after the input field.
377
349
  * Each label may have the following properties:
378
- * ...
379
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labels)
350
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-labels)
351
+ * @property {string} html Label text
352
+ * @property {'start','end'} align Which end of the file the label should go
380
353
  */
381
354
  labels? : object[]
382
355
  /**
@@ -385,16 +358,14 @@ export type BryntumFilterFieldProps = {
385
358
  labelWidth? : string|number
386
359
  /**
387
360
  * The listener set for this object.
388
- * ...
389
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-listeners)
361
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-listeners)
390
362
  */
391
363
  listeners? : FilterFieldListeners
392
364
  /**
393
365
  * A class translations of which are used for translating this entity.
394
366
  * This is often used when translations of an item are defined on its container class.
395
367
  * For example:
396
- * ...
397
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localeClass)
368
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localeClass)
398
369
  */
399
370
  localeClass? : typeof Base
400
371
  /**
@@ -406,8 +377,7 @@ export type BryntumFilterFieldProps = {
406
377
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
407
378
  * you could use 'localeKey' meta configuration.
408
379
  * Example:
409
- * ...
410
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localizableProperties)
380
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-localizableProperties)
411
381
  */
412
382
  localizableProperties? : string[]
413
383
  /**
@@ -433,8 +403,7 @@ export type BryntumFilterFieldProps = {
433
403
  maxHeight? : string|number
434
404
  /**
435
405
  * *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)
406
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-maximizeOnMobile)
438
407
  */
439
408
  maximizeOnMobile? : number|string
440
409
  /**
@@ -464,18 +433,15 @@ export type BryntumFilterFieldProps = {
464
433
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
465
434
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
466
435
  * layout.
467
- * ...
468
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-monitorResize)
436
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-monitorResize)
437
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
469
438
  */
470
- monitorResize? : boolean|{
471
- immediate?: boolean
472
- }
439
+ monitorResize? : boolean|object
473
440
  /**
474
441
  * Name of the field which is used as a key to get/set values from/to the field.
475
442
  * 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
443
  * [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)
444
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-name)
479
445
  */
480
446
  name? : string
481
447
  /**
@@ -486,8 +452,7 @@ export type BryntumFilterFieldProps = {
486
452
  * 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
453
  * not participate in the standard layout of that widget, and must be positioned relatively to that
488
454
  * 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)
455
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-positioned)
491
456
  */
492
457
  positioned? : boolean
493
458
  /**
@@ -498,15 +463,13 @@ export type BryntumFilterFieldProps = {
498
463
  /**
499
464
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
500
465
  * are unresponsive.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-readOnly)
466
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-readOnly)
503
467
  */
504
468
  readOnly? : boolean
505
469
  relayStoreEvents? : boolean
506
470
  /**
507
471
  * 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)
472
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rendition)
510
473
  */
511
474
  rendition? : 'outlined'|'filled'|string
512
475
  /**
@@ -525,23 +488,26 @@ export type BryntumFilterFieldProps = {
525
488
  * Configure as `true` to have the component display a translucent ripple when its
526
489
  * [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
490
  * 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
- }
491
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ripple)
492
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
493
+ * @property {string} [color] A CSS color name or specification.
494
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
495
+ * @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.
496
+ */
497
+ ripple? : boolean|object
498
+ /**
499
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
500
+ * accidentally applying a role which may interfere with screen readers.
501
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-role)
502
+ */
503
+ role? : string
537
504
  /**
538
505
  * 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
506
  */
540
507
  rootElement? : ShadowRoot|HTMLElement
541
508
  /**
542
509
  * 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)
510
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-rtl)
545
511
  */
546
512
  rtl? : boolean
547
513
  /**
@@ -551,8 +517,7 @@ export type BryntumFilterFieldProps = {
551
517
  scrollAction? : 'hide'|'realign'|null
552
518
  /**
553
519
  * *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)
520
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-showAnimation)
556
521
  */
557
522
  showAnimation? : boolean|object
558
523
  /**
@@ -585,8 +550,7 @@ export type BryntumFilterFieldProps = {
585
550
  * 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
551
  * [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
552
  * this widget:
588
- * ...
589
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tab)
553
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tab)
590
554
  */
591
555
  tab? : boolean|TabConfig
592
556
  /**
@@ -594,14 +558,12 @@ export type BryntumFilterFieldProps = {
594
558
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
595
559
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
596
560
  * to the element programmatically.
597
- * ...
598
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tabIndex)
561
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tabIndex)
599
562
  */
600
563
  tabIndex? : number
601
564
  /**
602
565
  * 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)
566
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-textAlign)
605
567
  */
606
568
  textAlign? : 'left'|'center'|'right'|'start'|'end'
607
569
  /**
@@ -610,24 +572,21 @@ export type BryntumFilterFieldProps = {
610
572
  title? : string
611
573
  /**
612
574
  * 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)
575
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-tooltip)
615
576
  */
616
577
  tooltip? : string|TooltipConfig|null
617
578
  /**
618
579
  * The triggers to add either before or after the input field. Each property name is the reference by which
619
580
  * 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)
581
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-triggers)
622
582
  */
623
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
583
+ triggers? : Record<string, FieldTriggerConfig>
624
584
  type? : 'filterfield'
625
585
  /**
626
586
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
627
587
  * as a space separated string, an array of strings, or as an object in which property names with truthy
628
588
  * values are used as the class names.
629
- * ...
630
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ui)
589
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-ui)
631
590
  */
632
591
  ui? : string|object
633
592
  /**
@@ -652,14 +611,12 @@ export type BryntumFilterFieldProps = {
652
611
  width? : string|number
653
612
  /**
654
613
  * The x position for the widget.
655
- * ...
656
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-x)
614
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-x)
657
615
  */
658
616
  x? : number
659
617
  /**
660
618
  * The y position for the widget.
661
- * ...
662
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-y)
619
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-y)
663
620
  */
664
621
  y? : number
665
622
 
@@ -698,8 +655,7 @@ export type BryntumFilterFieldProps = {
698
655
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
699
656
  /**
700
657
  * 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)
658
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-catchAll)
703
659
  * @param {object} event Event object
704
660
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
705
661
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -719,8 +675,7 @@ export type BryntumFilterFieldProps = {
719
675
  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
676
  /**
721
677
  * 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)
678
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-clear)
724
679
  * @param {object} event Event object
725
680
  * @param {Core.widget.Field,any} event.source This Field
726
681
  */
@@ -778,8 +733,7 @@ export type BryntumFilterFieldProps = {
778
733
  /**
779
734
  * Triggered when a widget which had been in a non-visible state for any reason
780
735
  * achieves visibility.
781
- * ...
782
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-paint)
736
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#event-paint)
783
737
  * @param {object} event Event object
784
738
  * @param {Core.widget.Widget} event.source The widget being painted.
785
739
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -889,6 +843,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
889
843
  'relayStoreEvents',
890
844
  'revertOnEscape',
891
845
  'ripple',
846
+ 'role',
892
847
  'rootElement',
893
848
  'scrollAction',
894
849
  'showAnimation',
@@ -967,9 +922,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
967
922
  ];
968
923
 
969
924
  static propertyNames = [
970
- 'anchorSize',
971
925
  'content',
972
- 'focusVisible',
973
926
  'formula',
974
927
  'html',
975
928
  'input',