@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, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, ContainerListeners, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, ContainerListeners, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, ReactJSX, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, 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 BryntumContainerProps = {
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/Container#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#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/Container#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumContainerProps = {
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/Container#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#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/Container#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -63,21 +59,18 @@ export type BryntumContainerProps = {
63
59
  /**
64
60
  * An object where property names with a truthy value indicate which events should bubble up the ownership
65
61
  * hierarchy when triggered.
66
- * ...
67
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-bubbleEvents)
62
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-bubbleEvents)
68
63
  */
69
64
  bubbleEvents? : object
70
65
  /**
71
66
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
72
- * ...
73
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-callOnFunctions)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-callOnFunctions)
74
68
  */
75
69
  callOnFunctions? : boolean
76
70
  /**
77
71
  * By default, if an event handler throws an exception, the error propagates up the stack and the
78
72
  * application state is undefined. Code which follows the event handler will *not* be executed.
79
- * ...
80
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-catchEventHandlerExceptions)
73
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-catchEventHandlerExceptions)
81
74
  */
82
75
  catchEventHandlerExceptions? : boolean
83
76
  /**
@@ -89,15 +82,13 @@ export type BryntumContainerProps = {
89
82
  * Custom CSS classes to add to element.
90
83
  * May be specified as a space separated string, or as an object in which property names
91
84
  * with truthy values are used as the class names:
92
- * ...
93
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-cls)
85
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-cls)
94
86
  */
95
87
  cls? : string|object
96
88
  /**
97
89
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
98
90
  * `style` block.
99
- * ...
100
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-color)
91
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-color)
101
92
  */
102
93
  color? : Color
103
94
  /**
@@ -121,8 +112,7 @@ export type BryntumContainerProps = {
121
112
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
122
113
  * May be specified as a space separated string, or as an object in which property names
123
114
  * with truthy values are used as the class names:
124
- * ...
125
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-contentElementCls)
115
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-contentElementCls)
126
116
  */
127
117
  contentElementCls? : string|object
128
118
  /**
@@ -142,8 +132,7 @@ export type BryntumContainerProps = {
142
132
  /**
143
133
  * A [query](https://bryntum.com/products/core/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
144
134
  * focus should be directed by default.
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-defaultFocus)
135
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-defaultFocus)
147
136
  * @param {Core.widget.Widget} widget Widget passed to method
148
137
  * @returns {boolean} truthy value if widget is the default one
149
138
  */
@@ -153,16 +142,15 @@ export type BryntumContainerProps = {
153
142
  */
154
143
  defaults? : CoreContainerItemConfig
155
144
  /**
156
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
157
- * ...
158
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-detectCSSCompatibilityIssues)
145
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
146
+ * checks:
147
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-detectCSSCompatibilityIssues)
159
148
  */
160
149
  detectCSSCompatibilityIssues? : boolean
161
150
  /**
162
151
  * 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
163
152
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
164
- * ...
165
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-disabled)
153
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-disabled)
166
154
  */
167
155
  disabled? : boolean|'inert'
168
156
  /**
@@ -170,25 +158,21 @@ export type BryntumContainerProps = {
170
158
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
171
159
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
172
160
  * body. Such widgets are called "edge strips".
173
- * ...
174
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-dock)
161
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-dock)
175
162
  */
176
163
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
177
164
  /**
178
165
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
179
166
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
180
167
  * property which controls when a drag should start.
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-draggable)
168
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-draggable)
169
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
183
170
  */
184
- draggable? : boolean|{
185
- handleSelector?: string
186
- }
171
+ draggable? : boolean|object
187
172
  /**
188
173
  * An object specifying attributes to assign to the root element of this widget.
189
174
  * Set `null` value to attribute to remove it.
190
- * ...
191
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-elementAttributes)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-elementAttributes)
192
176
  */
193
177
  elementAttributes? : Record<string, string|null>
194
178
  extraData? : any
@@ -217,25 +201,21 @@ export type BryntumContainerProps = {
217
201
  hidden? : boolean
218
202
  /**
219
203
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
220
- * ...
221
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-hideAnimation)
204
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-hideAnimation)
222
205
  */
223
206
  hideAnimation? : boolean|object
224
207
  /**
225
208
  * Specify `true` to make this container hide when it has no visible children (Either empty
226
209
  * or all children hidden).
227
- * ...
228
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-hideWhenEmpty)
210
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-hideWhenEmpty)
229
211
  */
230
212
  hideWhenEmpty? : boolean
231
213
  /**
232
214
  * The HTML to display initially or a function returning the markup (called at widget construction time).
233
- * ...
234
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-html)
215
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-html)
235
216
  * @param {Core.widget.Widget} widget The calling Widget
236
- * @returns {string}
237
217
  */
238
- html? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
218
+ html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
239
219
  /**
240
220
  * The CSS class(es) to add when HTML content is being applied to this widget.
241
221
  */
@@ -246,16 +226,14 @@ export type BryntumContainerProps = {
246
226
  id? : string
247
227
  /**
248
228
  * Determines if the widgets read-only state should be controlled by its parent.
249
- * ...
250
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ignoreParentReadOnly)
229
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ignoreParentReadOnly)
251
230
  */
252
231
  ignoreParentReadOnly? : boolean
253
232
  /**
254
233
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
255
234
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
256
235
  * right, set this config to `'end'`.
257
- * ...
258
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-inputFieldAlign)
236
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-inputFieldAlign)
259
237
  */
260
238
  inputFieldAlign? : 'start'|'end'
261
239
  /**
@@ -273,55 +251,52 @@ export type BryntumContainerProps = {
273
251
  /**
274
252
  * An object containing typed child widget config objects or Widgets. May also be specified
275
253
  * as an array.
276
- * ...
277
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items)
254
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items)
278
255
  */
279
256
  items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
280
257
  /**
281
258
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
282
259
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
283
260
  * are the name of the instance method to call when the keystroke is received.
284
- * ...
285
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-keyMap)
261
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-keyMap)
286
262
  */
287
263
  keyMap? : Record<string, KeyMapConfig>
288
264
  /**
289
265
  * Convenience setting to use same label placement on all child widgets.
290
- * ...
291
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-labelPosition)
266
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-labelPosition)
292
267
  */
293
268
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
269
+ /**
270
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
271
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-labelWidth)
272
+ */
273
+ labelWidth? : number|null
294
274
  /**
295
275
  * The short name of a helper class which manages rendering and styling of child items.
296
- * ...
297
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-layout)
276
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-layout)
298
277
  */
299
278
  layout? : string|CoreContainerLayoutConfig
300
279
  /**
301
280
  * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
302
- * ...
303
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-layoutStyle)
281
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-layoutStyle)
304
282
  */
305
283
  layoutStyle? : object
306
284
  /**
307
285
  * An array of [child item](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
308
286
  * instances only when this Container is rendered, rather than eagerly at construct time.
309
- * ...
310
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-lazyItems)
287
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-lazyItems)
311
288
  */
312
289
  lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
313
290
  /**
314
291
  * The listener set for this object.
315
- * ...
316
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-listeners)
292
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-listeners)
317
293
  */
318
294
  listeners? : ContainerListeners
319
295
  /**
320
296
  * A class translations of which are used for translating this entity.
321
297
  * This is often used when translations of an item are defined on its container class.
322
298
  * For example:
323
- * ...
324
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-localeClass)
299
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-localeClass)
325
300
  */
326
301
  localeClass? : typeof Base
327
302
  /**
@@ -333,8 +308,7 @@ export type BryntumContainerProps = {
333
308
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
334
309
  * you could use 'localeKey' meta configuration.
335
310
  * Example:
336
- * ...
337
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-localizableProperties)
311
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-localizableProperties)
338
312
  */
339
313
  localizableProperties? : string[]
340
314
  /**
@@ -360,8 +334,7 @@ export type BryntumContainerProps = {
360
334
  maxHeight? : string|number
361
335
  /**
362
336
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
363
- * ...
364
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-maximizeOnMobile)
337
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-maximizeOnMobile)
365
338
  */
366
339
  maximizeOnMobile? : number|string
367
340
  /**
@@ -383,26 +356,22 @@ export type BryntumContainerProps = {
383
356
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
384
357
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
385
358
  * layout.
386
- * ...
387
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-monitorResize)
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-monitorResize)
360
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
388
361
  */
389
- monitorResize? : boolean|{
390
- immediate?: boolean
391
- }
362
+ monitorResize? : boolean|object
392
363
  /**
393
364
  * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items)
394
365
  * config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
395
366
  * value defined like this:
396
- * ...
397
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-namedItems)
367
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-namedItems)
398
368
  */
399
369
  namedItems? : Record<string, CoreContainerItemConfig>
400
370
  /**
401
371
  * 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
402
372
  * not participate in the standard layout of that widget, and must be positioned relatively to that
403
373
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
404
- * ...
405
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-positioned)
374
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-positioned)
406
375
  */
407
376
  positioned? : boolean
408
377
  /**
@@ -413,45 +382,45 @@ export type BryntumContainerProps = {
413
382
  /**
414
383
  * Whether this widget is read-only. This is only valid if the widget is an input
415
384
  * field, <strong>or contains input fields at any depth</strong>.
416
- * ...
417
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-readOnly)
385
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-readOnly)
418
386
  */
419
387
  readOnly? : boolean
420
388
  /**
421
389
  * [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
422
- * ...
423
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record)
390
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record)
424
391
  */
425
392
  record? : Model
426
393
  relayStoreEvents? : boolean
427
394
  /**
428
395
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
429
396
  * `type`.
430
- * ...
431
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-rendition)
397
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-rendition)
432
398
  */
433
399
  rendition? : string|Record<string, string>|null
434
400
  /**
435
401
  * Configure as `true` to have the component display a translucent ripple when its
436
402
  * [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
437
403
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
438
- * ...
439
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ripple)
440
- */
441
- ripple? : boolean|{
442
- delegate?: string
443
- color?: string
444
- radius?: number
445
- clip?: string
446
- }
404
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ripple)
405
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
406
+ * @property {string} [color] A CSS color name or specification.
407
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
408
+ * @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.
409
+ */
410
+ ripple? : boolean|object
411
+ /**
412
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
413
+ * accidentally applying a role which may interfere with screen readers.
414
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-role)
415
+ */
416
+ role? : string
447
417
  /**
448
418
  * 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`
449
419
  */
450
420
  rootElement? : ShadowRoot|HTMLElement
451
421
  /**
452
422
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
453
- * ...
454
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-rtl)
423
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-rtl)
455
424
  */
456
425
  rtl? : boolean
457
426
  /**
@@ -459,8 +428,7 @@ export type BryntumContainerProps = {
459
428
  * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
460
429
  * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
461
430
  * CSS overflow properties thus:
462
- * ...
463
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-scrollable)
431
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-scrollable)
464
432
  */
465
433
  scrollable? : boolean|ScrollerConfig|Scroller
466
434
  /**
@@ -470,8 +438,7 @@ export type BryntumContainerProps = {
470
438
  scrollAction? : 'hide'|'realign'|null
471
439
  /**
472
440
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
473
- * ...
474
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-showAnimation)
441
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-showAnimation)
475
442
  */
476
443
  showAnimation? : boolean|object
477
444
  /**
@@ -491,15 +458,13 @@ export type BryntumContainerProps = {
491
458
  * 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
492
459
  * [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
493
460
  * this widget:
494
- * ...
495
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tab)
461
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tab)
496
462
  */
497
463
  tab? : boolean|TabConfig
498
464
  /**
499
465
  * When this container is used as a tab in a TabPanel, these items are added to the
500
466
  * [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tabBarItems)
467
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tabBarItems)
503
468
  */
504
469
  tabBarItems? : ToolbarItems[]|Widget[]
505
470
  /**
@@ -508,15 +473,13 @@ export type BryntumContainerProps = {
508
473
  tag? : string
509
474
  /**
510
475
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
511
- * ...
512
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-textAlign)
476
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-textAlign)
513
477
  */
514
478
  textAlign? : 'left'|'center'|'right'|'start'|'end'
515
479
  /**
516
480
  * Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
517
481
  * which specifies a default max-width that makes long text more readable.
518
- * ...
519
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-textContent)
482
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-textContent)
520
483
  */
521
484
  textContent? : boolean
522
485
  /**
@@ -525,8 +488,7 @@ export type BryntumContainerProps = {
525
488
  title? : string
526
489
  /**
527
490
  * Tooltip for the widget, either as a string or as a Tooltip config object.
528
- * ...
529
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tooltip)
491
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-tooltip)
530
492
  */
531
493
  tooltip? : string|TooltipConfig|null
532
494
  type? : 'container'
@@ -534,8 +496,7 @@ export type BryntumContainerProps = {
534
496
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
535
497
  * as a space separated string, an array of strings, or as an object in which property names with truthy
536
498
  * values are used as the class names.
537
- * ...
538
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ui)
499
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-ui)
539
500
  */
540
501
  ui? : string|object
541
502
  /**
@@ -551,14 +512,12 @@ export type BryntumContainerProps = {
551
512
  width? : string|number
552
513
  /**
553
514
  * The x position for the widget.
554
- * ...
555
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-x)
515
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-x)
556
516
  */
557
517
  x? : number
558
518
  /**
559
519
  * The y position for the widget.
560
- * ...
561
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-y)
520
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-y)
562
521
  */
563
522
  y? : number
564
523
 
@@ -574,7 +533,7 @@ export type BryntumContainerProps = {
574
533
  * @param {object} event Event object
575
534
  * @param {Core.widget.Widget} event.source The widget being hidden.
576
535
  */
577
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
536
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
578
537
  /**
579
538
  * Fired before this container will load record values into its child fields. This is useful if you
580
539
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -591,8 +550,7 @@ export type BryntumContainerProps = {
591
550
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
592
551
  /**
593
552
  * Fires when any other event is fired from the object.
594
- * ...
595
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#event-catchAll)
553
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#event-catchAll)
596
554
  * @param {object} event Event object
597
555
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
598
556
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -650,8 +608,7 @@ export type BryntumContainerProps = {
650
608
  /**
651
609
  * Triggered when a widget which had been in a non-visible state for any reason
652
610
  * achieves visibility.
653
- * ...
654
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#event-paint)
611
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#event-paint)
655
612
  * @param {object} event Event object
656
613
  * @param {Core.widget.Widget} event.source The widget being painted.
657
614
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -736,6 +693,7 @@ export class BryntumContainer extends React.Component<BryntumContainerProps> {
736
693
  'preventTooltipOnTouch',
737
694
  'relayStoreEvents',
738
695
  'ripple',
696
+ 'role',
739
697
  'rootElement',
740
698
  'scrollAction',
741
699
  'showAnimation',
@@ -773,6 +731,7 @@ export class BryntumContainer extends React.Component<BryntumContainerProps> {
773
731
  'items',
774
732
  'keyMap',
775
733
  'labelPosition',
734
+ 'labelWidth',
776
735
  'layout',
777
736
  'layoutStyle',
778
737
  'margin',
@@ -811,11 +770,6 @@ export class BryntumContainer extends React.Component<BryntumContainerProps> {
811
770
  ];
812
771
 
813
772
  static propertyNames = [
814
- 'anchorSize',
815
- 'focusVisible',
816
- 'hasChanges',
817
- 'isSettingValues',
818
- 'isValid',
819
773
  'parent',
820
774
  'values'
821
775
  ];