@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, KeyMapConfig, MaskConfig, Model, NumberField, NumberFieldListeners, NumberFormatConfig, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, NumberField, NumberFieldListeners, NumberFormatConfig, ReactJSX, Rectangle, Scroller, 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 BryntumNumberFieldProps = {
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/NumberField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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/NumberField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumNumberFieldProps = {
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/NumberField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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/NumberField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -68,21 +64,18 @@ export type BryntumNumberFieldProps = {
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/NumberField#config-bubbleEvents)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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/NumberField#config-callOnFunctions)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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/NumberField#config-catchEventHandlerExceptions)
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-catchEventHandlerExceptions)
86
79
  */
87
80
  catchEventHandlerExceptions? : boolean
88
81
  /**
@@ -93,8 +86,7 @@ export type BryntumNumberFieldProps = {
93
86
  /**
94
87
  * Controls how change events are triggered when stepping the value up or down using either spinners or
95
88
  * arrow keys.
96
- * ...
97
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
89
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
98
90
  */
99
91
  changeOnSpin? : boolean|number
100
92
  /**
@@ -107,15 +99,13 @@ export type BryntumNumberFieldProps = {
107
99
  * Custom CSS classes to add to element.
108
100
  * May be specified as a space separated string, or as an object in which property names
109
101
  * with truthy values are used as the class names:
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-cls)
102
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-cls)
112
103
  */
113
104
  cls? : string|object
114
105
  /**
115
106
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
116
107
  * `style` block.
117
- * ...
118
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-color)
108
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-color)
119
109
  */
120
110
  color? : Color
121
111
  /**
@@ -132,15 +122,13 @@ export type BryntumNumberFieldProps = {
132
122
  * The configuration for additional items associated to this field. This is typically used to add contextual
133
123
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
134
124
  * these classes for examples of nested fields.
135
- * ...
136
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-container)
125
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-container)
137
126
  */
138
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
127
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
139
128
  /**
140
129
  * The config controls how the value of nested items are handled when a parent container gets or sets its
141
130
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
142
- * ...
143
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-containValues)
131
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-containValues)
144
132
  * @param {Core.widget.Field} field Field instance
145
133
  * @returns {boolean}
146
134
  */
@@ -149,8 +137,7 @@ export type BryntumNumberFieldProps = {
149
137
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
150
138
  * May be specified as a space separated string, or as an object in which property names
151
139
  * with truthy values are used as the class names:
152
- * ...
153
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-contentElementCls)
140
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-contentElementCls)
154
141
  */
155
142
  contentElementCls? : string|object
156
143
  /**
@@ -168,16 +155,15 @@ export type BryntumNumberFieldProps = {
168
155
  */
169
156
  defaultBindProperty? : string
170
157
  /**
171
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
172
- * ...
173
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-detectCSSCompatibilityIssues)
158
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
159
+ * checks:
160
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-detectCSSCompatibilityIssues)
174
161
  */
175
162
  detectCSSCompatibilityIssues? : boolean
176
163
  /**
177
164
  * 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
178
165
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
179
- * ...
180
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-disabled)
166
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-disabled)
181
167
  */
182
168
  disabled? : boolean|'inert'
183
169
  /**
@@ -185,33 +171,28 @@ export type BryntumNumberFieldProps = {
185
171
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
186
172
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
187
173
  * body. Such widgets are called "edge strips".
188
- * ...
189
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-dock)
174
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-dock)
190
175
  */
191
176
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
192
177
  /**
193
178
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
194
179
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
195
180
  * property which controls when a drag should start.
196
- * ...
197
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-draggable)
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-draggable)
182
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
198
183
  */
199
- draggable? : boolean|{
200
- handleSelector?: string
201
- }
184
+ draggable? : boolean|object
202
185
  /**
203
186
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
204
187
  * [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
205
188
  * but not to type one in the field.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-editable)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-editable)
208
190
  */
209
191
  editable? : boolean
210
192
  /**
211
193
  * An object specifying attributes to assign to the root element of this widget.
212
194
  * Set `null` value to attribute to remove it.
213
- * ...
214
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-elementAttributes)
195
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-elementAttributes)
215
196
  */
216
197
  elementAttributes? : Record<string, string|null>
217
198
  extraData? : any
@@ -230,8 +211,7 @@ export type BryntumNumberFieldProps = {
230
211
  floating? : boolean
231
212
  /**
232
213
  * The format to use for rendering numbers.
233
- * ...
234
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-format)
214
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-format)
235
215
  */
236
216
  format? : string|NumberFormatConfig
237
217
  /**
@@ -246,8 +226,7 @@ export type BryntumNumberFieldProps = {
246
226
  hidden? : boolean
247
227
  /**
248
228
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
249
- * ...
250
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hideAnimation)
229
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hideAnimation)
251
230
  */
252
231
  hideAnimation? : boolean|object
253
232
  /**
@@ -257,8 +236,7 @@ export type BryntumNumberFieldProps = {
257
236
  /**
258
237
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
259
238
  * a field's units.
260
- * ...
261
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hint)
239
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hint)
262
240
  * @param {object} data A data object
263
241
  * @param {Core.widget.Field} data.source A reference to the field instance
264
242
  * @param {any} data.value The current value of the field
@@ -269,8 +247,7 @@ export type BryntumNumberFieldProps = {
269
247
  * 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.
270
248
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
271
249
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
272
- * ...
273
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hintHtml)
250
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hintHtml)
274
251
  * @param {object} data A data object
275
252
  * @param {Core.widget.Field} data.source A reference to the field instance
276
253
  * @param {any} data.value The current value of the field
@@ -283,16 +260,14 @@ export type BryntumNumberFieldProps = {
283
260
  id? : string
284
261
  /**
285
262
  * Determines if the widgets read-only state should be controlled by its parent.
286
- * ...
287
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ignoreParentReadOnly)
263
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ignoreParentReadOnly)
288
264
  */
289
265
  ignoreParentReadOnly? : boolean
290
266
  /**
291
267
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
292
268
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
293
269
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
294
- * ...
295
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-inline)
270
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-inline)
296
271
  */
297
272
  inline? : boolean
298
273
  /**
@@ -336,16 +311,14 @@ export type BryntumNumberFieldProps = {
336
311
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
337
312
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
338
313
  * are the name of the instance method to call when the keystroke is received.
339
- * ...
340
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyMap)
314
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyMap)
341
315
  */
342
316
  keyMap? : Record<string, KeyMapConfig>
343
317
  /**
344
318
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
345
319
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
346
320
  * immediate feedback, change will still be triggered on blur).
347
- * ...
348
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyStrokeChangeDelay)
321
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyStrokeChangeDelay)
349
322
  */
350
323
  keyStrokeChangeDelay? : number
351
324
  /**
@@ -358,15 +331,15 @@ export type BryntumNumberFieldProps = {
358
331
  labelCls? : string|object
359
332
  /**
360
333
  * Label position, either 'before' the field or 'above' the field
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labelPosition)
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labelPosition)
363
335
  */
364
336
  labelPosition? : 'before'|'above'|null
365
337
  /**
366
338
  * The labels to add either before or after the input field.
367
339
  * Each label may have the following properties:
368
- * ...
369
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labels)
340
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labels)
341
+ * @property {string} html Label text
342
+ * @property {'start','end'} align Which end of the file the label should go
370
343
  */
371
344
  labels? : object[]
372
345
  /**
@@ -383,16 +356,14 @@ export type BryntumNumberFieldProps = {
383
356
  largeStep? : number
384
357
  /**
385
358
  * The listener set for this object.
386
- * ...
387
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-listeners)
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-listeners)
388
360
  */
389
361
  listeners? : NumberFieldListeners
390
362
  /**
391
363
  * A class translations of which are used for translating this entity.
392
364
  * This is often used when translations of an item are defined on its container class.
393
365
  * For example:
394
- * ...
395
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localeClass)
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localeClass)
396
367
  */
397
368
  localeClass? : typeof Base
398
369
  /**
@@ -404,8 +375,7 @@ export type BryntumNumberFieldProps = {
404
375
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
405
376
  * you could use 'localeKey' meta configuration.
406
377
  * Example:
407
- * ...
408
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localizableProperties)
378
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localizableProperties)
409
379
  */
410
380
  localizableProperties? : string[]
411
381
  /**
@@ -435,8 +405,7 @@ export type BryntumNumberFieldProps = {
435
405
  maxHeight? : string|number
436
406
  /**
437
407
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
438
- * ...
439
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-maximizeOnMobile)
408
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-maximizeOnMobile)
440
409
  */
441
410
  maximizeOnMobile? : number|string
442
411
  /**
@@ -462,18 +431,15 @@ export type BryntumNumberFieldProps = {
462
431
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
463
432
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
464
433
  * layout.
465
- * ...
466
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-monitorResize)
434
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-monitorResize)
435
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
467
436
  */
468
- monitorResize? : boolean|{
469
- immediate?: boolean
470
- }
437
+ monitorResize? : boolean|object
471
438
  /**
472
439
  * Name of the field which is used as a key to get/set values from/to the field.
473
440
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
474
441
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
475
- * ...
476
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-name)
442
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-name)
477
443
  */
478
444
  name? : string
479
445
  /**
@@ -484,8 +450,7 @@ export type BryntumNumberFieldProps = {
484
450
  * 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
485
451
  * not participate in the standard layout of that widget, and must be positioned relatively to that
486
452
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
487
- * ...
488
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-positioned)
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-positioned)
489
454
  */
490
455
  positioned? : boolean
491
456
  /**
@@ -496,15 +461,13 @@ export type BryntumNumberFieldProps = {
496
461
  /**
497
462
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
498
463
  * are unresponsive.
499
- * ...
500
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-readOnly)
464
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-readOnly)
501
465
  */
502
466
  readOnly? : boolean
503
467
  relayStoreEvents? : boolean
504
468
  /**
505
469
  * Predefined style to use for the field. Possible values are:
506
- * ...
507
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rendition)
470
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rendition)
508
471
  */
509
472
  rendition? : 'outlined'|'filled'|string
510
473
  /**
@@ -523,23 +486,26 @@ export type BryntumNumberFieldProps = {
523
486
  * Configure as `true` to have the component display a translucent ripple when its
524
487
  * [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
525
488
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
526
- * ...
527
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ripple)
528
- */
529
- ripple? : boolean|{
530
- delegate?: string
531
- color?: string
532
- radius?: number
533
- clip?: string
534
- }
489
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ripple)
490
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
491
+ * @property {string} [color] A CSS color name or specification.
492
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
493
+ * @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.
494
+ */
495
+ ripple? : boolean|object
496
+ /**
497
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
498
+ * accidentally applying a role which may interfere with screen readers.
499
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-role)
500
+ */
501
+ role? : string
535
502
  /**
536
503
  * 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`
537
504
  */
538
505
  rootElement? : ShadowRoot|HTMLElement
539
506
  /**
540
507
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
541
- * ...
542
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rtl)
508
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rtl)
543
509
  */
544
510
  rtl? : boolean
545
511
  /**
@@ -549,8 +515,7 @@ export type BryntumNumberFieldProps = {
549
515
  scrollAction? : 'hide'|'realign'|null
550
516
  /**
551
517
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
552
- * ...
553
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-showAnimation)
518
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-showAnimation)
554
519
  */
555
520
  showAnimation? : boolean|object
556
521
  /**
@@ -586,8 +551,7 @@ export type BryntumNumberFieldProps = {
586
551
  * 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
587
552
  * [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
588
553
  * this widget:
589
- * ...
590
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tab)
554
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tab)
591
555
  */
592
556
  tab? : boolean|TabConfig
593
557
  /**
@@ -595,14 +559,12 @@ export type BryntumNumberFieldProps = {
595
559
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
596
560
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
597
561
  * to the element programmatically.
598
- * ...
599
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tabIndex)
562
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tabIndex)
600
563
  */
601
564
  tabIndex? : number
602
565
  /**
603
566
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
604
- * ...
605
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-textAlign)
567
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-textAlign)
606
568
  */
607
569
  textAlign? : 'left'|'center'|'right'|'start'|'end'
608
570
  /**
@@ -611,22 +573,22 @@ export type BryntumNumberFieldProps = {
611
573
  title? : string
612
574
  /**
613
575
  * Tooltip for the widget, either as a string or as a Tooltip config object.
614
- * ...
615
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tooltip)
576
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tooltip)
616
577
  */
617
578
  tooltip? : string|TooltipConfig|null
618
579
  /**
619
580
  * Widgets that trigger functionality upon click. Each trigger icon is a [Widget](https://bryntum.com/products/core/docs/api/Core/widget/Widget) instance
620
581
  * which may be hidden, shown and observed and styled just like any other widget.
582
+ * @property {FieldTriggerConfig} triggers.spin Shows up and down arrows to increase or decrease the field value based on the [step](https://bryntum.com/products/core/docs/api/Core/widget/NumberField#config-step)
583
+ * @property {FieldTriggerConfig} triggers.clear Clears the field value, only present if this field is [clearable](https://bryntum.com/products/core/docs/api/Core/widget/NumberField#config-clearable)
621
584
  */
622
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
585
+ triggers? : Record<string, FieldTriggerConfig>
623
586
  type? : 'numberfield'|'number'
624
587
  /**
625
588
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
626
589
  * as a space separated string, an array of strings, or as an object in which property names with truthy
627
590
  * values are used as the class names.
628
- * ...
629
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ui)
591
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ui)
630
592
  */
631
593
  ui? : string|object
632
594
  /**
@@ -655,14 +617,12 @@ export type BryntumNumberFieldProps = {
655
617
  wrapAround? : boolean
656
618
  /**
657
619
  * The x position for the widget.
658
- * ...
659
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-x)
620
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-x)
660
621
  */
661
622
  x? : number
662
623
  /**
663
624
  * The y position for the widget.
664
- * ...
665
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-y)
625
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-y)
666
626
  */
667
627
  y? : number
668
628
 
@@ -701,8 +661,7 @@ export type BryntumNumberFieldProps = {
701
661
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
702
662
  /**
703
663
  * Fires when any other event is fired from the object.
704
- * ...
705
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-catchAll)
664
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-catchAll)
706
665
  * @param {object} event Event object
707
666
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
708
667
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -722,8 +681,7 @@ export type BryntumNumberFieldProps = {
722
681
  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
723
682
  /**
724
683
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
725
- * ...
726
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-clear)
684
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-clear)
727
685
  * @param {object} event Event object
728
686
  * @param {Core.widget.Field,any} event.source This Field
729
687
  */
@@ -781,8 +739,7 @@ export type BryntumNumberFieldProps = {
781
739
  /**
782
740
  * Triggered when a widget which had been in a non-visible state for any reason
783
741
  * achieves visibility.
784
- * ...
785
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-paint)
742
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-paint)
786
743
  * @param {object} event Event object
787
744
  * @param {Core.widget.Widget} event.source The widget being painted.
788
745
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -891,6 +848,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
891
848
  'relayStoreEvents',
892
849
  'revertOnEscape',
893
850
  'ripple',
851
+ 'role',
894
852
  'rootElement',
895
853
  'scrollAction',
896
854
  'showAnimation',
@@ -970,9 +928,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
970
928
  ];
971
929
 
972
930
  static propertyNames = [
973
- 'anchorSize',
974
931
  'content',
975
- 'focusVisible',
976
932
  'html',
977
933
  'input',
978
934
  'parent',