@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, TextAreaField, TextAreaFieldListeners, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TextAreaField, TextAreaFieldListeners, 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 BryntumTextAreaFieldProps = {
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/TextAreaField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#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/TextAreaField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumTextAreaFieldProps = {
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/TextAreaField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#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/TextAreaField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -57,6 +53,12 @@ export type BryntumTextAreaFieldProps = {
57
53
  * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
58
54
  */
59
55
  autoComplete? : string
56
+ /**
57
+ * Set to `true` to make the textarea automatically grow and shrink vertically to fit its content.
58
+ * When enabled, the textarea height adjusts on each input.
59
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-autoHeight)
60
+ */
61
+ autoHeight? : boolean
60
62
  /**
61
63
  * Specify `true` to auto select field contents on focus
62
64
  */
@@ -68,21 +70,18 @@ export type BryntumTextAreaFieldProps = {
68
70
  /**
69
71
  * An object where property names with a truthy value indicate which events should bubble up the ownership
70
72
  * hierarchy when triggered.
71
- * ...
72
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-bubbleEvents)
73
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-bubbleEvents)
73
74
  */
74
75
  bubbleEvents? : object
75
76
  /**
76
77
  * 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/TextAreaField#config-callOnFunctions)
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-callOnFunctions)
79
79
  */
80
80
  callOnFunctions? : boolean
81
81
  /**
82
82
  * By default, if an event handler throws an exception, the error propagates up the stack and the
83
83
  * 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/TextAreaField#config-catchEventHandlerExceptions)
84
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-catchEventHandlerExceptions)
86
85
  */
87
86
  catchEventHandlerExceptions? : boolean
88
87
  /**
@@ -90,6 +89,15 @@ export type BryntumTextAreaFieldProps = {
90
89
  * Set to `true` to centre the Widget in browser viewport space.
91
90
  */
92
91
  centered? : boolean
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/TextAreaField#config-checkValidity)
97
+ * @param {Core.widget.Field} field The field being validated
98
+ * @returns {void}
99
+ */
100
+ checkValidity? : ((field: Field) => void)|string
93
101
  /**
94
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
95
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
@@ -100,15 +108,13 @@ export type BryntumTextAreaFieldProps = {
100
108
  * Custom CSS classes to add to element.
101
109
  * May be specified as a space separated string, or as an object in which property names
102
110
  * with truthy values are used as the class names:
103
- * ...
104
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-cls)
111
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-cls)
105
112
  */
106
113
  cls? : string|object
107
114
  /**
108
115
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
109
116
  * `style` block.
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-color)
117
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-color)
112
118
  */
113
119
  color? : Color
114
120
  /**
@@ -125,15 +131,13 @@ export type BryntumTextAreaFieldProps = {
125
131
  * The configuration for additional items associated to this field. This is typically used to add contextual
126
132
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
127
133
  * these classes for examples of nested fields.
128
- * ...
129
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-container)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-container)
130
135
  */
131
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
136
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
132
137
  /**
133
138
  * The config controls how the value of nested items are handled when a parent container gets or sets its
134
139
  * [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/TextAreaField#config-containValues)
140
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-containValues)
137
141
  * @param {Core.widget.Field} field Field instance
138
142
  * @returns {boolean}
139
143
  */
@@ -142,8 +146,7 @@ export type BryntumTextAreaFieldProps = {
142
146
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
143
147
  * May be specified as a space separated string, or as an object in which property names
144
148
  * with truthy values are used as the class names:
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-contentElementCls)
149
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-contentElementCls)
147
150
  */
148
151
  contentElementCls? : string|object
149
152
  /**
@@ -161,16 +164,15 @@ export type BryntumTextAreaFieldProps = {
161
164
  */
162
165
  defaultBindProperty? : string
163
166
  /**
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/TextAreaField#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/TextAreaField#config-detectCSSCompatibilityIssues)
167
170
  */
168
171
  detectCSSCompatibilityIssues? : boolean
169
172
  /**
170
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
171
174
  * 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/TextAreaField#config-disabled)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-disabled)
174
176
  */
175
177
  disabled? : boolean|'inert'
176
178
  /**
@@ -178,33 +180,28 @@ export type BryntumTextAreaFieldProps = {
178
180
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
179
181
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
180
182
  * body. Such widgets are called "edge strips".
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-dock)
183
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-dock)
183
184
  */
184
185
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
185
186
  /**
186
187
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
187
188
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
188
189
  * property which controls when a drag should start.
189
- * ...
190
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-draggable)
190
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-draggable)
191
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
191
192
  */
192
- draggable? : boolean|{
193
- handleSelector?: string
194
- }
193
+ draggable? : boolean|object
195
194
  /**
196
195
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
197
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
198
197
  * but not to type one in the field.
199
- * ...
200
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-editable)
198
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-editable)
201
199
  */
202
200
  editable? : boolean
203
201
  /**
204
202
  * An object specifying attributes to assign to the root element of this widget.
205
203
  * Set `null` value to attribute to remove it.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-elementAttributes)
204
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-elementAttributes)
208
205
  */
209
206
  elementAttributes? : Record<string, string|null>
210
207
  extraData? : any
@@ -233,8 +230,7 @@ export type BryntumTextAreaFieldProps = {
233
230
  hidden? : boolean
234
231
  /**
235
232
  * *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/TextAreaField#config-hideAnimation)
233
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-hideAnimation)
238
234
  */
239
235
  hideAnimation? : boolean|object
240
236
  /**
@@ -244,8 +240,7 @@ export type BryntumTextAreaFieldProps = {
244
240
  /**
245
241
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
246
242
  * a field's units.
247
- * ...
248
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-hint)
243
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-hint)
249
244
  * @param {object} data A data object
250
245
  * @param {Core.widget.Field} data.source A reference to the field instance
251
246
  * @param {any} data.value The current value of the field
@@ -256,8 +251,7 @@ export type BryntumTextAreaFieldProps = {
256
251
  * 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
252
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
258
253
  * 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/TextAreaField#config-hintHtml)
254
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-hintHtml)
261
255
  * @param {object} data A data object
262
256
  * @param {Core.widget.Field} data.source A reference to the field instance
263
257
  * @param {any} data.value The current value of the field
@@ -270,16 +264,14 @@ export type BryntumTextAreaFieldProps = {
270
264
  id? : string
271
265
  /**
272
266
  * 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/TextAreaField#config-ignoreParentReadOnly)
267
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ignoreParentReadOnly)
275
268
  */
276
269
  ignoreParentReadOnly? : boolean
277
270
  /**
278
271
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
279
272
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
280
273
  * [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/TextAreaField#config-inline)
274
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-inline)
283
275
  */
284
276
  inline? : boolean
285
277
  /**
@@ -319,16 +311,14 @@ export type BryntumTextAreaFieldProps = {
319
311
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
320
312
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
321
313
  * 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/TextAreaField#config-keyMap)
314
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-keyMap)
324
315
  */
325
316
  keyMap? : Record<string, KeyMapConfig>
326
317
  /**
327
318
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
328
319
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
329
320
  * immediate feedback, change will still be triggered on blur).
330
- * ...
331
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-keyStrokeChangeDelay)
321
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-keyStrokeChangeDelay)
332
322
  */
333
323
  keyStrokeChangeDelay? : number
334
324
  /**
@@ -341,15 +331,15 @@ export type BryntumTextAreaFieldProps = {
341
331
  labelCls? : string|object
342
332
  /**
343
333
  * Label position, either 'before' the field or 'above' the field
344
- * ...
345
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-labelPosition)
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-labelPosition)
346
335
  */
347
336
  labelPosition? : 'before'|'above'|null
348
337
  /**
349
338
  * The labels to add either before or after the input field.
350
339
  * Each label may have the following properties:
351
- * ...
352
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-labels)
340
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-labels)
341
+ * @property {string} html Label text
342
+ * @property {'start','end'} align Which end of the file the label should go
353
343
  */
354
344
  labels? : object[]
355
345
  /**
@@ -358,16 +348,14 @@ export type BryntumTextAreaFieldProps = {
358
348
  labelWidth? : string|number
359
349
  /**
360
350
  * The listener set for this object.
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-listeners)
351
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-listeners)
363
352
  */
364
353
  listeners? : TextAreaFieldListeners
365
354
  /**
366
355
  * A class translations of which are used for translating this entity.
367
356
  * This is often used when translations of an item are defined on its container class.
368
357
  * For example:
369
- * ...
370
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-localeClass)
358
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-localeClass)
371
359
  */
372
360
  localeClass? : typeof Base
373
361
  /**
@@ -379,8 +367,7 @@ export type BryntumTextAreaFieldProps = {
379
367
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
380
368
  * you could use 'localeKey' meta configuration.
381
369
  * Example:
382
- * ...
383
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-localizableProperties)
370
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-localizableProperties)
384
371
  */
385
372
  localizableProperties? : string[]
386
373
  /**
@@ -406,8 +393,7 @@ export type BryntumTextAreaFieldProps = {
406
393
  maxHeight? : string|number
407
394
  /**
408
395
  * *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/TextAreaField#config-maximizeOnMobile)
396
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-maximizeOnMobile)
411
397
  */
412
398
  maximizeOnMobile? : number|string
413
399
  /**
@@ -429,18 +415,15 @@ export type BryntumTextAreaFieldProps = {
429
415
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
430
416
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
431
417
  * layout.
432
- * ...
433
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-monitorResize)
418
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-monitorResize)
419
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
434
420
  */
435
- monitorResize? : boolean|{
436
- immediate?: boolean
437
- }
421
+ monitorResize? : boolean|object
438
422
  /**
439
423
  * Name of the field which is used as a key to get/set values from/to the field.
440
424
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
441
425
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
442
- * ...
443
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-name)
426
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-name)
444
427
  */
445
428
  name? : string
446
429
  /**
@@ -451,8 +434,7 @@ export type BryntumTextAreaFieldProps = {
451
434
  * 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
452
435
  * not participate in the standard layout of that widget, and must be positioned relatively to that
453
436
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
454
- * ...
455
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-positioned)
437
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-positioned)
456
438
  */
457
439
  positioned? : boolean
458
440
  /**
@@ -463,15 +445,13 @@ export type BryntumTextAreaFieldProps = {
463
445
  /**
464
446
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
465
447
  * are unresponsive.
466
- * ...
467
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-readOnly)
448
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-readOnly)
468
449
  */
469
450
  readOnly? : boolean
470
451
  relayStoreEvents? : boolean
471
452
  /**
472
453
  * Predefined style to use for the field. Possible values are:
473
- * ...
474
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-rendition)
454
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-rendition)
475
455
  */
476
456
  rendition? : 'outlined'|'filled'|string
477
457
  /**
@@ -494,23 +474,26 @@ export type BryntumTextAreaFieldProps = {
494
474
  * Configure as `true` to have the component display a translucent ripple when its
495
475
  * [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
496
476
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
497
- * ...
498
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ripple)
499
- */
500
- ripple? : boolean|{
501
- delegate?: string
502
- color?: string
503
- radius?: number
504
- clip?: string
505
- }
477
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ripple)
478
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
479
+ * @property {string} [color] A CSS color name or specification.
480
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
481
+ * @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.
482
+ */
483
+ ripple? : boolean|object
484
+ /**
485
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
486
+ * accidentally applying a role which may interfere with screen readers.
487
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-role)
488
+ */
489
+ role? : string
506
490
  /**
507
491
  * 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`
508
492
  */
509
493
  rootElement? : ShadowRoot|HTMLElement
510
494
  /**
511
495
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
512
- * ...
513
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-rtl)
496
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-rtl)
514
497
  */
515
498
  rtl? : boolean
516
499
  /**
@@ -520,8 +503,7 @@ export type BryntumTextAreaFieldProps = {
520
503
  scrollAction? : 'hide'|'realign'|null
521
504
  /**
522
505
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
523
- * ...
524
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-showAnimation)
506
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-showAnimation)
525
507
  */
526
508
  showAnimation? : boolean|object
527
509
  /**
@@ -550,8 +532,7 @@ export type BryntumTextAreaFieldProps = {
550
532
  * 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
551
533
  * [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
552
534
  * this widget:
553
- * ...
554
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tab)
535
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tab)
555
536
  */
556
537
  tab? : boolean|TabConfig
557
538
  /**
@@ -559,14 +540,12 @@ export type BryntumTextAreaFieldProps = {
559
540
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
560
541
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
561
542
  * to the element programmatically.
562
- * ...
563
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tabIndex)
543
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tabIndex)
564
544
  */
565
545
  tabIndex? : number
566
546
  /**
567
547
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
568
- * ...
569
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-textAlign)
548
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-textAlign)
570
549
  */
571
550
  textAlign? : 'left'|'center'|'right'|'start'|'end'
572
551
  /**
@@ -575,24 +554,21 @@ export type BryntumTextAreaFieldProps = {
575
554
  title? : string
576
555
  /**
577
556
  * Tooltip for the widget, either as a string or as a Tooltip config object.
578
- * ...
579
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tooltip)
557
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-tooltip)
580
558
  */
581
559
  tooltip? : string|TooltipConfig|null
582
560
  /**
583
561
  * The triggers to add either before or after the input field. Each property name is the reference by which
584
562
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
585
- * ...
586
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-triggers)
563
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-triggers)
587
564
  */
588
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
565
+ triggers? : Record<string, FieldTriggerConfig>
589
566
  type? : 'textareafield'|'textarea'
590
567
  /**
591
568
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
592
569
  * as a space separated string, an array of strings, or as an object in which property names with truthy
593
570
  * values are used as the class names.
594
- * ...
595
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ui)
571
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-ui)
596
572
  */
597
573
  ui? : string|object
598
574
  /**
@@ -617,14 +593,12 @@ export type BryntumTextAreaFieldProps = {
617
593
  width? : string|number
618
594
  /**
619
595
  * The x position for the widget.
620
- * ...
621
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-x)
596
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-x)
622
597
  */
623
598
  x? : number
624
599
  /**
625
600
  * The y position for the widget.
626
- * ...
627
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-y)
601
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-y)
628
602
  */
629
603
  y? : number
630
604
 
@@ -654,7 +628,7 @@ export type BryntumTextAreaFieldProps = {
654
628
  * @param {object} event Event object
655
629
  * @param {Core.widget.Widget} event.source The widget being hidden.
656
630
  */
657
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
631
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
658
632
  /**
659
633
  * Triggered before a widget is shown. Return `false` to prevent the action.
660
634
  * @param {object} event Event object
@@ -663,8 +637,7 @@ export type BryntumTextAreaFieldProps = {
663
637
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
664
638
  /**
665
639
  * Fires when any other event is fired from the object.
666
- * ...
667
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-catchAll)
640
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-catchAll)
668
641
  * @param {object} event Event object
669
642
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
670
643
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -684,8 +657,7 @@ export type BryntumTextAreaFieldProps = {
684
657
  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
685
658
  /**
686
659
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
687
- * ...
688
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-clear)
660
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-clear)
689
661
  * @param {object} event Event object
690
662
  * @param {Core.widget.Field,any} event.source This Field
691
663
  */
@@ -743,8 +715,7 @@ export type BryntumTextAreaFieldProps = {
743
715
  /**
744
716
  * Triggered when a widget which had been in a non-visible state for any reason
745
717
  * achieves visibility.
746
- * ...
747
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-paint)
718
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#event-paint)
748
719
  * @param {object} event Event object
749
720
  * @param {Core.widget.Widget} event.source The widget being painted.
750
721
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -802,9 +773,11 @@ export class BryntumTextAreaField extends React.Component<BryntumTextAreaFieldPr
802
773
  'ariaDescription',
803
774
  'ariaLabel',
804
775
  'autoComplete',
776
+ 'autoHeight',
805
777
  'autoSelect',
806
778
  'bubbleEvents',
807
779
  'centered',
780
+ 'checkValidity',
808
781
  'clearable',
809
782
  'color',
810
783
  'config',
@@ -849,6 +822,7 @@ export class BryntumTextAreaField extends React.Component<BryntumTextAreaFieldPr
849
822
  'resize',
850
823
  'revertOnEscape',
851
824
  'ripple',
825
+ 'role',
852
826
  'rootElement',
853
827
  'scrollAction',
854
828
  'showAnimation',
@@ -926,9 +900,7 @@ export class BryntumTextAreaField extends React.Component<BryntumTextAreaFieldPr
926
900
  ];
927
901
 
928
902
  static propertyNames = [
929
- 'anchorSize',
930
903
  'content',
931
- 'focusVisible',
932
904
  'html',
933
905
  'input',
934
906
  'parent',