@bryntum/core-react-thin 7.3.0 → 7.3.2

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 (167) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +2 -1
  2. package/lib/BryntumBooleanCombo.js +1 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -1
  4. package/lib/BryntumButton.d.ts +3 -3
  5. package/lib/BryntumButton.js.map +1 -1
  6. package/lib/BryntumButtonGroup.d.ts +1 -1
  7. package/lib/BryntumButtonGroup.js.map +1 -1
  8. package/lib/BryntumChatPanel.d.ts +3 -3
  9. package/lib/BryntumChatPanel.js.map +1 -1
  10. package/lib/BryntumCheckbox.d.ts +3 -2
  11. package/lib/BryntumCheckbox.js +1 -0
  12. package/lib/BryntumCheckbox.js.map +1 -1
  13. package/lib/BryntumCheckboxGroup.d.ts +3 -3
  14. package/lib/BryntumCheckboxGroup.js.map +1 -1
  15. package/lib/BryntumChipView.d.ts +3 -3
  16. package/lib/BryntumChipView.js.map +1 -1
  17. package/lib/BryntumCodeEditor.d.ts +3 -3
  18. package/lib/BryntumCodeEditor.js.map +1 -1
  19. package/lib/BryntumColorField.d.ts +2 -1
  20. package/lib/BryntumColorField.js +1 -0
  21. package/lib/BryntumColorField.js.map +1 -1
  22. package/lib/BryntumCombo.d.ts +2 -1
  23. package/lib/BryntumCombo.js +1 -0
  24. package/lib/BryntumCombo.js.map +1 -1
  25. package/lib/BryntumContainer.d.ts +1 -1
  26. package/lib/BryntumContainer.js.map +1 -1
  27. package/lib/BryntumDateField.d.ts +2 -1
  28. package/lib/BryntumDateField.js +1 -0
  29. package/lib/BryntumDateField.js.map +1 -1
  30. package/lib/BryntumDatePicker.d.ts +3 -3
  31. package/lib/BryntumDatePicker.js.map +1 -1
  32. package/lib/BryntumDateRangeField.d.ts +2 -1
  33. package/lib/BryntumDateRangeField.js +1 -0
  34. package/lib/BryntumDateRangeField.js.map +1 -1
  35. package/lib/BryntumDateTimeField.d.ts +2 -1
  36. package/lib/BryntumDateTimeField.js +1 -0
  37. package/lib/BryntumDateTimeField.js.map +1 -1
  38. package/lib/BryntumDemoCodeEditor.d.ts +3 -3
  39. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  40. package/lib/BryntumDisplayField.d.ts +2 -1
  41. package/lib/BryntumDisplayField.js +1 -0
  42. package/lib/BryntumDisplayField.js.map +1 -1
  43. package/lib/BryntumDurationField.d.ts +2 -1
  44. package/lib/BryntumDurationField.js +1 -0
  45. package/lib/BryntumDurationField.js.map +1 -1
  46. package/lib/BryntumEditor.d.ts +5 -5
  47. package/lib/BryntumEditor.js.map +1 -1
  48. package/lib/BryntumFieldFilterPicker.d.ts +1 -1
  49. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  50. package/lib/BryntumFieldFilterPickerGroup.d.ts +2 -2
  51. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  52. package/lib/BryntumFieldSet.d.ts +3 -3
  53. package/lib/BryntumFieldSet.js.map +1 -1
  54. package/lib/BryntumFileField.d.ts +2 -1
  55. package/lib/BryntumFileField.js +1 -0
  56. package/lib/BryntumFileField.js.map +1 -1
  57. package/lib/BryntumFilePicker.d.ts +1 -1
  58. package/lib/BryntumFilePicker.js.map +1 -1
  59. package/lib/BryntumFilterField.d.ts +2 -1
  60. package/lib/BryntumFilterField.js +1 -0
  61. package/lib/BryntumFilterField.js.map +1 -1
  62. package/lib/BryntumHint.d.ts +3 -3
  63. package/lib/BryntumHint.js.map +1 -1
  64. package/lib/BryntumLabel.d.ts +1 -1
  65. package/lib/BryntumLabel.js.map +1 -1
  66. package/lib/BryntumList.d.ts +2 -2
  67. package/lib/BryntumList.js.map +1 -1
  68. package/lib/BryntumMenu.d.ts +3 -3
  69. package/lib/BryntumMenu.js.map +1 -1
  70. package/lib/BryntumMonthPicker.d.ts +3 -3
  71. package/lib/BryntumMonthPicker.js.map +1 -1
  72. package/lib/BryntumNumberField.d.ts +2 -1
  73. package/lib/BryntumNumberField.js +1 -0
  74. package/lib/BryntumNumberField.js.map +1 -1
  75. package/lib/BryntumPagingToolbar.d.ts +2 -2
  76. package/lib/BryntumPagingToolbar.js.map +1 -1
  77. package/lib/BryntumPanel.d.ts +3 -3
  78. package/lib/BryntumPanel.js.map +1 -1
  79. package/lib/BryntumPasswordField.d.ts +2 -1
  80. package/lib/BryntumPasswordField.js +1 -0
  81. package/lib/BryntumPasswordField.js.map +1 -1
  82. package/lib/BryntumProgressBar.d.ts +1 -1
  83. package/lib/BryntumProgressBar.js.map +1 -1
  84. package/lib/BryntumRadio.d.ts +3 -2
  85. package/lib/BryntumRadio.js +1 -0
  86. package/lib/BryntumRadio.js.map +1 -1
  87. package/lib/BryntumRadioGroup.d.ts +3 -3
  88. package/lib/BryntumRadioGroup.js.map +1 -1
  89. package/lib/BryntumSlideToggle.d.ts +3 -2
  90. package/lib/BryntumSlideToggle.js +1 -0
  91. package/lib/BryntumSlideToggle.js.map +1 -1
  92. package/lib/BryntumSlider.d.ts +1 -1
  93. package/lib/BryntumSlider.js.map +1 -1
  94. package/lib/BryntumSplitter.d.ts +1 -1
  95. package/lib/BryntumSplitter.js.map +1 -1
  96. package/lib/BryntumTabPanel.d.ts +4 -4
  97. package/lib/BryntumTabPanel.js.map +1 -1
  98. package/lib/BryntumTextAreaField.d.ts +2 -1
  99. package/lib/BryntumTextAreaField.js +1 -0
  100. package/lib/BryntumTextAreaField.js.map +1 -1
  101. package/lib/BryntumTextAreaPickerField.d.ts +2 -1
  102. package/lib/BryntumTextAreaPickerField.js +1 -0
  103. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  104. package/lib/BryntumTextField.d.ts +2 -1
  105. package/lib/BryntumTextField.js +1 -0
  106. package/lib/BryntumTextField.js.map +1 -1
  107. package/lib/BryntumTimeField.d.ts +2 -1
  108. package/lib/BryntumTimeField.js +1 -0
  109. package/lib/BryntumTimeField.js.map +1 -1
  110. package/lib/BryntumTimePicker.d.ts +1 -1
  111. package/lib/BryntumTimePicker.js.map +1 -1
  112. package/lib/BryntumToolbar.d.ts +2 -2
  113. package/lib/BryntumToolbar.js.map +1 -1
  114. package/lib/BryntumWidget.d.ts +1 -1
  115. package/lib/BryntumWidget.js.map +1 -1
  116. package/lib/BryntumYearPicker.d.ts +3 -3
  117. package/lib/BryntumYearPicker.js.map +1 -1
  118. package/package.json +1 -1
  119. package/src/BryntumBooleanCombo.tsx +17 -1
  120. package/src/BryntumButton.tsx +9 -3
  121. package/src/BryntumButtonGroup.tsx +7 -1
  122. package/src/BryntumChatPanel.tsx +9 -3
  123. package/src/BryntumCheckbox.tsx +18 -2
  124. package/src/BryntumCheckboxGroup.tsx +9 -3
  125. package/src/BryntumChipView.tsx +11 -3
  126. package/src/BryntumCodeEditor.tsx +9 -3
  127. package/src/BryntumColorField.tsx +17 -1
  128. package/src/BryntumCombo.tsx +17 -1
  129. package/src/BryntumContainer.tsx +7 -1
  130. package/src/BryntumDateField.tsx +17 -1
  131. package/src/BryntumDatePicker.tsx +9 -3
  132. package/src/BryntumDateRangeField.tsx +17 -1
  133. package/src/BryntumDateTimeField.tsx +17 -1
  134. package/src/BryntumDemoCodeEditor.tsx +9 -3
  135. package/src/BryntumDisplayField.tsx +17 -1
  136. package/src/BryntumDurationField.tsx +17 -1
  137. package/src/BryntumEditor.tsx +11 -5
  138. package/src/BryntumFieldFilterPicker.tsx +7 -1
  139. package/src/BryntumFieldFilterPickerGroup.tsx +8 -2
  140. package/src/BryntumFieldSet.tsx +9 -3
  141. package/src/BryntumFileField.tsx +17 -1
  142. package/src/BryntumFilePicker.tsx +7 -1
  143. package/src/BryntumFilterField.tsx +17 -1
  144. package/src/BryntumHint.tsx +9 -3
  145. package/src/BryntumLabel.tsx +7 -1
  146. package/src/BryntumList.tsx +8 -2
  147. package/src/BryntumMenu.tsx +9 -3
  148. package/src/BryntumMonthPicker.tsx +9 -3
  149. package/src/BryntumNumberField.tsx +17 -1
  150. package/src/BryntumPagingToolbar.tsx +8 -2
  151. package/src/BryntumPanel.tsx +9 -3
  152. package/src/BryntumPasswordField.tsx +17 -1
  153. package/src/BryntumProgressBar.tsx +7 -1
  154. package/src/BryntumRadio.tsx +18 -2
  155. package/src/BryntumRadioGroup.tsx +9 -3
  156. package/src/BryntumSlideToggle.tsx +18 -2
  157. package/src/BryntumSlider.tsx +7 -1
  158. package/src/BryntumSplitter.tsx +7 -1
  159. package/src/BryntumTabPanel.tsx +10 -4
  160. package/src/BryntumTextAreaField.tsx +17 -1
  161. package/src/BryntumTextAreaPickerField.tsx +17 -1
  162. package/src/BryntumTextField.tsx +17 -1
  163. package/src/BryntumTimeField.tsx +17 -1
  164. package/src/BryntumTimePicker.tsx +7 -1
  165. package/src/BryntumToolbar.tsx +8 -2
  166. package/src/BryntumWidget.tsx +7 -1
  167. package/src/BryntumYearPicker.tsx +9 -3
@@ -34,6 +34,8 @@ export type BryntumSlideToggleProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -100,6 +102,15 @@ export type BryntumSlideToggleProps = {
100
102
  * A value of `undefined` will cause this widget not to include its value when checked.
101
103
  */
102
104
  checkedValue? : any
105
+ /**
106
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
107
+ * 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)
108
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
109
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
110
+ * @param {Core.widget.Field} field The field being validated
111
+ * @returns {void}
112
+ */
113
+ checkValidity? : ((field: Field) => void)|string
103
114
  /**
104
115
  * Custom CSS classes to add to element.
105
116
  * May be specified as a space separated string, or as an object in which property names
@@ -288,10 +299,14 @@ export type BryntumSlideToggleProps = {
288
299
  inputWidth? : string|number
289
300
  /**
290
301
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
302
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
303
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertBefore)
291
304
  */
292
305
  insertBefore? : HTMLElement|string
293
306
  /**
294
307
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
308
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
309
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertFirst)
295
310
  */
296
311
  insertFirst? : HTMLElement|string
297
312
  /**
@@ -610,7 +625,7 @@ export type BryntumSlideToggleProps = {
610
625
  * @param {boolean} event.valid True if this field is in a valid state.
611
626
  * @param {Event} event.event The triggering DOM event if any
612
627
  */
613
- onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string
628
+ onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string
614
629
  /**
615
630
  * Fires before an object is destroyed.
616
631
  * @param {object} event Event object
@@ -622,7 +637,7 @@ export type BryntumSlideToggleProps = {
622
637
  * @param {object} event Event object
623
638
  * @param {Core.widget.Widget} event.source The widget being hidden.
624
639
  */
625
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
640
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
626
641
  /**
627
642
  * Triggered before a widget is shown. Return `false` to prevent the action.
628
643
  * @param {object} event Event object
@@ -779,6 +794,7 @@ export class BryntumSlideToggle extends React.Component<BryntumSlideToggleProps>
779
794
  'bubbleEvents',
780
795
  'centered',
781
796
  'checkedValue',
797
+ 'checkValidity',
782
798
  'color',
783
799
  'config',
784
800
  'constrainTo',
@@ -34,6 +34,8 @@ export type BryntumSliderProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -205,10 +207,14 @@ export type BryntumSliderProps = {
205
207
  ignoreParentReadOnly? : boolean
206
208
  /**
207
209
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
210
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
211
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-insertBefore)
208
212
  */
209
213
  insertBefore? : HTMLElement|string
210
214
  /**
211
215
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
216
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
217
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-insertFirst)
212
218
  */
213
219
  insertFirst? : HTMLElement|string
214
220
  /**
@@ -498,7 +504,7 @@ export type BryntumSliderProps = {
498
504
  * @param {object} event Event object
499
505
  * @param {Core.widget.Widget} event.source The widget being hidden.
500
506
  */
501
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
507
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
502
508
  /**
503
509
  * Triggered before a widget is shown. Return `false` to prevent the action.
504
510
  * @param {object} event Event object
@@ -34,6 +34,8 @@ export type BryntumSplitterProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Splitter#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -205,10 +207,14 @@ export type BryntumSplitterProps = {
205
207
  ignoreParentReadOnly? : boolean
206
208
  /**
207
209
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
210
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
211
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Splitter#config-insertBefore)
208
212
  */
209
213
  insertBefore? : HTMLElement|string
210
214
  /**
211
215
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
216
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
217
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Splitter#config-insertFirst)
212
218
  */
213
219
  insertFirst? : HTMLElement|string
214
220
  /**
@@ -440,7 +446,7 @@ export type BryntumSplitterProps = {
440
446
  * @param {object} event Event object
441
447
  * @param {Core.widget.Widget} event.source The widget being hidden.
442
448
  */
443
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
449
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
444
450
  /**
445
451
  * Triggered before a widget is shown. Return `false` to prevent the action.
446
452
  * @param {object} event Event object
@@ -42,6 +42,8 @@ export type BryntumTabPanelProps = {
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-appendTo)
45
47
  */
46
48
  appendTo? : HTMLElement|string
47
49
  /**
@@ -303,10 +305,14 @@ export type BryntumTabPanelProps = {
303
305
  inputFieldAlign? : 'start'|'end'
304
306
  /**
305
307
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
308
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
309
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-insertBefore)
306
310
  */
307
311
  insertBefore? : HTMLElement|string
308
312
  /**
309
313
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
314
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
315
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-insertFirst)
310
316
  */
311
317
  insertFirst? : HTMLElement|string
312
318
  /**
@@ -664,7 +670,7 @@ export type BryntumTabPanelProps = {
664
670
  * @param {object} event Event object
665
671
  * @param {Core.widget.Widget} event.source The widget being hidden.
666
672
  */
667
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
673
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
668
674
  /**
669
675
  * Fired before this container will load record values into its child fields. This is useful if you
670
676
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -684,13 +690,13 @@ export type BryntumTabPanelProps = {
684
690
  * @param {object} event Event object
685
691
  * @param {any} event.state State object config
686
692
  */
687
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
693
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
688
694
  /**
689
695
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
690
696
  * @param {object} event Event object
691
697
  * @param {any} event.state State object config
692
698
  */
693
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
699
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
694
700
  /**
695
701
  * The active tab is about to be changed. Return `false` to prevent this.
696
702
  * @param {object} event Event object
@@ -699,7 +705,7 @@ export type BryntumTabPanelProps = {
699
705
  * @param {number} event.prevActiveIndex The previous active index.
700
706
  * @param {Core.widget.Widget} event.prevActiveItem The previous active child widget.
701
707
  */
702
- onBeforeTabChange? : ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => Promise<boolean>|boolean|void)|string
708
+ onBeforeTabChange? : ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => boolean|void)|string
703
709
  /**
704
710
  * Fires when any other event is fired from the object.
705
711
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#event-catchAll)
@@ -34,6 +34,8 @@ export type BryntumTextAreaFieldProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -89,6 +91,15 @@ export type BryntumTextAreaFieldProps = {
89
91
  * Set to `true` to centre the Widget in browser viewport space.
90
92
  */
91
93
  centered? : boolean
94
+ /**
95
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
96
+ * 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)
97
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
98
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-checkValidity)
99
+ * @param {Core.widget.Field} field The field being validated
100
+ * @returns {void}
101
+ */
102
+ checkValidity? : ((field: Field) => void)|string
92
103
  /**
93
104
  * 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
94
105
  * 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
@@ -292,10 +303,14 @@ export type BryntumTextAreaFieldProps = {
292
303
  inputWidth? : string|number
293
304
  /**
294
305
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
306
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
307
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-insertBefore)
295
308
  */
296
309
  insertBefore? : HTMLElement|string
297
310
  /**
298
311
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
312
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-insertFirst)
299
314
  */
300
315
  insertFirst? : HTMLElement|string
301
316
  /**
@@ -619,7 +634,7 @@ export type BryntumTextAreaFieldProps = {
619
634
  * @param {object} event Event object
620
635
  * @param {Core.widget.Widget} event.source The widget being hidden.
621
636
  */
622
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
637
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
623
638
  /**
624
639
  * Triggered before a widget is shown. Return `false` to prevent the action.
625
640
  * @param {object} event Event object
@@ -768,6 +783,7 @@ export class BryntumTextAreaField extends React.Component<BryntumTextAreaFieldPr
768
783
  'autoSelect',
769
784
  'bubbleEvents',
770
785
  'centered',
786
+ 'checkValidity',
771
787
  'clearable',
772
788
  'color',
773
789
  'config',
@@ -34,6 +34,8 @@ export type BryntumTextAreaPickerFieldProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -87,6 +89,15 @@ export type BryntumTextAreaPickerFieldProps = {
87
89
  * Set to `true` to centre the Widget in browser viewport space.
88
90
  */
89
91
  centered? : boolean
92
+ /**
93
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
94
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
95
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
96
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-checkValidity)
97
+ * @param {Core.widget.Field} field The field being validated
98
+ * @returns {void}
99
+ */
100
+ checkValidity? : ((field: Field) => void)|string
90
101
  /**
91
102
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
92
103
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -283,10 +294,14 @@ export type BryntumTextAreaPickerFieldProps = {
283
294
  inputWidth? : string|number
284
295
  /**
285
296
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
297
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
298
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-insertBefore)
286
299
  */
287
300
  insertBefore? : HTMLElement|string
288
301
  /**
289
302
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
303
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
304
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-insertFirst)
290
305
  */
291
306
  insertFirst? : HTMLElement|string
292
307
  /**
@@ -628,7 +643,7 @@ export type BryntumTextAreaPickerFieldProps = {
628
643
  * @param {object} event Event object
629
644
  * @param {Core.widget.Widget} event.source The widget being hidden.
630
645
  */
631
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
646
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
632
647
  /**
633
648
  * Triggered before a widget is shown. Return `false` to prevent the action.
634
649
  * @param {object} event Event object
@@ -777,6 +792,7 @@ export class BryntumTextAreaPickerField extends React.Component<BryntumTextAreaP
777
792
  'autoSelect',
778
793
  'bubbleEvents',
779
794
  'centered',
795
+ 'checkValidity',
780
796
  'clearable',
781
797
  'color',
782
798
  'config',
@@ -34,6 +34,8 @@ export type BryntumTextFieldProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -83,6 +85,15 @@ export type BryntumTextFieldProps = {
83
85
  * Set to `true` to centre the Widget in browser viewport space.
84
86
  */
85
87
  centered? : boolean
88
+ /**
89
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
90
+ * 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)
91
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
92
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-checkValidity)
93
+ * @param {Core.widget.Field} field The field being validated
94
+ * @returns {void}
95
+ */
96
+ checkValidity? : ((field: Field) => void)|string
86
97
  /**
87
98
  * 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
88
99
  * 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
@@ -286,10 +297,14 @@ export type BryntumTextFieldProps = {
286
297
  inputWidth? : string|number
287
298
  /**
288
299
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
300
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
301
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-insertBefore)
289
302
  */
290
303
  insertBefore? : HTMLElement|string
291
304
  /**
292
305
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
306
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
307
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-insertFirst)
293
308
  */
294
309
  insertFirst? : HTMLElement|string
295
310
  /**
@@ -617,7 +632,7 @@ export type BryntumTextFieldProps = {
617
632
  * @param {object} event Event object
618
633
  * @param {Core.widget.Widget} event.source The widget being hidden.
619
634
  */
620
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
635
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
621
636
  /**
622
637
  * Triggered before a widget is shown. Return `false` to prevent the action.
623
638
  * @param {object} event Event object
@@ -765,6 +780,7 @@ export class BryntumTextField extends React.Component<BryntumTextFieldProps> {
765
780
  'autoSelect',
766
781
  'bubbleEvents',
767
782
  'centered',
783
+ 'checkValidity',
768
784
  'clearable',
769
785
  'color',
770
786
  'config',
@@ -34,6 +34,8 @@ export type BryntumTimeFieldProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -87,6 +89,15 @@ export type BryntumTimeFieldProps = {
87
89
  * Set to `true` to centre the Widget in browser viewport space.
88
90
  */
89
91
  centered? : boolean
92
+ /**
93
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
94
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
95
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
96
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-checkValidity)
97
+ * @param {Core.widget.Field} field The field being validated
98
+ * @returns {void}
99
+ */
100
+ checkValidity? : ((field: Field) => void)|string
90
101
  /**
91
102
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
92
103
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -292,10 +303,14 @@ export type BryntumTimeFieldProps = {
292
303
  inputWidth? : string|number
293
304
  /**
294
305
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
306
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
307
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-insertBefore)
295
308
  */
296
309
  insertBefore? : HTMLElement|string
297
310
  /**
298
311
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
312
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-insertFirst)
299
314
  */
300
315
  insertFirst? : HTMLElement|string
301
316
  /**
@@ -669,7 +684,7 @@ export type BryntumTimeFieldProps = {
669
684
  * @param {object} event Event object
670
685
  * @param {Core.widget.Widget} event.source The widget being hidden.
671
686
  */
672
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
687
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
673
688
  /**
674
689
  * Triggered before a widget is shown. Return `false` to prevent the action.
675
690
  * @param {object} event Event object
@@ -818,6 +833,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
818
833
  'autoSelect',
819
834
  'bubbleEvents',
820
835
  'centered',
836
+ 'checkValidity',
821
837
  'clearable',
822
838
  'color',
823
839
  'config',
@@ -34,6 +34,8 @@ export type BryntumTimePickerProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -243,10 +245,14 @@ export type BryntumTimePickerProps = {
243
245
  inputFieldAlign? : 'start'|'end'
244
246
  /**
245
247
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
248
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
249
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-insertBefore)
246
250
  */
247
251
  insertBefore? : HTMLElement|string
248
252
  /**
249
253
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
254
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
255
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-insertFirst)
250
256
  */
251
257
  insertFirst? : HTMLElement|string
252
258
  /**
@@ -553,7 +559,7 @@ export type BryntumTimePickerProps = {
553
559
  * @param {object} event Event object
554
560
  * @param {Core.widget.Widget} event.source The widget being hidden.
555
561
  */
556
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
562
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
557
563
  /**
558
564
  * Fired before this container will load record values into its child fields. This is useful if you
559
565
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -34,6 +34,8 @@ export type BryntumToolbarProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -242,10 +244,14 @@ export type BryntumToolbarProps = {
242
244
  inputFieldAlign? : 'start'|'end'
243
245
  /**
244
246
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
247
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
248
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-insertBefore)
245
249
  */
246
250
  insertBefore? : HTMLElement|string
247
251
  /**
248
252
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
253
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
254
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-insertFirst)
249
255
  */
250
256
  insertFirst? : HTMLElement|string
251
257
  /**
@@ -555,7 +561,7 @@ export type BryntumToolbarProps = {
555
561
  * @param {object} event Event object
556
562
  * @param {Core.widget.Widget} event.source The widget being hidden.
557
563
  */
558
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
564
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
559
565
  /**
560
566
  * This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
561
567
  * a listener returns `false`.
@@ -564,7 +570,7 @@ export type BryntumToolbarProps = {
564
570
  * @param {Core.widget.Widget} event.item The dragged item.
565
571
  * @param {Event} event.domEvent The browser event.
566
572
  */
567
- onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => Promise<boolean>|boolean|void)|string
573
+ onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string
568
574
  /**
569
575
  * Fired before this container will load record values into its child fields. This is useful if you
570
576
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -34,6 +34,8 @@ export type BryntumWidgetProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -205,10 +207,14 @@ export type BryntumWidgetProps = {
205
207
  ignoreParentReadOnly? : boolean
206
208
  /**
207
209
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
210
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
211
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-insertBefore)
208
212
  */
209
213
  insertBefore? : HTMLElement|string
210
214
  /**
211
215
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
216
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
217
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-insertFirst)
212
218
  */
213
219
  insertFirst? : HTMLElement|string
214
220
  /**
@@ -429,7 +435,7 @@ export type BryntumWidgetProps = {
429
435
  * @param {object} event Event object
430
436
  * @param {Core.widget.Widget} event.source The widget being hidden.
431
437
  */
432
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
438
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
433
439
  /**
434
440
  * Triggered before a widget is shown. Return `false` to prevent the action.
435
441
  * @param {object} event Event object
@@ -34,6 +34,8 @@ export type BryntumYearPickerProps = {
34
34
  /**
35
35
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
36
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
37
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-appendTo)
37
39
  */
38
40
  appendTo? : HTMLElement|string
39
41
  /**
@@ -291,10 +293,14 @@ export type BryntumYearPickerProps = {
291
293
  inputFieldAlign? : 'start'|'end'
292
294
  /**
293
295
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
296
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
297
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-insertBefore)
294
298
  */
295
299
  insertBefore? : HTMLElement|string
296
300
  /**
297
301
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
302
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
303
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-insertFirst)
298
304
  */
299
305
  insertFirst? : HTMLElement|string
300
306
  /**
@@ -659,7 +665,7 @@ export type BryntumYearPickerProps = {
659
665
  * @param {object} event Event object
660
666
  * @param {Core.widget.Widget} event.source The widget being hidden.
661
667
  */
662
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
668
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
663
669
  /**
664
670
  * Fired before this container will load record values into its child fields. This is useful if you
665
671
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -679,13 +685,13 @@ export type BryntumYearPickerProps = {
679
685
  * @param {object} event Event object
680
686
  * @param {any} event.state State object config
681
687
  */
682
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
688
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
683
689
  /**
684
690
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
685
691
  * @param {object} event Event object
686
692
  * @param {any} event.state State object config
687
693
  */
688
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
694
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
689
695
  /**
690
696
  * Fires when any other event is fired from the object.
691
697
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#event-catchAll)