@bryntum/core-react-thin 7.2.4 → 7.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +262 -0
  2. package/lib/BryntumBooleanCombo.js +205 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +9 -17
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +9 -16
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +19 -23
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +10 -17
  14. package/lib/BryntumCheckbox.js +2 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +12 -24
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +8 -16
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +12 -23
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +9 -16
  26. package/lib/BryntumColorField.js +2 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +12 -19
  29. package/lib/BryntumCombo.js +2 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +8 -15
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +9 -16
  35. package/lib/BryntumDateField.js +2 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +12 -23
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +12 -19
  41. package/lib/BryntumDateRangeField.js +2 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +9 -16
  44. package/lib/BryntumDateTimeField.js +2 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +12 -23
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +9 -16
  50. package/lib/BryntumDisplayField.js +2 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +9 -16
  53. package/lib/BryntumDurationField.js +2 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +14 -24
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +8 -15
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +9 -16
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +12 -24
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +9 -16
  68. package/lib/BryntumFileField.js +2 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +8 -15
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +9 -16
  74. package/lib/BryntumFilterField.js +2 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +24 -33
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +7 -15
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +8 -16
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +23 -28
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +12 -23
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +9 -16
  92. package/lib/BryntumNumberField.js +2 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +12 -19
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +12 -23
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +9 -16
  101. package/lib/BryntumPasswordField.js +2 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +7 -15
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +10 -17
  107. package/lib/BryntumRadio.js +2 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +12 -24
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +10 -17
  113. package/lib/BryntumSlideToggle.js +2 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +8 -15
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +7 -15
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +13 -24
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +10 -16
  125. package/lib/BryntumTextAreaField.js +3 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +10 -17
  128. package/lib/BryntumTextAreaPickerField.js +2 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +9 -16
  131. package/lib/BryntumTextField.js +2 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +10 -17
  134. package/lib/BryntumTimeField.js +2 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +8 -15
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +12 -19
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +7 -15
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +12 -23
  146. package/lib/BryntumYearPicker.js +2 -5
  147. package/lib/BryntumYearPicker.js.map +1 -1
  148. package/lib/WrapperHelper.js +2 -2
  149. package/lib/WrapperHelper.js.map +1 -1
  150. package/lib/index.d.ts +1 -0
  151. package/lib/index.js +1 -0
  152. package/lib/index.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/BryntumBooleanCombo.tsx +1190 -0
  155. package/src/BryntumButton.tsx +72 -118
  156. package/src/BryntumButtonGroup.tsx +79 -124
  157. package/src/BryntumChatPanel.tsx +142 -172
  158. package/src/BryntumCheckbox.tsx +85 -119
  159. package/src/BryntumCheckboxGroup.tsx +112 -182
  160. package/src/BryntumChipView.tsx +67 -107
  161. package/src/BryntumCodeEditor.tsx +109 -170
  162. package/src/BryntumColorField.tsx +84 -118
  163. package/src/BryntumCombo.tsx +103 -153
  164. package/src/BryntumContainer.tsx +79 -125
  165. package/src/BryntumDateField.tsx +91 -124
  166. package/src/BryntumDatePicker.tsx +122 -196
  167. package/src/BryntumDateRangeField.tsx +90 -127
  168. package/src/BryntumDateTimeField.tsx +84 -118
  169. package/src/BryntumDemoCodeEditor.tsx +109 -170
  170. package/src/BryntumDisplayField.tsx +85 -120
  171. package/src/BryntumDurationField.tsx +91 -126
  172. package/src/BryntumEditor.tsx +95 -145
  173. package/src/BryntumFieldFilterPicker.tsx +81 -129
  174. package/src/BryntumFieldFilterPickerGroup.tsx +84 -134
  175. package/src/BryntumFieldSet.tsx +108 -175
  176. package/src/BryntumFileField.tsx +84 -118
  177. package/src/BryntumFilePicker.tsx +79 -125
  178. package/src/BryntumFilterField.tsx +87 -124
  179. package/src/BryntumHint.tsx +136 -193
  180. package/src/BryntumLabel.tsx +60 -96
  181. package/src/BryntumList.tsx +64 -103
  182. package/src/BryntumMenu.tsx +131 -191
  183. package/src/BryntumMonthPicker.tsx +109 -170
  184. package/src/BryntumNumberField.tsx +88 -122
  185. package/src/BryntumPagingToolbar.tsx +84 -131
  186. package/src/BryntumPanel.tsx +109 -170
  187. package/src/BryntumPasswordField.tsx +84 -118
  188. package/src/BryntumProgressBar.tsx +59 -94
  189. package/src/BryntumRadio.tsx +85 -119
  190. package/src/BryntumRadioGroup.tsx +112 -181
  191. package/src/BryntumSlideToggle.tsx +85 -119
  192. package/src/BryntumSlider.tsx +68 -102
  193. package/src/BryntumSplitter.tsx +62 -100
  194. package/src/BryntumTabPanel.tsx +111 -173
  195. package/src/BryntumTextAreaField.tsx +92 -120
  196. package/src/BryntumTextAreaPickerField.tsx +86 -121
  197. package/src/BryntumTextField.tsx +85 -120
  198. package/src/BryntumTimeField.tsx +90 -121
  199. package/src/BryntumTimePicker.tsx +79 -125
  200. package/src/BryntumToolbar.tsx +84 -131
  201. package/src/BryntumWidget.tsx +60 -96
  202. package/src/BryntumYearPicker.tsx +110 -172
  203. package/src/WrapperHelper.tsx +2 -2
  204. package/src/index.ts +1 -0
@@ -3,7 +3,7 @@
3
3
  */
4
4
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
5
  import React, { RefObject } from 'react';
6
- import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, 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,10 +86,18 @@ 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
92
+ /**
93
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
94
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
95
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
96
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-checkValidity)
97
+ * @param {Core.widget.Field} field The field being validated
98
+ * @returns {void}
99
+ */
100
+ checkValidity? : ((field: Field) => void)|string
100
101
  /**
101
102
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
102
103
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -107,15 +108,13 @@ export type BryntumNumberFieldProps = {
107
108
  * Custom CSS classes to add to element.
108
109
  * May be specified as a space separated string, or as an object in which property names
109
110
  * 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)
111
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-cls)
112
112
  */
113
113
  cls? : string|object
114
114
  /**
115
115
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
116
116
  * `style` block.
117
- * ...
118
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-color)
117
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-color)
119
118
  */
120
119
  color? : Color
121
120
  /**
@@ -132,15 +131,13 @@ export type BryntumNumberFieldProps = {
132
131
  * The configuration for additional items associated to this field. This is typically used to add contextual
133
132
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
134
133
  * these classes for examples of nested fields.
135
- * ...
136
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-container)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-container)
137
135
  */
138
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
136
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
139
137
  /**
140
138
  * The config controls how the value of nested items are handled when a parent container gets or sets its
141
139
  * [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)
140
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-containValues)
144
141
  * @param {Core.widget.Field} field Field instance
145
142
  * @returns {boolean}
146
143
  */
@@ -149,8 +146,7 @@ export type BryntumNumberFieldProps = {
149
146
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
150
147
  * May be specified as a space separated string, or as an object in which property names
151
148
  * 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)
149
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-contentElementCls)
154
150
  */
155
151
  contentElementCls? : string|object
156
152
  /**
@@ -168,16 +164,15 @@ export type BryntumNumberFieldProps = {
168
164
  */
169
165
  defaultBindProperty? : string
170
166
  /**
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)
167
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
168
+ * checks:
169
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-detectCSSCompatibilityIssues)
174
170
  */
175
171
  detectCSSCompatibilityIssues? : boolean
176
172
  /**
177
173
  * 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
174
  * 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)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-disabled)
181
176
  */
182
177
  disabled? : boolean|'inert'
183
178
  /**
@@ -185,33 +180,28 @@ export type BryntumNumberFieldProps = {
185
180
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
186
181
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
187
182
  * body. Such widgets are called "edge strips".
188
- * ...
189
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-dock)
183
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-dock)
190
184
  */
191
185
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
192
186
  /**
193
187
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
194
188
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
195
189
  * 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)
190
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-draggable)
191
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
198
192
  */
199
- draggable? : boolean|{
200
- handleSelector?: string
201
- }
193
+ draggable? : boolean|object
202
194
  /**
203
195
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
204
196
  * [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
197
  * 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)
198
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-editable)
208
199
  */
209
200
  editable? : boolean
210
201
  /**
211
202
  * An object specifying attributes to assign to the root element of this widget.
212
203
  * 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)
204
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-elementAttributes)
215
205
  */
216
206
  elementAttributes? : Record<string, string|null>
217
207
  extraData? : any
@@ -230,8 +220,7 @@ export type BryntumNumberFieldProps = {
230
220
  floating? : boolean
231
221
  /**
232
222
  * The format to use for rendering numbers.
233
- * ...
234
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-format)
223
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-format)
235
224
  */
236
225
  format? : string|NumberFormatConfig
237
226
  /**
@@ -246,8 +235,7 @@ export type BryntumNumberFieldProps = {
246
235
  hidden? : boolean
247
236
  /**
248
237
  * *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)
238
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hideAnimation)
251
239
  */
252
240
  hideAnimation? : boolean|object
253
241
  /**
@@ -257,8 +245,7 @@ export type BryntumNumberFieldProps = {
257
245
  /**
258
246
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
259
247
  * a field's units.
260
- * ...
261
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hint)
248
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hint)
262
249
  * @param {object} data A data object
263
250
  * @param {Core.widget.Field} data.source A reference to the field instance
264
251
  * @param {any} data.value The current value of the field
@@ -269,8 +256,7 @@ export type BryntumNumberFieldProps = {
269
256
  * 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
257
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
271
258
  * 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)
259
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-hintHtml)
274
260
  * @param {object} data A data object
275
261
  * @param {Core.widget.Field} data.source A reference to the field instance
276
262
  * @param {any} data.value The current value of the field
@@ -283,16 +269,14 @@ export type BryntumNumberFieldProps = {
283
269
  id? : string
284
270
  /**
285
271
  * 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)
272
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ignoreParentReadOnly)
288
273
  */
289
274
  ignoreParentReadOnly? : boolean
290
275
  /**
291
276
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
292
277
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
293
278
  * [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)
279
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-inline)
296
280
  */
297
281
  inline? : boolean
298
282
  /**
@@ -336,16 +320,14 @@ export type BryntumNumberFieldProps = {
336
320
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
337
321
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
338
322
  * 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)
323
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyMap)
341
324
  */
342
325
  keyMap? : Record<string, KeyMapConfig>
343
326
  /**
344
327
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
345
328
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
346
329
  * 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)
330
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-keyStrokeChangeDelay)
349
331
  */
350
332
  keyStrokeChangeDelay? : number
351
333
  /**
@@ -358,15 +340,15 @@ export type BryntumNumberFieldProps = {
358
340
  labelCls? : string|object
359
341
  /**
360
342
  * 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)
343
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labelPosition)
363
344
  */
364
345
  labelPosition? : 'before'|'above'|null
365
346
  /**
366
347
  * The labels to add either before or after the input field.
367
348
  * Each label may have the following properties:
368
- * ...
369
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labels)
349
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-labels)
350
+ * @property {string} html Label text
351
+ * @property {'start','end'} align Which end of the file the label should go
370
352
  */
371
353
  labels? : object[]
372
354
  /**
@@ -383,16 +365,14 @@ export type BryntumNumberFieldProps = {
383
365
  largeStep? : number
384
366
  /**
385
367
  * The listener set for this object.
386
- * ...
387
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-listeners)
368
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-listeners)
388
369
  */
389
370
  listeners? : NumberFieldListeners
390
371
  /**
391
372
  * A class translations of which are used for translating this entity.
392
373
  * This is often used when translations of an item are defined on its container class.
393
374
  * For example:
394
- * ...
395
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localeClass)
375
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localeClass)
396
376
  */
397
377
  localeClass? : typeof Base
398
378
  /**
@@ -404,8 +384,7 @@ export type BryntumNumberFieldProps = {
404
384
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
405
385
  * you could use 'localeKey' meta configuration.
406
386
  * Example:
407
- * ...
408
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localizableProperties)
387
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-localizableProperties)
409
388
  */
410
389
  localizableProperties? : string[]
411
390
  /**
@@ -435,8 +414,7 @@ export type BryntumNumberFieldProps = {
435
414
  maxHeight? : string|number
436
415
  /**
437
416
  * *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)
417
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-maximizeOnMobile)
440
418
  */
441
419
  maximizeOnMobile? : number|string
442
420
  /**
@@ -462,18 +440,15 @@ export type BryntumNumberFieldProps = {
462
440
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
463
441
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
464
442
  * layout.
465
- * ...
466
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-monitorResize)
443
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-monitorResize)
444
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
467
445
  */
468
- monitorResize? : boolean|{
469
- immediate?: boolean
470
- }
446
+ monitorResize? : boolean|object
471
447
  /**
472
448
  * Name of the field which is used as a key to get/set values from/to the field.
473
449
  * 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
450
  * [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)
451
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-name)
477
452
  */
478
453
  name? : string
479
454
  /**
@@ -484,8 +459,7 @@ export type BryntumNumberFieldProps = {
484
459
  * 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
460
  * not participate in the standard layout of that widget, and must be positioned relatively to that
486
461
  * 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)
462
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-positioned)
489
463
  */
490
464
  positioned? : boolean
491
465
  /**
@@ -496,15 +470,13 @@ export type BryntumNumberFieldProps = {
496
470
  /**
497
471
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
498
472
  * are unresponsive.
499
- * ...
500
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-readOnly)
473
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-readOnly)
501
474
  */
502
475
  readOnly? : boolean
503
476
  relayStoreEvents? : boolean
504
477
  /**
505
478
  * 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)
479
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rendition)
508
480
  */
509
481
  rendition? : 'outlined'|'filled'|string
510
482
  /**
@@ -523,23 +495,26 @@ export type BryntumNumberFieldProps = {
523
495
  * Configure as `true` to have the component display a translucent ripple when its
524
496
  * [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
497
  * 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
- }
498
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ripple)
499
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
500
+ * @property {string} [color] A CSS color name or specification.
501
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
502
+ * @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.
503
+ */
504
+ ripple? : boolean|object
505
+ /**
506
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
507
+ * accidentally applying a role which may interfere with screen readers.
508
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-role)
509
+ */
510
+ role? : string
535
511
  /**
536
512
  * 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
513
  */
538
514
  rootElement? : ShadowRoot|HTMLElement
539
515
  /**
540
516
  * 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)
517
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-rtl)
543
518
  */
544
519
  rtl? : boolean
545
520
  /**
@@ -549,8 +524,7 @@ export type BryntumNumberFieldProps = {
549
524
  scrollAction? : 'hide'|'realign'|null
550
525
  /**
551
526
  * *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)
527
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-showAnimation)
554
528
  */
555
529
  showAnimation? : boolean|object
556
530
  /**
@@ -586,8 +560,7 @@ export type BryntumNumberFieldProps = {
586
560
  * 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
561
  * [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
562
  * this widget:
589
- * ...
590
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tab)
563
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tab)
591
564
  */
592
565
  tab? : boolean|TabConfig
593
566
  /**
@@ -595,14 +568,12 @@ export type BryntumNumberFieldProps = {
595
568
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
596
569
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
597
570
  * to the element programmatically.
598
- * ...
599
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tabIndex)
571
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tabIndex)
600
572
  */
601
573
  tabIndex? : number
602
574
  /**
603
575
  * 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)
576
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-textAlign)
606
577
  */
607
578
  textAlign? : 'left'|'center'|'right'|'start'|'end'
608
579
  /**
@@ -611,22 +582,22 @@ export type BryntumNumberFieldProps = {
611
582
  title? : string
612
583
  /**
613
584
  * 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)
585
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-tooltip)
616
586
  */
617
587
  tooltip? : string|TooltipConfig|null
618
588
  /**
619
589
  * Widgets that trigger functionality upon click. Each trigger icon is a [Widget](https://bryntum.com/products/core/docs/api/Core/widget/Widget) instance
620
590
  * which may be hidden, shown and observed and styled just like any other widget.
591
+ * @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)
592
+ * @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
593
  */
622
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
594
+ triggers? : Record<string, FieldTriggerConfig>
623
595
  type? : 'numberfield'|'number'
624
596
  /**
625
597
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
626
598
  * as a space separated string, an array of strings, or as an object in which property names with truthy
627
599
  * values are used as the class names.
628
- * ...
629
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ui)
600
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-ui)
630
601
  */
631
602
  ui? : string|object
632
603
  /**
@@ -655,14 +626,12 @@ export type BryntumNumberFieldProps = {
655
626
  wrapAround? : boolean
656
627
  /**
657
628
  * The x position for the widget.
658
- * ...
659
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-x)
629
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-x)
660
630
  */
661
631
  x? : number
662
632
  /**
663
633
  * The y position for the widget.
664
- * ...
665
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-y)
634
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-y)
666
635
  */
667
636
  y? : number
668
637
 
@@ -692,7 +661,7 @@ export type BryntumNumberFieldProps = {
692
661
  * @param {object} event Event object
693
662
  * @param {Core.widget.Widget} event.source The widget being hidden.
694
663
  */
695
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
664
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
696
665
  /**
697
666
  * Triggered before a widget is shown. Return `false` to prevent the action.
698
667
  * @param {object} event Event object
@@ -701,8 +670,7 @@ export type BryntumNumberFieldProps = {
701
670
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
702
671
  /**
703
672
  * 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)
673
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-catchAll)
706
674
  * @param {object} event Event object
707
675
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
708
676
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -722,8 +690,7 @@ export type BryntumNumberFieldProps = {
722
690
  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
691
  /**
724
692
  * 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)
693
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-clear)
727
694
  * @param {object} event Event object
728
695
  * @param {Core.widget.Field,any} event.source This Field
729
696
  */
@@ -781,8 +748,7 @@ export type BryntumNumberFieldProps = {
781
748
  /**
782
749
  * Triggered when a widget which had been in a non-visible state for any reason
783
750
  * achieves visibility.
784
- * ...
785
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-paint)
751
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#event-paint)
786
752
  * @param {object} event Event object
787
753
  * @param {Core.widget.Widget} event.source The widget being painted.
788
754
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -844,6 +810,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
844
810
  'bubbleEvents',
845
811
  'centered',
846
812
  'changeOnSpin',
813
+ 'checkValidity',
847
814
  'clearable',
848
815
  'color',
849
816
  'config',
@@ -891,6 +858,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
891
858
  'relayStoreEvents',
892
859
  'revertOnEscape',
893
860
  'ripple',
861
+ 'role',
894
862
  'rootElement',
895
863
  'scrollAction',
896
864
  'showAnimation',
@@ -970,9 +938,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
970
938
  ];
971
939
 
972
940
  static propertyNames = [
973
- 'anchorSize',
974
941
  'content',
975
- 'focusVisible',
976
942
  'html',
977
943
  'input',
978
944
  'parent',