@bryntum/core-react-thin 7.2.3 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +261 -0
  2. package/lib/BryntumBooleanCombo.js +204 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +6 -14
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +8 -15
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +16 -20
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +7 -15
  14. package/lib/BryntumCheckbox.js +1 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +9 -21
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +6 -14
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +9 -20
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +7 -15
  26. package/lib/BryntumColorField.js +1 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +10 -18
  29. package/lib/BryntumCombo.js +1 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +7 -14
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +7 -15
  35. package/lib/BryntumDateField.js +1 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +9 -20
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +10 -18
  41. package/lib/BryntumDateRangeField.js +1 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +7 -15
  44. package/lib/BryntumDateTimeField.js +1 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +9 -20
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +7 -15
  50. package/lib/BryntumDisplayField.js +1 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +7 -15
  53. package/lib/BryntumDurationField.js +1 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +9 -19
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +7 -14
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +7 -14
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +9 -21
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +7 -15
  68. package/lib/BryntumFileField.js +1 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +7 -14
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +7 -15
  74. package/lib/BryntumFilterField.js +1 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +21 -30
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +6 -14
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +6 -14
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +20 -25
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +9 -20
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +7 -15
  92. package/lib/BryntumNumberField.js +1 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +10 -17
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +9 -20
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +7 -15
  101. package/lib/BryntumPasswordField.js +1 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +6 -14
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +7 -15
  107. package/lib/BryntumRadio.js +1 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +9 -21
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +7 -15
  113. package/lib/BryntumSlideToggle.js +1 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +7 -14
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +6 -14
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +9 -20
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +8 -15
  125. package/lib/BryntumTextAreaField.js +2 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +8 -16
  128. package/lib/BryntumTextAreaPickerField.js +1 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +7 -15
  131. package/lib/BryntumTextField.js +1 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +8 -16
  134. package/lib/BryntumTimeField.js +1 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +7 -14
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +10 -17
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +6 -14
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +9 -20
  146. package/lib/BryntumYearPicker.js +2 -5
  147. package/lib/BryntumYearPicker.js.map +1 -1
  148. package/lib/WrapperHelper.js +2 -2
  149. package/lib/WrapperHelper.js.map +1 -1
  150. package/lib/index.d.ts +1 -0
  151. package/lib/index.js +1 -0
  152. package/lib/index.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/BryntumBooleanCombo.tsx +1180 -0
  155. package/src/BryntumButton.tsx +69 -115
  156. package/src/BryntumButtonGroup.tsx +78 -123
  157. package/src/BryntumChatPanel.tsx +139 -169
  158. package/src/BryntumCheckbox.tsx +73 -117
  159. package/src/BryntumCheckboxGroup.tsx +109 -179
  160. package/src/BryntumChipView.tsx +65 -105
  161. package/src/BryntumCodeEditor.tsx +106 -167
  162. package/src/BryntumColorField.tsx +73 -117
  163. package/src/BryntumCombo.tsx +92 -152
  164. package/src/BryntumContainer.tsx +78 -124
  165. package/src/BryntumDateField.tsx +80 -123
  166. package/src/BryntumDatePicker.tsx +119 -193
  167. package/src/BryntumDateRangeField.tsx +79 -126
  168. package/src/BryntumDateTimeField.tsx +73 -117
  169. package/src/BryntumDemoCodeEditor.tsx +106 -167
  170. package/src/BryntumDisplayField.tsx +74 -119
  171. package/src/BryntumDurationField.tsx +80 -125
  172. package/src/BryntumEditor.tsx +90 -140
  173. package/src/BryntumFieldFilterPicker.tsx +80 -128
  174. package/src/BryntumFieldFilterPickerGroup.tsx +82 -132
  175. package/src/BryntumFieldSet.tsx +105 -172
  176. package/src/BryntumFileField.tsx +73 -117
  177. package/src/BryntumFilePicker.tsx +78 -124
  178. package/src/BryntumFilterField.tsx +76 -123
  179. package/src/BryntumHint.tsx +133 -190
  180. package/src/BryntumLabel.tsx +59 -95
  181. package/src/BryntumList.tsx +62 -101
  182. package/src/BryntumMenu.tsx +128 -188
  183. package/src/BryntumMonthPicker.tsx +106 -167
  184. package/src/BryntumNumberField.tsx +77 -121
  185. package/src/BryntumPagingToolbar.tsx +82 -129
  186. package/src/BryntumPanel.tsx +106 -167
  187. package/src/BryntumPasswordField.tsx +73 -117
  188. package/src/BryntumProgressBar.tsx +58 -93
  189. package/src/BryntumRadio.tsx +73 -117
  190. package/src/BryntumRadioGroup.tsx +109 -178
  191. package/src/BryntumSlideToggle.tsx +73 -117
  192. package/src/BryntumSlider.tsx +67 -101
  193. package/src/BryntumSplitter.tsx +61 -99
  194. package/src/BryntumTabPanel.tsx +107 -169
  195. package/src/BryntumTextAreaField.tsx +81 -119
  196. package/src/BryntumTextAreaPickerField.tsx +75 -120
  197. package/src/BryntumTextField.tsx +74 -119
  198. package/src/BryntumTimeField.tsx +79 -120
  199. package/src/BryntumTimePicker.tsx +78 -124
  200. package/src/BryntumToolbar.tsx +82 -129
  201. package/src/BryntumWidget.tsx +59 -95
  202. package/src/BryntumYearPicker.tsx +107 -169
  203. package/src/WrapperHelper.tsx +2 -2
  204. package/src/index.ts +1 -0
@@ -3,7 +3,7 @@
3
3
  */
4
4
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
5
  import React, { RefObject } from 'react';
6
- import { AlignSpec, Base, Color, CoreContainerItemConfig, DisplayField, DisplayFieldListeners, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DisplayField, DisplayFieldListeners, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, 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 BryntumDisplayFieldProps = {
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/DisplayField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#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/DisplayField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumDisplayFieldProps = {
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/DisplayField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#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/DisplayField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -68,21 +64,18 @@ export type BryntumDisplayFieldProps = {
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/DisplayField#config-bubbleEvents)
67
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#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/DisplayField#config-callOnFunctions)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#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/DisplayField#config-catchEventHandlerExceptions)
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-catchEventHandlerExceptions)
86
79
  */
87
80
  catchEventHandlerExceptions? : boolean
88
81
  /**
@@ -100,15 +93,13 @@ export type BryntumDisplayFieldProps = {
100
93
  * Custom CSS classes to add to element.
101
94
  * May be specified as a space separated string, or as an object in which property names
102
95
  * with truthy values are used as the class names:
103
- * ...
104
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-cls)
96
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-cls)
105
97
  */
106
98
  cls? : string|object
107
99
  /**
108
100
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
109
101
  * `style` block.
110
- * ...
111
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-color)
102
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-color)
112
103
  */
113
104
  color? : Color
114
105
  /**
@@ -125,15 +116,13 @@ export type BryntumDisplayFieldProps = {
125
116
  * The configuration for additional items associated to this field. This is typically used to add contextual
126
117
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
127
118
  * these classes for examples of nested fields.
128
- * ...
129
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-container)
119
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-container)
130
120
  */
131
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
121
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
132
122
  /**
133
123
  * The config controls how the value of nested items are handled when a parent container gets or sets its
134
124
  * [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/DisplayField#config-containValues)
125
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-containValues)
137
126
  * @param {Core.widget.Field} field Field instance
138
127
  * @returns {boolean}
139
128
  */
@@ -142,8 +131,7 @@ export type BryntumDisplayFieldProps = {
142
131
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
143
132
  * May be specified as a space separated string, or as an object in which property names
144
133
  * with truthy values are used as the class names:
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-contentElementCls)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-contentElementCls)
147
135
  */
148
136
  contentElementCls? : string|object
149
137
  /**
@@ -161,16 +149,15 @@ export type BryntumDisplayFieldProps = {
161
149
  */
162
150
  defaultBindProperty? : string
163
151
  /**
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/DisplayField#config-detectCSSCompatibilityIssues)
152
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
153
+ * checks:
154
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-detectCSSCompatibilityIssues)
167
155
  */
168
156
  detectCSSCompatibilityIssues? : boolean
169
157
  /**
170
158
  * 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
159
  * 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/DisplayField#config-disabled)
160
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-disabled)
174
161
  */
175
162
  disabled? : boolean|'inert'
176
163
  /**
@@ -178,33 +165,28 @@ export type BryntumDisplayFieldProps = {
178
165
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
179
166
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
180
167
  * body. Such widgets are called "edge strips".
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-dock)
168
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-dock)
183
169
  */
184
170
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
185
171
  /**
186
172
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
187
173
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
188
174
  * property which controls when a drag should start.
189
- * ...
190
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-draggable)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-draggable)
176
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
191
177
  */
192
- draggable? : boolean|{
193
- handleSelector?: string
194
- }
178
+ draggable? : boolean|object
195
179
  /**
196
180
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
197
181
  * [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
182
  * but not to type one in the field.
199
- * ...
200
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-editable)
183
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-editable)
201
184
  */
202
185
  editable? : boolean
203
186
  /**
204
187
  * An object specifying attributes to assign to the root element of this widget.
205
188
  * Set `null` value to attribute to remove it.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-elementAttributes)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-elementAttributes)
208
190
  */
209
191
  elementAttributes? : Record<string, string|null>
210
192
  extraData? : any
@@ -233,8 +215,7 @@ export type BryntumDisplayFieldProps = {
233
215
  hidden? : boolean
234
216
  /**
235
217
  * *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/DisplayField#config-hideAnimation)
218
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-hideAnimation)
238
219
  */
239
220
  hideAnimation? : boolean|object
240
221
  /**
@@ -244,8 +225,7 @@ export type BryntumDisplayFieldProps = {
244
225
  /**
245
226
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
246
227
  * a field's units.
247
- * ...
248
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-hint)
228
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-hint)
249
229
  * @param {object} data A data object
250
230
  * @param {Core.widget.Field} data.source A reference to the field instance
251
231
  * @param {any} data.value The current value of the field
@@ -256,8 +236,7 @@ export type BryntumDisplayFieldProps = {
256
236
  * 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
237
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
258
238
  * 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/DisplayField#config-hintHtml)
239
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-hintHtml)
261
240
  * @param {object} data A data object
262
241
  * @param {Core.widget.Field} data.source A reference to the field instance
263
242
  * @param {any} data.value The current value of the field
@@ -270,16 +249,14 @@ export type BryntumDisplayFieldProps = {
270
249
  id? : string
271
250
  /**
272
251
  * 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/DisplayField#config-ignoreParentReadOnly)
252
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ignoreParentReadOnly)
275
253
  */
276
254
  ignoreParentReadOnly? : boolean
277
255
  /**
278
256
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
279
257
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
280
258
  * [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/DisplayField#config-inline)
259
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-inline)
283
260
  */
284
261
  inline? : boolean
285
262
  /**
@@ -319,16 +296,14 @@ export type BryntumDisplayFieldProps = {
319
296
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
320
297
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
321
298
  * 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/DisplayField#config-keyMap)
299
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-keyMap)
324
300
  */
325
301
  keyMap? : Record<string, KeyMapConfig>
326
302
  /**
327
303
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
328
304
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
329
305
  * immediate feedback, change will still be triggered on blur).
330
- * ...
331
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-keyStrokeChangeDelay)
306
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-keyStrokeChangeDelay)
332
307
  */
333
308
  keyStrokeChangeDelay? : number
334
309
  /**
@@ -341,15 +316,15 @@ export type BryntumDisplayFieldProps = {
341
316
  labelCls? : string|object
342
317
  /**
343
318
  * Label position, either 'before' the field or 'above' the field
344
- * ...
345
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-labelPosition)
319
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-labelPosition)
346
320
  */
347
321
  labelPosition? : 'before'|'above'|null
348
322
  /**
349
323
  * The labels to add either before or after the input field.
350
324
  * Each label may have the following properties:
351
- * ...
352
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-labels)
325
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-labels)
326
+ * @property {string} html Label text
327
+ * @property {'start','end'} align Which end of the file the label should go
353
328
  */
354
329
  labels? : object[]
355
330
  /**
@@ -358,16 +333,14 @@ export type BryntumDisplayFieldProps = {
358
333
  labelWidth? : string|number
359
334
  /**
360
335
  * The listener set for this object.
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-listeners)
336
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-listeners)
363
337
  */
364
338
  listeners? : DisplayFieldListeners
365
339
  /**
366
340
  * A class translations of which are used for translating this entity.
367
341
  * This is often used when translations of an item are defined on its container class.
368
342
  * For example:
369
- * ...
370
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-localeClass)
343
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-localeClass)
371
344
  */
372
345
  localeClass? : typeof Base
373
346
  /**
@@ -379,8 +352,7 @@ export type BryntumDisplayFieldProps = {
379
352
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
380
353
  * you could use 'localeKey' meta configuration.
381
354
  * Example:
382
- * ...
383
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-localizableProperties)
355
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-localizableProperties)
384
356
  */
385
357
  localizableProperties? : string[]
386
358
  /**
@@ -406,8 +378,7 @@ export type BryntumDisplayFieldProps = {
406
378
  maxHeight? : string|number
407
379
  /**
408
380
  * *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/DisplayField#config-maximizeOnMobile)
381
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-maximizeOnMobile)
411
382
  */
412
383
  maximizeOnMobile? : number|string
413
384
  /**
@@ -429,18 +400,15 @@ export type BryntumDisplayFieldProps = {
429
400
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
430
401
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
431
402
  * layout.
432
- * ...
433
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-monitorResize)
403
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-monitorResize)
404
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
434
405
  */
435
- monitorResize? : boolean|{
436
- immediate?: boolean
437
- }
406
+ monitorResize? : boolean|object
438
407
  /**
439
408
  * Name of the field which is used as a key to get/set values from/to the field.
440
409
  * 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
410
  * [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/DisplayField#config-name)
411
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-name)
444
412
  */
445
413
  name? : string
446
414
  /**
@@ -451,8 +419,7 @@ export type BryntumDisplayFieldProps = {
451
419
  * 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
420
  * not participate in the standard layout of that widget, and must be positioned relatively to that
453
421
  * 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/DisplayField#config-positioned)
422
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-positioned)
456
423
  */
457
424
  positioned? : boolean
458
425
  /**
@@ -463,8 +430,7 @@ export type BryntumDisplayFieldProps = {
463
430
  /**
464
431
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
465
432
  * are unresponsive.
466
- * ...
467
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-readOnly)
433
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-readOnly)
468
434
  */
469
435
  readOnly? : boolean
470
436
  relayStoreEvents? : boolean
@@ -484,23 +450,26 @@ export type BryntumDisplayFieldProps = {
484
450
  * Configure as `true` to have the component display a translucent ripple when its
485
451
  * [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
486
452
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
487
- * ...
488
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ripple)
489
- */
490
- ripple? : boolean|{
491
- delegate?: string
492
- color?: string
493
- radius?: number
494
- clip?: string
495
- }
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ripple)
454
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
455
+ * @property {string} [color] A CSS color name or specification.
456
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
457
+ * @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.
458
+ */
459
+ ripple? : boolean|object
460
+ /**
461
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
462
+ * accidentally applying a role which may interfere with screen readers.
463
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-role)
464
+ */
465
+ role? : string
496
466
  /**
497
467
  * 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`
498
468
  */
499
469
  rootElement? : ShadowRoot|HTMLElement
500
470
  /**
501
471
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
502
- * ...
503
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-rtl)
472
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-rtl)
504
473
  */
505
474
  rtl? : boolean
506
475
  /**
@@ -510,8 +479,7 @@ export type BryntumDisplayFieldProps = {
510
479
  scrollAction? : 'hide'|'realign'|null
511
480
  /**
512
481
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
513
- * ...
514
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-showAnimation)
482
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-showAnimation)
515
483
  */
516
484
  showAnimation? : boolean|object
517
485
  /**
@@ -540,8 +508,7 @@ export type BryntumDisplayFieldProps = {
540
508
  * 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
541
509
  * [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
542
510
  * this widget:
543
- * ...
544
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tab)
511
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tab)
545
512
  */
546
513
  tab? : boolean|TabConfig
547
514
  /**
@@ -549,23 +516,20 @@ export type BryntumDisplayFieldProps = {
549
516
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
550
517
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
551
518
  * to the element programmatically.
552
- * ...
553
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tabIndex)
519
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tabIndex)
554
520
  */
555
521
  tabIndex? : number
556
522
  /**
557
523
  * A template string used to render the value of this field. Please note you are responsible for encoding
558
524
  * any strings protecting against XSS.
559
- * ...
560
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-template)
525
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-template)
561
526
  * @param {CoreContainerItemConfig} fieldConfig Configuration object for the field
562
527
  * @returns {DomConfig,string,void}
563
528
  */
564
529
  template? : (fieldConfig: CoreContainerItemConfig) => DomConfig|string|void
565
530
  /**
566
531
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
567
- * ...
568
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-textAlign)
532
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-textAlign)
569
533
  */
570
534
  textAlign? : 'left'|'center'|'right'|'start'|'end'
571
535
  /**
@@ -574,24 +538,21 @@ export type BryntumDisplayFieldProps = {
574
538
  title? : string
575
539
  /**
576
540
  * Tooltip for the widget, either as a string or as a Tooltip config object.
577
- * ...
578
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tooltip)
541
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-tooltip)
579
542
  */
580
543
  tooltip? : string|TooltipConfig|null
581
544
  /**
582
545
  * The triggers to add either before or after the input field. Each property name is the reference by which
583
546
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
584
- * ...
585
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-triggers)
547
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-triggers)
586
548
  */
587
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
549
+ triggers? : Record<string, FieldTriggerConfig>
588
550
  type? : 'displayField'|'displayfield'|'display'
589
551
  /**
590
552
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
591
553
  * as a space separated string, an array of strings, or as an object in which property names with truthy
592
554
  * values are used as the class names.
593
- * ...
594
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ui)
555
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-ui)
595
556
  */
596
557
  ui? : string|object
597
558
  /**
@@ -616,14 +577,12 @@ export type BryntumDisplayFieldProps = {
616
577
  width? : string|number
617
578
  /**
618
579
  * The x position for the widget.
619
- * ...
620
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-x)
580
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-x)
621
581
  */
622
582
  x? : number
623
583
  /**
624
584
  * The y position for the widget.
625
- * ...
626
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-y)
585
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-y)
627
586
  */
628
587
  y? : number
629
588
 
@@ -662,8 +621,7 @@ export type BryntumDisplayFieldProps = {
662
621
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
663
622
  /**
664
623
  * Fires when any other event is fired from the object.
665
- * ...
666
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-catchAll)
624
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-catchAll)
667
625
  * @param {object} event Event object
668
626
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
669
627
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -683,8 +641,7 @@ export type BryntumDisplayFieldProps = {
683
641
  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
684
642
  /**
685
643
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
686
- * ...
687
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-clear)
644
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-clear)
688
645
  * @param {object} event Event object
689
646
  * @param {Core.widget.Field,any} event.source This Field
690
647
  */
@@ -742,8 +699,7 @@ export type BryntumDisplayFieldProps = {
742
699
  /**
743
700
  * Triggered when a widget which had been in a non-visible state for any reason
744
701
  * achieves visibility.
745
- * ...
746
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-paint)
702
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#event-paint)
747
703
  * @param {object} event Event object
748
704
  * @param {Core.widget.Widget} event.source The widget being painted.
749
705
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -847,6 +803,7 @@ export class BryntumDisplayField extends React.Component<BryntumDisplayFieldProp
847
803
  'relayStoreEvents',
848
804
  'revertOnEscape',
849
805
  'ripple',
806
+ 'role',
850
807
  'rootElement',
851
808
  'scrollAction',
852
809
  'showAnimation',
@@ -924,9 +881,7 @@ export class BryntumDisplayField extends React.Component<BryntumDisplayFieldProp
924
881
  ];
925
882
 
926
883
  static propertyNames = [
927
- 'anchorSize',
928
884
  'content',
929
- 'focusVisible',
930
885
  'html',
931
886
  'input',
932
887
  'parent',