@bryntum/core-react-thin 7.2.4 → 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, DateField, DomConfig, DurationConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TimeField, TimeFieldListeners, TooltipConfig, VueConfig, Widget, WidgetConfig } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DateField, DomConfig, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TimeField, TimeFieldListeners, 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 BryntumTimeFieldProps = {
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/TimeField#config-adopt)
15
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#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/TimeField#config-align)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-align)
23
21
  */
24
22
  align? : AlignSpec|string
25
23
  /**
@@ -41,15 +39,13 @@ export type BryntumTimeFieldProps = {
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/TimeField#config-ariaDescription)
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#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/TimeField#config-ariaLabel)
48
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ariaLabel)
53
49
  */
54
50
  ariaLabel? : string
55
51
  /**
@@ -72,21 +68,18 @@ export type BryntumTimeFieldProps = {
72
68
  /**
73
69
  * An object where property names with a truthy value indicate which events should bubble up the ownership
74
70
  * hierarchy when triggered.
75
- * ...
76
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-bubbleEvents)
71
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-bubbleEvents)
77
72
  */
78
73
  bubbleEvents? : object
79
74
  /**
80
75
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
81
- * ...
82
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-callOnFunctions)
76
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-callOnFunctions)
83
77
  */
84
78
  callOnFunctions? : boolean
85
79
  /**
86
80
  * By default, if an event handler throws an exception, the error propagates up the stack and the
87
81
  * application state is undefined. Code which follows the event handler will *not* be executed.
88
- * ...
89
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-catchEventHandlerExceptions)
82
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-catchEventHandlerExceptions)
90
83
  */
91
84
  catchEventHandlerExceptions? : boolean
92
85
  /**
@@ -104,15 +97,13 @@ export type BryntumTimeFieldProps = {
104
97
  * Custom CSS classes to add to element.
105
98
  * May be specified as a space separated string, or as an object in which property names
106
99
  * with truthy values are used as the class names:
107
- * ...
108
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-cls)
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-cls)
109
101
  */
110
102
  cls? : string|object
111
103
  /**
112
104
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
113
105
  * `style` block.
114
- * ...
115
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-color)
106
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-color)
116
107
  */
117
108
  color? : Color
118
109
  /**
@@ -129,15 +120,13 @@ export type BryntumTimeFieldProps = {
129
120
  * The configuration for additional items associated to this field. This is typically used to add contextual
130
121
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
131
122
  * these classes for examples of nested fields.
132
- * ...
133
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-container)
123
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-container)
134
124
  */
135
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
125
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
136
126
  /**
137
127
  * The config controls how the value of nested items are handled when a parent container gets or sets its
138
128
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
139
- * ...
140
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-containValues)
129
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-containValues)
141
130
  * @param {Core.widget.Field} field Field instance
142
131
  * @returns {boolean}
143
132
  */
@@ -146,8 +135,7 @@ export type BryntumTimeFieldProps = {
146
135
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
147
136
  * May be specified as a space separated string, or as an object in which property names
148
137
  * with truthy values are used as the class names:
149
- * ...
150
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-contentElementCls)
138
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-contentElementCls)
151
139
  */
152
140
  contentElementCls? : string|object
153
141
  /**
@@ -165,16 +153,15 @@ export type BryntumTimeFieldProps = {
165
153
  */
166
154
  defaultBindProperty? : string
167
155
  /**
168
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
169
- * ...
170
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-detectCSSCompatibilityIssues)
156
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
157
+ * checks:
158
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-detectCSSCompatibilityIssues)
171
159
  */
172
160
  detectCSSCompatibilityIssues? : boolean
173
161
  /**
174
162
  * 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
175
163
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
176
- * ...
177
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-disabled)
164
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-disabled)
178
165
  */
179
166
  disabled? : boolean|'inert'
180
167
  /**
@@ -182,20 +169,17 @@ export type BryntumTimeFieldProps = {
182
169
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
183
170
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
184
171
  * body. Such widgets are called "edge strips".
185
- * ...
186
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-dock)
172
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-dock)
187
173
  */
188
174
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
189
175
  /**
190
176
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
191
177
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
192
178
  * property which controls when a drag should start.
193
- * ...
194
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-draggable)
179
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-draggable)
180
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
195
181
  */
196
- draggable? : boolean|{
197
- handleSelector?: string
198
- }
182
+ draggable? : boolean|object
199
183
  /**
200
184
  * User can edit text in text field (otherwise only pick from attached picker)
201
185
  */
@@ -203,8 +187,7 @@ export type BryntumTimeFieldProps = {
203
187
  /**
204
188
  * An object specifying attributes to assign to the root element of this widget.
205
189
  * Set `null` value to attribute to remove it.
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-elementAttributes)
190
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-elementAttributes)
208
191
  */
209
192
  elementAttributes? : Record<string, string|null>
210
193
  extraData? : any
@@ -238,8 +221,7 @@ export type BryntumTimeFieldProps = {
238
221
  hidden? : boolean
239
222
  /**
240
223
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
241
- * ...
242
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hideAnimation)
224
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hideAnimation)
243
225
  */
244
226
  hideAnimation? : boolean|object
245
227
  /**
@@ -249,8 +231,7 @@ export type BryntumTimeFieldProps = {
249
231
  /**
250
232
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
251
233
  * a field's units.
252
- * ...
253
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hint)
234
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hint)
254
235
  * @param {object} data A data object
255
236
  * @param {Core.widget.Field} data.source A reference to the field instance
256
237
  * @param {any} data.value The current value of the field
@@ -261,8 +242,7 @@ export type BryntumTimeFieldProps = {
261
242
  * 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.
262
243
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
263
244
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
264
- * ...
265
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hintHtml)
245
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hintHtml)
266
246
  * @param {object} data A data object
267
247
  * @param {Core.widget.Field} data.source A reference to the field instance
268
248
  * @param {any} data.value The current value of the field
@@ -275,16 +255,14 @@ export type BryntumTimeFieldProps = {
275
255
  id? : string
276
256
  /**
277
257
  * Determines if the widgets read-only state should be controlled by its parent.
278
- * ...
279
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ignoreParentReadOnly)
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ignoreParentReadOnly)
280
259
  */
281
260
  ignoreParentReadOnly? : boolean
282
261
  /**
283
262
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
284
263
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
285
264
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
286
- * ...
287
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-inline)
265
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-inline)
288
266
  */
289
267
  inline? : boolean
290
268
  /**
@@ -329,16 +307,14 @@ export type BryntumTimeFieldProps = {
329
307
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
330
308
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
331
309
  * are the name of the instance method to call when the keystroke is received.
332
- * ...
333
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyMap)
310
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyMap)
334
311
  */
335
312
  keyMap? : Record<string, KeyMapConfig>
336
313
  /**
337
314
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
338
315
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
339
316
  * immediate feedback, change will still be triggered on blur).
340
- * ...
341
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyStrokeChangeDelay)
317
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyStrokeChangeDelay)
342
318
  */
343
319
  keyStrokeChangeDelay? : number
344
320
  /**
@@ -351,15 +327,15 @@ export type BryntumTimeFieldProps = {
351
327
  labelCls? : string|object
352
328
  /**
353
329
  * Label position, either 'before' the field or 'above' the field
354
- * ...
355
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labelPosition)
330
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labelPosition)
356
331
  */
357
332
  labelPosition? : 'before'|'above'|null
358
333
  /**
359
334
  * The labels to add either before or after the input field.
360
335
  * Each label may have the following properties:
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labels)
336
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labels)
337
+ * @property {string} html Label text
338
+ * @property {'start','end'} align Which end of the file the label should go
363
339
  */
364
340
  labels? : object[]
365
341
  /**
@@ -368,16 +344,14 @@ export type BryntumTimeFieldProps = {
368
344
  labelWidth? : string|number
369
345
  /**
370
346
  * The listener set for this object.
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-listeners)
347
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-listeners)
373
348
  */
374
349
  listeners? : TimeFieldListeners
375
350
  /**
376
351
  * A class translations of which are used for translating this entity.
377
352
  * This is often used when translations of an item are defined on its container class.
378
353
  * For example:
379
- * ...
380
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localeClass)
354
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localeClass)
381
355
  */
382
356
  localeClass? : typeof Base
383
357
  /**
@@ -389,8 +363,7 @@ export type BryntumTimeFieldProps = {
389
363
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
390
364
  * you could use 'localeKey' meta configuration.
391
365
  * Example:
392
- * ...
393
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localizableProperties)
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localizableProperties)
394
367
  */
395
368
  localizableProperties? : string[]
396
369
  /**
@@ -420,8 +393,7 @@ export type BryntumTimeFieldProps = {
420
393
  maxHeight? : string|number
421
394
  /**
422
395
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
423
- * ...
424
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-maximizeOnMobile)
396
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-maximizeOnMobile)
425
397
  */
426
398
  maximizeOnMobile? : number|string
427
399
  /**
@@ -455,35 +427,30 @@ export type BryntumTimeFieldProps = {
455
427
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
456
428
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
457
429
  * layout.
458
- * ...
459
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-monitorResize)
430
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-monitorResize)
431
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
460
432
  */
461
- monitorResize? : boolean|{
462
- immediate?: boolean
463
- }
433
+ monitorResize? : boolean|object
464
434
  /**
465
435
  * Name of the field which is used as a key to get/set values from/to the field.
466
436
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
467
437
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
468
- * ...
469
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-name)
438
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-name)
470
439
  */
471
440
  name? : string
472
441
  /**
473
442
  * A reference to a partner DateField which this TimeField should sync its value with.
474
443
  * When the DateField's value is changed, this TimeField's value is updated to match.
475
444
  * When this TimeField's value is changed, the DateField's value is updated to match.
476
- * ...
477
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-partner)
445
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-partner)
478
446
  */
479
447
  partner? : string|DateField
480
448
  /**
481
449
  * Configuration object for the [picker](https://bryntum.com/products/core/docs/api/Core/widget/List) on initialization. Returns the
482
450
  * [picker](https://bryntum.com/products/core/docs/api/Core/widget/List) instance at runtime.
483
- * ...
484
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-picker)
451
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-picker)
485
452
  */
486
- picker? : object|Widget|WidgetConfig
453
+ picker? : object
487
454
  /**
488
455
  * The name of the element property to which the picker should size and align itself.
489
456
  */
@@ -496,8 +463,7 @@ export type BryntumTimeFieldProps = {
496
463
  * 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
497
464
  * not participate in the standard layout of that widget, and must be positioned relatively to that
498
465
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
499
- * ...
500
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-positioned)
466
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-positioned)
501
467
  */
502
468
  positioned? : boolean
503
469
  /**
@@ -508,15 +474,13 @@ export type BryntumTimeFieldProps = {
508
474
  /**
509
475
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
510
476
  * are unresponsive.
511
- * ...
512
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-readOnly)
477
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-readOnly)
513
478
  */
514
479
  readOnly? : boolean
515
480
  relayStoreEvents? : boolean
516
481
  /**
517
482
  * Predefined style to use for the field. Possible values are:
518
- * ...
519
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rendition)
483
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rendition)
520
484
  */
521
485
  rendition? : 'outlined'|'filled'|string
522
486
  /**
@@ -535,23 +499,26 @@ export type BryntumTimeFieldProps = {
535
499
  * Configure as `true` to have the component display a translucent ripple when its
536
500
  * [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
537
501
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
538
- * ...
539
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ripple)
540
- */
541
- ripple? : boolean|{
542
- delegate?: string
543
- color?: string
544
- radius?: number
545
- clip?: string
546
- }
502
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ripple)
503
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
504
+ * @property {string} [color] A CSS color name or specification.
505
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
506
+ * @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.
507
+ */
508
+ ripple? : boolean|object
509
+ /**
510
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
511
+ * accidentally applying a role which may interfere with screen readers.
512
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-role)
513
+ */
514
+ role? : string
547
515
  /**
548
516
  * 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`
549
517
  */
550
518
  rootElement? : ShadowRoot|HTMLElement
551
519
  /**
552
520
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
553
- * ...
554
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rtl)
521
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rtl)
555
522
  */
556
523
  rtl? : boolean
557
524
  /**
@@ -561,8 +528,7 @@ export type BryntumTimeFieldProps = {
561
528
  scrollAction? : 'hide'|'realign'|null
562
529
  /**
563
530
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
564
- * ...
565
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-showAnimation)
531
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-showAnimation)
566
532
  */
567
533
  showAnimation? : boolean|object
568
534
  /**
@@ -602,8 +568,7 @@ export type BryntumTimeFieldProps = {
602
568
  * 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
603
569
  * [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
604
570
  * this widget:
605
- * ...
606
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tab)
571
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tab)
607
572
  */
608
573
  tab? : boolean|TabConfig
609
574
  /**
@@ -611,14 +576,12 @@ export type BryntumTimeFieldProps = {
611
576
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
612
577
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
613
578
  * to the element programmatically.
614
- * ...
615
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tabIndex)
579
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tabIndex)
616
580
  */
617
581
  tabIndex? : number
618
582
  /**
619
583
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
620
- * ...
621
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-textAlign)
584
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-textAlign)
622
585
  */
623
586
  textAlign? : 'left'|'center'|'right'|'start'|'end'
624
587
  /**
@@ -627,22 +590,24 @@ export type BryntumTimeFieldProps = {
627
590
  title? : string
628
591
  /**
629
592
  * Tooltip for the widget, either as a string or as a Tooltip config object.
630
- * ...
631
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tooltip)
593
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tooltip)
632
594
  */
633
595
  tooltip? : string|TooltipConfig|null
634
596
  /**
635
597
  * Widgets that trigger functionality upon click. Each trigger icon is a [Widget](https://bryntum.com/products/core/docs/api/Core/widget/Widget) instance
636
598
  * which may be hidden, shown and observed and styled just like any other widget.
599
+ * @property {FieldTriggerConfig} triggers.expand Expands the picker to select a time
600
+ * @property {FieldTriggerConfig} triggers.back Subtracts the [step](https://bryntum.com/products/core/docs/api/Core/widget/TimeField#config-step) from the current time
601
+ * @property {FieldTriggerConfig} triggers.forward Adds the [step](https://bryntum.com/products/core/docs/api/Core/widget/TimeField#config-step) to the current time
602
+ * @property {FieldTriggerConfig} triggers.clear Clears the field value, only available if this field is [clearable](https://bryntum.com/products/core/docs/api/Core/widget/TimeField#config-clearable)
637
603
  */
638
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
604
+ triggers? : Record<string, FieldTriggerConfig>
639
605
  type? : 'timefield'|'time'
640
606
  /**
641
607
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
642
608
  * as a space separated string, an array of strings, or as an object in which property names with truthy
643
609
  * values are used as the class names.
644
- * ...
645
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ui)
610
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ui)
646
611
  */
647
612
  ui? : string|object
648
613
  /**
@@ -669,14 +634,12 @@ export type BryntumTimeFieldProps = {
669
634
  width? : string|number
670
635
  /**
671
636
  * The x position for the widget.
672
- * ...
673
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-x)
637
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-x)
674
638
  */
675
639
  x? : number
676
640
  /**
677
641
  * The y position for the widget.
678
- * ...
679
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-y)
642
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-y)
680
643
  */
681
644
  y? : number
682
645
 
@@ -715,8 +678,7 @@ export type BryntumTimeFieldProps = {
715
678
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
716
679
  /**
717
680
  * Fires when any other event is fired from the object.
718
- * ...
719
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-catchAll)
681
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-catchAll)
720
682
  * @param {object} event Event object
721
683
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
722
684
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -736,8 +698,7 @@ export type BryntumTimeFieldProps = {
736
698
  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
737
699
  /**
738
700
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
739
- * ...
740
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-clear)
701
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-clear)
741
702
  * @param {object} event Event object
742
703
  * @param {Core.widget.Field,any} event.source This Field
743
704
  */
@@ -795,8 +756,7 @@ export type BryntumTimeFieldProps = {
795
756
  /**
796
757
  * Triggered when a widget which had been in a non-visible state for any reason
797
758
  * achieves visibility.
798
- * ...
799
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-paint)
759
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-paint)
800
760
  * @param {object} event Event object
801
761
  * @param {Core.widget.Widget} event.source The widget being painted.
802
762
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -905,6 +865,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
905
865
  'relayStoreEvents',
906
866
  'revertOnEscape',
907
867
  'ripple',
868
+ 'role',
908
869
  'rootElement',
909
870
  'scrollAction',
910
871
  'showAnimation',
@@ -989,9 +950,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
989
950
  ];
990
951
 
991
952
  static propertyNames = [
992
- 'anchorSize',
993
953
  'content',
994
- 'focusVisible',
995
954
  'formula',
996
955
  'html',
997
956
  'input',