@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, Rectangle, Scroller, TabConfig, TextField, TextFieldListeners, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TextField, TextFieldListeners, 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 BryntumTextFieldProps = {
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/TextField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#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/TextField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumTextFieldProps = {
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/TextField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#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/TextField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -68,21 +64,18 @@ export type BryntumTextFieldProps = {
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/TextField#config-bubbleEvents)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#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/TextField#config-callOnFunctions)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#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/TextField#config-catchEventHandlerExceptions)
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-catchEventHandlerExceptions)
86
79
  */
87
80
  catchEventHandlerExceptions? : boolean
88
81
  /**
@@ -90,6 +83,15 @@ export type BryntumTextFieldProps = {
90
83
  * Set to `true` to centre the Widget in browser viewport space.
91
84
  */
92
85
  centered? : boolean
86
+ /**
87
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
88
+ * 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)
89
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-checkValidity)
91
+ * @param {Core.widget.Field} field The field being validated
92
+ * @returns {void}
93
+ */
94
+ checkValidity? : ((field: Field) => void)|string
93
95
  /**
94
96
  * 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
95
97
  * 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
@@ -100,15 +102,13 @@ export type BryntumTextFieldProps = {
100
102
  * Custom CSS classes to add to element.
101
103
  * May be specified as a space separated string, or as an object in which property names
102
104
  * with truthy values are used as the class names:
103
- * ...
104
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-cls)
105
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-cls)
105
106
  */
106
107
  cls? : string|object
107
108
  /**
108
109
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
109
110
  * `style` block.
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-color)
111
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-color)
112
112
  */
113
113
  color? : Color
114
114
  /**
@@ -125,15 +125,13 @@ export type BryntumTextFieldProps = {
125
125
  * The configuration for additional items associated to this field. This is typically used to add contextual
126
126
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
127
127
  * these classes for examples of nested fields.
128
- * ...
129
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-container)
128
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-container)
130
129
  */
131
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
130
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
132
131
  /**
133
132
  * The config controls how the value of nested items are handled when a parent container gets or sets its
134
133
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
135
- * ...
136
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-containValues)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-containValues)
137
135
  * @param {Core.widget.Field} field Field instance
138
136
  * @returns {boolean}
139
137
  */
@@ -142,8 +140,7 @@ export type BryntumTextFieldProps = {
142
140
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
143
141
  * May be specified as a space separated string, or as an object in which property names
144
142
  * with truthy values are used as the class names:
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-contentElementCls)
143
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-contentElementCls)
147
144
  */
148
145
  contentElementCls? : string|object
149
146
  /**
@@ -161,16 +158,15 @@ export type BryntumTextFieldProps = {
161
158
  */
162
159
  defaultBindProperty? : string
163
160
  /**
164
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
165
- * ...
166
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-detectCSSCompatibilityIssues)
161
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
162
+ * checks:
163
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-detectCSSCompatibilityIssues)
167
164
  */
168
165
  detectCSSCompatibilityIssues? : boolean
169
166
  /**
170
167
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
171
168
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
172
- * ...
173
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-disabled)
169
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-disabled)
174
170
  */
175
171
  disabled? : boolean|'inert'
176
172
  /**
@@ -178,33 +174,28 @@ export type BryntumTextFieldProps = {
178
174
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
179
175
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
180
176
  * body. Such widgets are called "edge strips".
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-dock)
177
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-dock)
183
178
  */
184
179
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
185
180
  /**
186
181
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
187
182
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
188
183
  * property which controls when a drag should start.
189
- * ...
190
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-draggable)
184
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-draggable)
185
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
191
186
  */
192
- draggable? : boolean|{
193
- handleSelector?: string
194
- }
187
+ draggable? : boolean|object
195
188
  /**
196
189
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
197
190
  * [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
198
191
  * but not to type one in the field.
199
- * ...
200
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-editable)
192
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-editable)
201
193
  */
202
194
  editable? : boolean
203
195
  /**
204
196
  * An object specifying attributes to assign to the root element of this widget.
205
197
  * Set `null` value to attribute to remove it.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-elementAttributes)
198
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-elementAttributes)
208
199
  */
209
200
  elementAttributes? : Record<string, string|null>
210
201
  extraData? : any
@@ -233,8 +224,7 @@ export type BryntumTextFieldProps = {
233
224
  hidden? : boolean
234
225
  /**
235
226
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
236
- * ...
237
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hideAnimation)
227
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hideAnimation)
238
228
  */
239
229
  hideAnimation? : boolean|object
240
230
  /**
@@ -244,8 +234,7 @@ export type BryntumTextFieldProps = {
244
234
  /**
245
235
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
246
236
  * a field's units.
247
- * ...
248
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hint)
237
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hint)
249
238
  * @param {object} data A data object
250
239
  * @param {Core.widget.Field} data.source A reference to the field instance
251
240
  * @param {any} data.value The current value of the field
@@ -256,8 +245,7 @@ export type BryntumTextFieldProps = {
256
245
  * 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.
257
246
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
258
247
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
259
- * ...
260
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hintHtml)
248
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-hintHtml)
261
249
  * @param {object} data A data object
262
250
  * @param {Core.widget.Field} data.source A reference to the field instance
263
251
  * @param {any} data.value The current value of the field
@@ -270,16 +258,14 @@ export type BryntumTextFieldProps = {
270
258
  id? : string
271
259
  /**
272
260
  * Determines if the widgets read-only state should be controlled by its parent.
273
- * ...
274
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ignoreParentReadOnly)
261
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ignoreParentReadOnly)
275
262
  */
276
263
  ignoreParentReadOnly? : boolean
277
264
  /**
278
265
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
279
266
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
280
267
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
281
- * ...
282
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-inline)
268
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-inline)
283
269
  */
284
270
  inline? : boolean
285
271
  /**
@@ -319,16 +305,14 @@ export type BryntumTextFieldProps = {
319
305
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
320
306
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
321
307
  * are the name of the instance method to call when the keystroke is received.
322
- * ...
323
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-keyMap)
308
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-keyMap)
324
309
  */
325
310
  keyMap? : Record<string, KeyMapConfig>
326
311
  /**
327
312
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
328
313
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
329
314
  * immediate feedback, change will still be triggered on blur).
330
- * ...
331
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-keyStrokeChangeDelay)
315
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-keyStrokeChangeDelay)
332
316
  */
333
317
  keyStrokeChangeDelay? : number
334
318
  /**
@@ -341,15 +325,15 @@ export type BryntumTextFieldProps = {
341
325
  labelCls? : string|object
342
326
  /**
343
327
  * Label position, either 'before' the field or 'above' the field
344
- * ...
345
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-labelPosition)
328
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-labelPosition)
346
329
  */
347
330
  labelPosition? : 'before'|'above'|null
348
331
  /**
349
332
  * The labels to add either before or after the input field.
350
333
  * Each label may have the following properties:
351
- * ...
352
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-labels)
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-labels)
335
+ * @property {string} html Label text
336
+ * @property {'start','end'} align Which end of the file the label should go
353
337
  */
354
338
  labels? : object[]
355
339
  /**
@@ -358,16 +342,14 @@ export type BryntumTextFieldProps = {
358
342
  labelWidth? : string|number
359
343
  /**
360
344
  * The listener set for this object.
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-listeners)
345
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-listeners)
363
346
  */
364
347
  listeners? : TextFieldListeners
365
348
  /**
366
349
  * A class translations of which are used for translating this entity.
367
350
  * This is often used when translations of an item are defined on its container class.
368
351
  * For example:
369
- * ...
370
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-localeClass)
352
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-localeClass)
371
353
  */
372
354
  localeClass? : typeof Base
373
355
  /**
@@ -379,8 +361,7 @@ export type BryntumTextFieldProps = {
379
361
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
380
362
  * you could use 'localeKey' meta configuration.
381
363
  * Example:
382
- * ...
383
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-localizableProperties)
364
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-localizableProperties)
384
365
  */
385
366
  localizableProperties? : string[]
386
367
  /**
@@ -406,8 +387,7 @@ export type BryntumTextFieldProps = {
406
387
  maxHeight? : string|number
407
388
  /**
408
389
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
409
- * ...
410
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-maximizeOnMobile)
390
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-maximizeOnMobile)
411
391
  */
412
392
  maximizeOnMobile? : number|string
413
393
  /**
@@ -437,18 +417,15 @@ export type BryntumTextFieldProps = {
437
417
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
438
418
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
439
419
  * layout.
440
- * ...
441
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-monitorResize)
420
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-monitorResize)
421
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
442
422
  */
443
- monitorResize? : boolean|{
444
- immediate?: boolean
445
- }
423
+ monitorResize? : boolean|object
446
424
  /**
447
425
  * Name of the field which is used as a key to get/set values from/to the field.
448
426
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
449
427
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
450
- * ...
451
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-name)
428
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-name)
452
429
  */
453
430
  name? : string
454
431
  /**
@@ -459,8 +436,7 @@ export type BryntumTextFieldProps = {
459
436
  * 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
460
437
  * not participate in the standard layout of that widget, and must be positioned relatively to that
461
438
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
462
- * ...
463
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-positioned)
439
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-positioned)
464
440
  */
465
441
  positioned? : boolean
466
442
  /**
@@ -471,15 +447,13 @@ export type BryntumTextFieldProps = {
471
447
  /**
472
448
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
473
449
  * are unresponsive.
474
- * ...
475
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-readOnly)
450
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-readOnly)
476
451
  */
477
452
  readOnly? : boolean
478
453
  relayStoreEvents? : boolean
479
454
  /**
480
455
  * Predefined style to use for the field. Possible values are:
481
- * ...
482
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-rendition)
456
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-rendition)
483
457
  */
484
458
  rendition? : 'outlined'|'filled'|string
485
459
  /**
@@ -498,23 +472,26 @@ export type BryntumTextFieldProps = {
498
472
  * Configure as `true` to have the component display a translucent ripple when its
499
473
  * [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
500
474
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ripple)
503
- */
504
- ripple? : boolean|{
505
- delegate?: string
506
- color?: string
507
- radius?: number
508
- clip?: string
509
- }
475
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ripple)
476
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
477
+ * @property {string} [color] A CSS color name or specification.
478
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
479
+ * @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.
480
+ */
481
+ ripple? : boolean|object
482
+ /**
483
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
484
+ * accidentally applying a role which may interfere with screen readers.
485
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-role)
486
+ */
487
+ role? : string
510
488
  /**
511
489
  * 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`
512
490
  */
513
491
  rootElement? : ShadowRoot|HTMLElement
514
492
  /**
515
493
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
516
- * ...
517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-rtl)
494
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-rtl)
518
495
  */
519
496
  rtl? : boolean
520
497
  /**
@@ -524,8 +501,7 @@ export type BryntumTextFieldProps = {
524
501
  scrollAction? : 'hide'|'realign'|null
525
502
  /**
526
503
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
527
- * ...
528
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-showAnimation)
504
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-showAnimation)
529
505
  */
530
506
  showAnimation? : boolean|object
531
507
  /**
@@ -554,8 +530,7 @@ export type BryntumTextFieldProps = {
554
530
  * 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
555
531
  * [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
556
532
  * this widget:
557
- * ...
558
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tab)
533
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tab)
559
534
  */
560
535
  tab? : boolean|TabConfig
561
536
  /**
@@ -563,14 +538,12 @@ export type BryntumTextFieldProps = {
563
538
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
564
539
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
565
540
  * to the element programmatically.
566
- * ...
567
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tabIndex)
541
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tabIndex)
568
542
  */
569
543
  tabIndex? : number
570
544
  /**
571
545
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
572
- * ...
573
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-textAlign)
546
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-textAlign)
574
547
  */
575
548
  textAlign? : 'left'|'center'|'right'|'start'|'end'
576
549
  /**
@@ -579,24 +552,21 @@ export type BryntumTextFieldProps = {
579
552
  title? : string
580
553
  /**
581
554
  * Tooltip for the widget, either as a string or as a Tooltip config object.
582
- * ...
583
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tooltip)
555
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-tooltip)
584
556
  */
585
557
  tooltip? : string|TooltipConfig|null
586
558
  /**
587
559
  * The triggers to add either before or after the input field. Each property name is the reference by which
588
560
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
589
- * ...
590
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-triggers)
561
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-triggers)
591
562
  */
592
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
563
+ triggers? : Record<string, FieldTriggerConfig>
593
564
  type? : 'textfield'|'text'
594
565
  /**
595
566
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
596
567
  * as a space separated string, an array of strings, or as an object in which property names with truthy
597
568
  * values are used as the class names.
598
- * ...
599
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ui)
569
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-ui)
600
570
  */
601
571
  ui? : string|object
602
572
  /**
@@ -621,14 +591,12 @@ export type BryntumTextFieldProps = {
621
591
  width? : string|number
622
592
  /**
623
593
  * The x position for the widget.
624
- * ...
625
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-x)
594
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-x)
626
595
  */
627
596
  x? : number
628
597
  /**
629
598
  * The y position for the widget.
630
- * ...
631
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-y)
599
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-y)
632
600
  */
633
601
  y? : number
634
602
 
@@ -658,7 +626,7 @@ export type BryntumTextFieldProps = {
658
626
  * @param {object} event Event object
659
627
  * @param {Core.widget.Widget} event.source The widget being hidden.
660
628
  */
661
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
629
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
662
630
  /**
663
631
  * Triggered before a widget is shown. Return `false` to prevent the action.
664
632
  * @param {object} event Event object
@@ -667,8 +635,7 @@ export type BryntumTextFieldProps = {
667
635
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
668
636
  /**
669
637
  * Fires when any other event is fired from the object.
670
- * ...
671
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-catchAll)
638
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-catchAll)
672
639
  * @param {object} event Event object
673
640
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
674
641
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -688,8 +655,7 @@ export type BryntumTextFieldProps = {
688
655
  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
689
656
  /**
690
657
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
691
- * ...
692
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-clear)
658
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-clear)
693
659
  * @param {object} event Event object
694
660
  * @param {Core.widget.Field,any} event.source This Field
695
661
  */
@@ -747,8 +713,7 @@ export type BryntumTextFieldProps = {
747
713
  /**
748
714
  * Triggered when a widget which had been in a non-visible state for any reason
749
715
  * achieves visibility.
750
- * ...
751
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-paint)
716
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#event-paint)
752
717
  * @param {object} event Event object
753
718
  * @param {Core.widget.Widget} event.source The widget being painted.
754
719
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -809,6 +774,7 @@ export class BryntumTextField extends React.Component<BryntumTextFieldProps> {
809
774
  'autoSelect',
810
775
  'bubbleEvents',
811
776
  'centered',
777
+ 'checkValidity',
812
778
  'clearable',
813
779
  'color',
814
780
  'config',
@@ -854,6 +820,7 @@ export class BryntumTextField extends React.Component<BryntumTextFieldProps> {
854
820
  'relayStoreEvents',
855
821
  'revertOnEscape',
856
822
  'ripple',
823
+ 'role',
857
824
  'rootElement',
858
825
  'scrollAction',
859
826
  'showAnimation',
@@ -931,9 +898,7 @@ export class BryntumTextField extends React.Component<BryntumTextFieldProps> {
931
898
  ];
932
899
 
933
900
  static propertyNames = [
934
- 'anchorSize',
935
901
  'content',
936
- 'focusVisible',
937
902
  'formula',
938
903
  'html',
939
904
  'input',