@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, 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
  /**
@@ -94,6 +87,15 @@ export type BryntumTimeFieldProps = {
94
87
  * Set to `true` to centre the Widget in browser viewport space.
95
88
  */
96
89
  centered? : boolean
90
+ /**
91
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
92
+ * 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)
93
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
94
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-checkValidity)
95
+ * @param {Core.widget.Field} field The field being validated
96
+ * @returns {void}
97
+ */
98
+ checkValidity? : ((field: Field) => void)|string
97
99
  /**
98
100
  * 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
99
101
  * 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
@@ -104,15 +106,13 @@ export type BryntumTimeFieldProps = {
104
106
  * Custom CSS classes to add to element.
105
107
  * May be specified as a space separated string, or as an object in which property names
106
108
  * 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)
109
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-cls)
109
110
  */
110
111
  cls? : string|object
111
112
  /**
112
113
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
113
114
  * `style` block.
114
- * ...
115
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-color)
115
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-color)
116
116
  */
117
117
  color? : Color
118
118
  /**
@@ -129,15 +129,13 @@ export type BryntumTimeFieldProps = {
129
129
  * The configuration for additional items associated to this field. This is typically used to add contextual
130
130
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
131
131
  * these classes for examples of nested fields.
132
- * ...
133
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-container)
132
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-container)
134
133
  */
135
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
134
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
136
135
  /**
137
136
  * The config controls how the value of nested items are handled when a parent container gets or sets its
138
137
  * [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)
138
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-containValues)
141
139
  * @param {Core.widget.Field} field Field instance
142
140
  * @returns {boolean}
143
141
  */
@@ -146,8 +144,7 @@ export type BryntumTimeFieldProps = {
146
144
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
147
145
  * May be specified as a space separated string, or as an object in which property names
148
146
  * 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)
147
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-contentElementCls)
151
148
  */
152
149
  contentElementCls? : string|object
153
150
  /**
@@ -165,16 +162,15 @@ export type BryntumTimeFieldProps = {
165
162
  */
166
163
  defaultBindProperty? : string
167
164
  /**
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)
165
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
166
+ * checks:
167
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-detectCSSCompatibilityIssues)
171
168
  */
172
169
  detectCSSCompatibilityIssues? : boolean
173
170
  /**
174
171
  * 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
172
  * 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)
173
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-disabled)
178
174
  */
179
175
  disabled? : boolean|'inert'
180
176
  /**
@@ -182,20 +178,17 @@ export type BryntumTimeFieldProps = {
182
178
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
183
179
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
184
180
  * body. Such widgets are called "edge strips".
185
- * ...
186
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-dock)
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-dock)
187
182
  */
188
183
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
189
184
  /**
190
185
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
191
186
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
192
187
  * 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)
188
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-draggable)
189
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
195
190
  */
196
- draggable? : boolean|{
197
- handleSelector?: string
198
- }
191
+ draggable? : boolean|object
199
192
  /**
200
193
  * User can edit text in text field (otherwise only pick from attached picker)
201
194
  */
@@ -203,8 +196,7 @@ export type BryntumTimeFieldProps = {
203
196
  /**
204
197
  * An object specifying attributes to assign to the root element of this widget.
205
198
  * 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)
199
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-elementAttributes)
208
200
  */
209
201
  elementAttributes? : Record<string, string|null>
210
202
  extraData? : any
@@ -238,8 +230,7 @@ export type BryntumTimeFieldProps = {
238
230
  hidden? : boolean
239
231
  /**
240
232
  * *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)
233
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hideAnimation)
243
234
  */
244
235
  hideAnimation? : boolean|object
245
236
  /**
@@ -249,8 +240,7 @@ export type BryntumTimeFieldProps = {
249
240
  /**
250
241
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
251
242
  * a field's units.
252
- * ...
253
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hint)
243
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hint)
254
244
  * @param {object} data A data object
255
245
  * @param {Core.widget.Field} data.source A reference to the field instance
256
246
  * @param {any} data.value The current value of the field
@@ -261,8 +251,7 @@ export type BryntumTimeFieldProps = {
261
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.
262
252
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
263
253
  * 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)
254
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-hintHtml)
266
255
  * @param {object} data A data object
267
256
  * @param {Core.widget.Field} data.source A reference to the field instance
268
257
  * @param {any} data.value The current value of the field
@@ -275,16 +264,14 @@ export type BryntumTimeFieldProps = {
275
264
  id? : string
276
265
  /**
277
266
  * 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)
267
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ignoreParentReadOnly)
280
268
  */
281
269
  ignoreParentReadOnly? : boolean
282
270
  /**
283
271
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
284
272
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
285
273
  * [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)
274
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-inline)
288
275
  */
289
276
  inline? : boolean
290
277
  /**
@@ -329,16 +316,14 @@ export type BryntumTimeFieldProps = {
329
316
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
330
317
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
331
318
  * 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)
319
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyMap)
334
320
  */
335
321
  keyMap? : Record<string, KeyMapConfig>
336
322
  /**
337
323
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
338
324
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
339
325
  * 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)
326
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-keyStrokeChangeDelay)
342
327
  */
343
328
  keyStrokeChangeDelay? : number
344
329
  /**
@@ -351,15 +336,15 @@ export type BryntumTimeFieldProps = {
351
336
  labelCls? : string|object
352
337
  /**
353
338
  * 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)
339
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labelPosition)
356
340
  */
357
341
  labelPosition? : 'before'|'above'|null
358
342
  /**
359
343
  * The labels to add either before or after the input field.
360
344
  * Each label may have the following properties:
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labels)
345
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-labels)
346
+ * @property {string} html Label text
347
+ * @property {'start','end'} align Which end of the file the label should go
363
348
  */
364
349
  labels? : object[]
365
350
  /**
@@ -368,16 +353,14 @@ export type BryntumTimeFieldProps = {
368
353
  labelWidth? : string|number
369
354
  /**
370
355
  * The listener set for this object.
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-listeners)
356
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-listeners)
373
357
  */
374
358
  listeners? : TimeFieldListeners
375
359
  /**
376
360
  * A class translations of which are used for translating this entity.
377
361
  * This is often used when translations of an item are defined on its container class.
378
362
  * For example:
379
- * ...
380
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localeClass)
363
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localeClass)
381
364
  */
382
365
  localeClass? : typeof Base
383
366
  /**
@@ -389,8 +372,7 @@ export type BryntumTimeFieldProps = {
389
372
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
390
373
  * you could use 'localeKey' meta configuration.
391
374
  * Example:
392
- * ...
393
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localizableProperties)
375
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-localizableProperties)
394
376
  */
395
377
  localizableProperties? : string[]
396
378
  /**
@@ -420,8 +402,7 @@ export type BryntumTimeFieldProps = {
420
402
  maxHeight? : string|number
421
403
  /**
422
404
  * *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)
405
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-maximizeOnMobile)
425
406
  */
426
407
  maximizeOnMobile? : number|string
427
408
  /**
@@ -455,35 +436,30 @@ export type BryntumTimeFieldProps = {
455
436
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
456
437
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
457
438
  * layout.
458
- * ...
459
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-monitorResize)
439
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-monitorResize)
440
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
460
441
  */
461
- monitorResize? : boolean|{
462
- immediate?: boolean
463
- }
442
+ monitorResize? : boolean|object
464
443
  /**
465
444
  * Name of the field which is used as a key to get/set values from/to the field.
466
445
  * 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
446
  * [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)
447
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-name)
470
448
  */
471
449
  name? : string
472
450
  /**
473
451
  * A reference to a partner DateField which this TimeField should sync its value with.
474
452
  * When the DateField's value is changed, this TimeField's value is updated to match.
475
453
  * 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)
454
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-partner)
478
455
  */
479
456
  partner? : string|DateField
480
457
  /**
481
458
  * Configuration object for the [picker](https://bryntum.com/products/core/docs/api/Core/widget/List) on initialization. Returns the
482
459
  * [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)
460
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-picker)
485
461
  */
486
- picker? : object|Widget|WidgetConfig
462
+ picker? : object
487
463
  /**
488
464
  * The name of the element property to which the picker should size and align itself.
489
465
  */
@@ -496,8 +472,7 @@ export type BryntumTimeFieldProps = {
496
472
  * 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
473
  * not participate in the standard layout of that widget, and must be positioned relatively to that
498
474
  * 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)
475
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-positioned)
501
476
  */
502
477
  positioned? : boolean
503
478
  /**
@@ -508,15 +483,13 @@ export type BryntumTimeFieldProps = {
508
483
  /**
509
484
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
510
485
  * are unresponsive.
511
- * ...
512
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-readOnly)
486
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-readOnly)
513
487
  */
514
488
  readOnly? : boolean
515
489
  relayStoreEvents? : boolean
516
490
  /**
517
491
  * 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)
492
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rendition)
520
493
  */
521
494
  rendition? : 'outlined'|'filled'|string
522
495
  /**
@@ -535,23 +508,26 @@ export type BryntumTimeFieldProps = {
535
508
  * Configure as `true` to have the component display a translucent ripple when its
536
509
  * [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
510
  * 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
- }
511
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ripple)
512
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
513
+ * @property {string} [color] A CSS color name or specification.
514
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
515
+ * @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.
516
+ */
517
+ ripple? : boolean|object
518
+ /**
519
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
520
+ * accidentally applying a role which may interfere with screen readers.
521
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-role)
522
+ */
523
+ role? : string
547
524
  /**
548
525
  * 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
526
  */
550
527
  rootElement? : ShadowRoot|HTMLElement
551
528
  /**
552
529
  * 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)
530
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-rtl)
555
531
  */
556
532
  rtl? : boolean
557
533
  /**
@@ -561,8 +537,7 @@ export type BryntumTimeFieldProps = {
561
537
  scrollAction? : 'hide'|'realign'|null
562
538
  /**
563
539
  * *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)
540
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-showAnimation)
566
541
  */
567
542
  showAnimation? : boolean|object
568
543
  /**
@@ -602,8 +577,7 @@ export type BryntumTimeFieldProps = {
602
577
  * 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
578
  * [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
579
  * this widget:
605
- * ...
606
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tab)
580
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tab)
607
581
  */
608
582
  tab? : boolean|TabConfig
609
583
  /**
@@ -611,14 +585,12 @@ export type BryntumTimeFieldProps = {
611
585
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
612
586
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
613
587
  * to the element programmatically.
614
- * ...
615
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tabIndex)
588
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tabIndex)
616
589
  */
617
590
  tabIndex? : number
618
591
  /**
619
592
  * 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)
593
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-textAlign)
622
594
  */
623
595
  textAlign? : 'left'|'center'|'right'|'start'|'end'
624
596
  /**
@@ -627,22 +599,24 @@ export type BryntumTimeFieldProps = {
627
599
  title? : string
628
600
  /**
629
601
  * 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)
602
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-tooltip)
632
603
  */
633
604
  tooltip? : string|TooltipConfig|null
634
605
  /**
635
606
  * Widgets that trigger functionality upon click. Each trigger icon is a [Widget](https://bryntum.com/products/core/docs/api/Core/widget/Widget) instance
636
607
  * which may be hidden, shown and observed and styled just like any other widget.
608
+ * @property {FieldTriggerConfig} triggers.expand Expands the picker to select a time
609
+ * @property {FieldTriggerConfig} triggers.back Subtracts the [step](https://bryntum.com/products/core/docs/api/Core/widget/TimeField#config-step) from the current time
610
+ * @property {FieldTriggerConfig} triggers.forward Adds the [step](https://bryntum.com/products/core/docs/api/Core/widget/TimeField#config-step) to the current time
611
+ * @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
612
  */
638
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
613
+ triggers? : Record<string, FieldTriggerConfig>
639
614
  type? : 'timefield'|'time'
640
615
  /**
641
616
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
642
617
  * as a space separated string, an array of strings, or as an object in which property names with truthy
643
618
  * values are used as the class names.
644
- * ...
645
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ui)
619
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-ui)
646
620
  */
647
621
  ui? : string|object
648
622
  /**
@@ -669,14 +643,12 @@ export type BryntumTimeFieldProps = {
669
643
  width? : string|number
670
644
  /**
671
645
  * The x position for the widget.
672
- * ...
673
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-x)
646
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-x)
674
647
  */
675
648
  x? : number
676
649
  /**
677
650
  * The y position for the widget.
678
- * ...
679
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-y)
651
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-y)
680
652
  */
681
653
  y? : number
682
654
 
@@ -706,7 +678,7 @@ export type BryntumTimeFieldProps = {
706
678
  * @param {object} event Event object
707
679
  * @param {Core.widget.Widget} event.source The widget being hidden.
708
680
  */
709
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
681
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
710
682
  /**
711
683
  * Triggered before a widget is shown. Return `false` to prevent the action.
712
684
  * @param {object} event Event object
@@ -715,8 +687,7 @@ export type BryntumTimeFieldProps = {
715
687
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
716
688
  /**
717
689
  * 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)
690
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-catchAll)
720
691
  * @param {object} event Event object
721
692
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
722
693
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -736,8 +707,7 @@ export type BryntumTimeFieldProps = {
736
707
  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
708
  /**
738
709
  * 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)
710
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-clear)
741
711
  * @param {object} event Event object
742
712
  * @param {Core.widget.Field,any} event.source This Field
743
713
  */
@@ -795,8 +765,7 @@ export type BryntumTimeFieldProps = {
795
765
  /**
796
766
  * Triggered when a widget which had been in a non-visible state for any reason
797
767
  * achieves visibility.
798
- * ...
799
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-paint)
768
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#event-paint)
800
769
  * @param {object} event Event object
801
770
  * @param {Core.widget.Widget} event.source The widget being painted.
802
771
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -858,6 +827,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
858
827
  'autoSelect',
859
828
  'bubbleEvents',
860
829
  'centered',
830
+ 'checkValidity',
861
831
  'clearable',
862
832
  'color',
863
833
  'config',
@@ -905,6 +875,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
905
875
  'relayStoreEvents',
906
876
  'revertOnEscape',
907
877
  'ripple',
878
+ 'role',
908
879
  'rootElement',
909
880
  'scrollAction',
910
881
  'showAnimation',
@@ -989,9 +960,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
989
960
  ];
990
961
 
991
962
  static propertyNames = [
992
- 'anchorSize',
993
963
  'content',
994
- 'focusVisible',
995
964
  'formula',
996
965
  'html',
997
966
  'input',