@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, ClickRepeaterConfig, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, Model, PagingToolbar, PagingToolbarListeners, Rectangle, Scroller, ScrollerConfig, Store, TabConfig, Tool, ToolConfig, Toolbar, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, ClickRepeaterConfig, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, Model, PagingToolbar, PagingToolbarListeners, ReactJSX, Rectangle, Scroller, ScrollerConfig, Store, TabConfig, Tool, ToolConfig, Toolbar, 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 BryntumPagingToolbarProps = {
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/PagingToolbar#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -63,21 +59,18 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-bubbleEvents)
62
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-callOnFunctions)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-catchEventHandlerExceptions)
73
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-catchEventHandlerExceptions)
81
74
  */
82
75
  catchEventHandlerExceptions? : boolean
83
76
  /**
@@ -89,15 +82,13 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-cls)
85
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-color)
91
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-color)
101
92
  */
102
93
  color? : Color
103
94
  /**
@@ -121,8 +112,7 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-contentElementCls)
115
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-contentElementCls)
126
116
  */
127
117
  contentElementCls? : string|object
128
118
  /**
@@ -142,8 +132,7 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-defaultFocus)
135
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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 BryntumPagingToolbarProps = {
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/PagingToolbar#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/PagingToolbar#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/PagingToolbar#config-disabled)
153
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-disabled)
166
154
  */
167
155
  disabled? : boolean|'inert'
168
156
  /**
@@ -170,25 +158,21 @@ export type BryntumPagingToolbarProps = {
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/PagingToolbar#config-dock)
161
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-draggable)
168
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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/PagingToolbar#config-elementAttributes)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-elementAttributes)
192
176
  */
193
177
  elementAttributes? : Record<string, string|null>
194
178
  /**
@@ -221,25 +205,21 @@ export type BryntumPagingToolbarProps = {
221
205
  hidden? : boolean
222
206
  /**
223
207
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
224
- * ...
225
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-hideAnimation)
208
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-hideAnimation)
226
209
  */
227
210
  hideAnimation? : boolean|object
228
211
  /**
229
212
  * Specify `true` to make this container hide when it has no visible children (Either empty
230
213
  * or all children hidden).
231
- * ...
232
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-hideWhenEmpty)
214
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-hideWhenEmpty)
233
215
  */
234
216
  hideWhenEmpty? : boolean
235
217
  /**
236
218
  * The HTML to display initially or a function returning the markup (called at widget construction time).
237
- * ...
238
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-html)
219
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-html)
239
220
  * @param {Core.widget.Widget} widget The calling Widget
240
- * @returns {string}
241
221
  */
242
- html? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
222
+ html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
243
223
  /**
244
224
  * The CSS class(es) to add when HTML content is being applied to this widget.
245
225
  */
@@ -250,16 +230,14 @@ export type BryntumPagingToolbarProps = {
250
230
  id? : string
251
231
  /**
252
232
  * Determines if the toolbars read-only state should be controlled by its parent.
253
- * ...
254
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ignoreParentReadOnly)
233
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ignoreParentReadOnly)
255
234
  */
256
235
  ignoreParentReadOnly? : boolean
257
236
  /**
258
237
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
259
238
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
260
239
  * right, set this config to `'end'`.
261
- * ...
262
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-inputFieldAlign)
240
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-inputFieldAlign)
263
241
  */
264
242
  inputFieldAlign? : 'start'|'end'
265
243
  /**
@@ -277,16 +255,14 @@ export type BryntumPagingToolbarProps = {
277
255
  /**
278
256
  * An object containing typed child widget config objects or [Widgets](https://bryntum.com/products/core/docs/api/Core/widget/Widget). Can also be
279
257
  * specified as an array.
280
- * ...
281
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-items)
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-items)
282
259
  */
283
260
  items? : Record<string, ToolbarItems|boolean|null>|ToolbarItems[]|Widget[]
284
261
  /**
285
262
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
286
263
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
287
264
  * are the name of the instance method to call when the keystroke is received.
288
- * ...
289
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-keyMap)
265
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-keyMap)
290
266
  */
291
267
  keyMap? : Record<string, KeyMapConfig>
292
268
  /**
@@ -294,37 +270,37 @@ export type BryntumPagingToolbarProps = {
294
270
  * independent of which theme is used.
295
271
  */
296
272
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
273
+ /**
274
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
275
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-labelWidth)
276
+ */
277
+ labelWidth? : number|null
297
278
  /**
298
279
  * The short name of a helper class which manages rendering and styling of child items.
299
- * ...
300
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-layout)
280
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-layout)
301
281
  */
302
282
  layout? : string|CoreContainerLayoutConfig
303
283
  /**
304
284
  * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
305
- * ...
306
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-layoutStyle)
285
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-layoutStyle)
307
286
  */
308
287
  layoutStyle? : object
309
288
  /**
310
289
  * 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
311
290
  * instances only when this Container is rendered, rather than eagerly at construct time.
312
- * ...
313
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-lazyItems)
291
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-lazyItems)
314
292
  */
315
293
  lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
316
294
  /**
317
295
  * The listener set for this object.
318
- * ...
319
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-listeners)
296
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-listeners)
320
297
  */
321
298
  listeners? : PagingToolbarListeners
322
299
  /**
323
300
  * A class translations of which are used for translating this entity.
324
301
  * This is often used when translations of an item are defined on its container class.
325
302
  * For example:
326
- * ...
327
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-localeClass)
303
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-localeClass)
328
304
  */
329
305
  localeClass? : typeof Base
330
306
  /**
@@ -336,8 +312,7 @@ export type BryntumPagingToolbarProps = {
336
312
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
337
313
  * you could use 'localeKey' meta configuration.
338
314
  * Example:
339
- * ...
340
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-localizableProperties)
315
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-localizableProperties)
341
316
  */
342
317
  localizableProperties? : string[]
343
318
  /**
@@ -363,8 +338,7 @@ export type BryntumPagingToolbarProps = {
363
338
  maxHeight? : string|number
364
339
  /**
365
340
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
366
- * ...
367
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-maximizeOnMobile)
341
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-maximizeOnMobile)
368
342
  */
369
343
  maximizeOnMobile? : number|string
370
344
  /**
@@ -386,36 +360,30 @@ export type BryntumPagingToolbarProps = {
386
360
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
387
361
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
388
362
  * layout.
389
- * ...
390
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-monitorResize)
363
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-monitorResize)
364
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
391
365
  */
392
- monitorResize? : boolean|{
393
- immediate?: boolean
394
- }
366
+ monitorResize? : boolean|object
395
367
  /**
396
368
  * 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)
397
369
  * config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
398
370
  * value defined like this:
399
- * ...
400
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-namedItems)
371
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-namedItems)
401
372
  */
402
373
  namedItems? : Record<string, CoreContainerItemConfig>
403
374
  /**
404
375
  * How this Toolbar should deal with items that overflow its main axis.
405
- * ...
406
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-overflow)
376
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-overflow)
377
+ * @property {'scroll','menu'} overflow.type `'scroll'` or `'menu'`
378
+ * @property {ClickRepeaterConfig} overflow.repeat A config object to reconfigure the [ClickRepeater](https://bryntum.com/products/core/docs/api/Core/util/ClickRepeater) which controls auto repeat speed when holding down the scroll buttons when `type` is `'scroll'`
379
+ * @property {Function} overflow.filter A filter function which may return a falsy value to prevent toolbar items from being cloned into the overflow menu.
407
380
  */
408
- overflow? : string|{
409
- type?: 'scroll'|'menu'
410
- repeat?: ClickRepeaterConfig
411
- filter?: Function
412
- }|null
381
+ overflow? : string|{ type: 'scroll'|'menu', repeat: ClickRepeaterConfig, filter: () => void }|null
413
382
  /**
414
383
  * 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
415
384
  * not participate in the standard layout of that widget, and must be positioned relatively to that
416
385
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
417
- * ...
418
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-positioned)
386
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-positioned)
419
387
  */
420
388
  positioned? : boolean
421
389
  /**
@@ -426,45 +394,45 @@ export type BryntumPagingToolbarProps = {
426
394
  /**
427
395
  * Whether this widget is read-only. This is only valid if the widget is an input
428
396
  * field, <strong>or contains input fields at any depth</strong>.
429
- * ...
430
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-readOnly)
397
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-readOnly)
431
398
  */
432
399
  readOnly? : boolean
433
400
  /**
434
401
  * [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
435
- * ...
436
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-record)
402
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-record)
437
403
  */
438
404
  record? : Model
439
405
  relayStoreEvents? : boolean
440
406
  /**
441
407
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
442
408
  * `type`.
443
- * ...
444
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-rendition)
409
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-rendition)
445
410
  */
446
411
  rendition? : string|Record<string, string>|null
447
412
  /**
448
413
  * Configure as `true` to have the component display a translucent ripple when its
449
414
  * [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
450
415
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
451
- * ...
452
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ripple)
453
- */
454
- ripple? : boolean|{
455
- delegate?: string
456
- color?: string
457
- radius?: number
458
- clip?: string
459
- }
416
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ripple)
417
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
418
+ * @property {string} [color] A CSS color name or specification.
419
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
420
+ * @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.
421
+ */
422
+ ripple? : boolean|object
423
+ /**
424
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
425
+ * accidentally applying a role which may interfere with screen readers.
426
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-role)
427
+ */
428
+ role? : string
460
429
  /**
461
430
  * 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`
462
431
  */
463
432
  rootElement? : ShadowRoot|HTMLElement
464
433
  /**
465
434
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
466
- * ...
467
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-rtl)
435
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-rtl)
468
436
  */
469
437
  rtl? : boolean
470
438
  /**
@@ -472,8 +440,7 @@ export type BryntumPagingToolbarProps = {
472
440
  * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
473
441
  * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
474
442
  * CSS overflow properties thus:
475
- * ...
476
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-scrollable)
443
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-scrollable)
477
444
  */
478
445
  scrollable? : boolean|ScrollerConfig|Scroller
479
446
  /**
@@ -483,8 +450,7 @@ export type BryntumPagingToolbarProps = {
483
450
  scrollAction? : 'hide'|'realign'|null
484
451
  /**
485
452
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
486
- * ...
487
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-showAnimation)
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-showAnimation)
488
454
  */
489
455
  showAnimation? : boolean|object
490
456
  /**
@@ -510,15 +476,13 @@ export type BryntumPagingToolbarProps = {
510
476
  * 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
511
477
  * [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
512
478
  * this widget:
513
- * ...
514
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tab)
479
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tab)
515
480
  */
516
481
  tab? : boolean|TabConfig
517
482
  /**
518
483
  * When this container is used as a tab in a TabPanel, these items are added to the
519
484
  * [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
520
- * ...
521
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tabBarItems)
485
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tabBarItems)
522
486
  */
523
487
  tabBarItems? : ToolbarItems[]|Widget[]
524
488
  /**
@@ -527,15 +491,13 @@ export type BryntumPagingToolbarProps = {
527
491
  tag? : string
528
492
  /**
529
493
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
530
- * ...
531
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-textAlign)
494
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-textAlign)
532
495
  */
533
496
  textAlign? : 'left'|'center'|'right'|'start'|'end'
534
497
  /**
535
498
  * Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
536
499
  * which specifies a default max-width that makes long text more readable.
537
- * ...
538
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-textContent)
500
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-textContent)
539
501
  */
540
502
  textContent? : boolean
541
503
  /**
@@ -550,8 +512,7 @@ export type BryntumPagingToolbarProps = {
550
512
  tools? : Record<string, ToolConfig>
551
513
  /**
552
514
  * Tooltip for the widget, either as a string or as a Tooltip config object.
553
- * ...
554
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tooltip)
515
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-tooltip)
555
516
  */
556
517
  tooltip? : string|TooltipConfig|null
557
518
  type? : 'pagingtoolbar'
@@ -559,8 +520,7 @@ export type BryntumPagingToolbarProps = {
559
520
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
560
521
  * as a space separated string, an array of strings, or as an object in which property names with truthy
561
522
  * values are used as the class names.
562
- * ...
563
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ui)
523
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-ui)
564
524
  */
565
525
  ui? : string|object
566
526
  /**
@@ -580,14 +540,12 @@ export type BryntumPagingToolbarProps = {
580
540
  width? : string|number
581
541
  /**
582
542
  * The x position for the widget.
583
- * ...
584
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-x)
543
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-x)
585
544
  */
586
545
  x? : number
587
546
  /**
588
547
  * The y position for the widget.
589
- * ...
590
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-y)
548
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-y)
591
549
  */
592
550
  y? : number
593
551
 
@@ -603,7 +561,7 @@ export type BryntumPagingToolbarProps = {
603
561
  * @param {object} event Event object
604
562
  * @param {Core.widget.Widget} event.source The widget being hidden.
605
563
  */
606
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
564
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
607
565
  /**
608
566
  * This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
609
567
  * a listener returns `false`.
@@ -612,7 +570,7 @@ export type BryntumPagingToolbarProps = {
612
570
  * @param {Core.widget.Widget} event.item The dragged item.
613
571
  * @param {Event} event.domEvent The browser event.
614
572
  */
615
- onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => Promise<boolean>|boolean|void)|string
573
+ onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string
616
574
  /**
617
575
  * Fired before this container will load record values into its child fields. This is useful if you
618
576
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -629,8 +587,7 @@ export type BryntumPagingToolbarProps = {
629
587
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
630
588
  /**
631
589
  * Fires when any other event is fired from the object.
632
- * ...
633
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#event-catchAll)
590
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#event-catchAll)
634
591
  * @param {object} event Event object
635
592
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
636
593
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -705,8 +662,7 @@ export type BryntumPagingToolbarProps = {
705
662
  /**
706
663
  * Triggered when a widget which had been in a non-visible state for any reason
707
664
  * achieves visibility.
708
- * ...
709
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#event-paint)
665
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#event-paint)
710
666
  * @param {object} event Event object
711
667
  * @param {Core.widget.Widget} event.source The widget being painted.
712
668
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -792,6 +748,7 @@ export class BryntumPagingToolbar extends React.Component<BryntumPagingToolbarPr
792
748
  'preventTooltipOnTouch',
793
749
  'relayStoreEvents',
794
750
  'ripple',
751
+ 'role',
795
752
  'rootElement',
796
753
  'scrollAction',
797
754
  'showAnimation',
@@ -832,6 +789,7 @@ export class BryntumPagingToolbar extends React.Component<BryntumPagingToolbarPr
832
789
  'items',
833
790
  'keyMap',
834
791
  'labelPosition',
792
+ 'labelWidth',
835
793
  'layout',
836
794
  'layoutStyle',
837
795
  'margin',
@@ -874,11 +832,6 @@ export class BryntumPagingToolbar extends React.Component<BryntumPagingToolbarPr
874
832
  ];
875
833
 
876
834
  static propertyNames = [
877
- 'anchorSize',
878
- 'focusVisible',
879
- 'hasChanges',
880
- 'isSettingValues',
881
- 'isValid',
882
835
  'parent',
883
836
  'values'
884
837
  ];