@bryntum/core-react-thin 7.3.0 → 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 (137) 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/BryntumButtonGroup.d.ts +1 -1
  6. package/lib/BryntumChatPanel.d.ts +3 -3
  7. package/lib/BryntumCheckbox.d.ts +3 -2
  8. package/lib/BryntumCheckbox.js +1 -0
  9. package/lib/BryntumCheckbox.js.map +1 -1
  10. package/lib/BryntumCheckboxGroup.d.ts +3 -3
  11. package/lib/BryntumChipView.d.ts +2 -2
  12. package/lib/BryntumCodeEditor.d.ts +3 -3
  13. package/lib/BryntumColorField.d.ts +2 -1
  14. package/lib/BryntumColorField.js +1 -0
  15. package/lib/BryntumColorField.js.map +1 -1
  16. package/lib/BryntumCombo.d.ts +2 -1
  17. package/lib/BryntumCombo.js +1 -0
  18. package/lib/BryntumCombo.js.map +1 -1
  19. package/lib/BryntumContainer.d.ts +1 -1
  20. package/lib/BryntumDateField.d.ts +2 -1
  21. package/lib/BryntumDateField.js +1 -0
  22. package/lib/BryntumDateField.js.map +1 -1
  23. package/lib/BryntumDatePicker.d.ts +3 -3
  24. package/lib/BryntumDateRangeField.d.ts +2 -1
  25. package/lib/BryntumDateRangeField.js +1 -0
  26. package/lib/BryntumDateRangeField.js.map +1 -1
  27. package/lib/BryntumDateTimeField.d.ts +2 -1
  28. package/lib/BryntumDateTimeField.js +1 -0
  29. package/lib/BryntumDateTimeField.js.map +1 -1
  30. package/lib/BryntumDemoCodeEditor.d.ts +3 -3
  31. package/lib/BryntumDisplayField.d.ts +2 -1
  32. package/lib/BryntumDisplayField.js +1 -0
  33. package/lib/BryntumDisplayField.js.map +1 -1
  34. package/lib/BryntumDurationField.d.ts +2 -1
  35. package/lib/BryntumDurationField.js +1 -0
  36. package/lib/BryntumDurationField.js.map +1 -1
  37. package/lib/BryntumEditor.d.ts +5 -5
  38. package/lib/BryntumFieldFilterPicker.d.ts +1 -1
  39. package/lib/BryntumFieldFilterPickerGroup.d.ts +2 -2
  40. package/lib/BryntumFieldSet.d.ts +3 -3
  41. package/lib/BryntumFileField.d.ts +2 -1
  42. package/lib/BryntumFileField.js +1 -0
  43. package/lib/BryntumFileField.js.map +1 -1
  44. package/lib/BryntumFilePicker.d.ts +1 -1
  45. package/lib/BryntumFilterField.d.ts +2 -1
  46. package/lib/BryntumFilterField.js +1 -0
  47. package/lib/BryntumFilterField.js.map +1 -1
  48. package/lib/BryntumHint.d.ts +3 -3
  49. package/lib/BryntumLabel.d.ts +1 -1
  50. package/lib/BryntumList.d.ts +2 -2
  51. package/lib/BryntumMenu.d.ts +3 -3
  52. package/lib/BryntumMonthPicker.d.ts +3 -3
  53. package/lib/BryntumNumberField.d.ts +2 -1
  54. package/lib/BryntumNumberField.js +1 -0
  55. package/lib/BryntumNumberField.js.map +1 -1
  56. package/lib/BryntumPagingToolbar.d.ts +2 -2
  57. package/lib/BryntumPanel.d.ts +3 -3
  58. package/lib/BryntumPasswordField.d.ts +2 -1
  59. package/lib/BryntumPasswordField.js +1 -0
  60. package/lib/BryntumPasswordField.js.map +1 -1
  61. package/lib/BryntumProgressBar.d.ts +1 -1
  62. package/lib/BryntumRadio.d.ts +3 -2
  63. package/lib/BryntumRadio.js +1 -0
  64. package/lib/BryntumRadio.js.map +1 -1
  65. package/lib/BryntumRadioGroup.d.ts +3 -3
  66. package/lib/BryntumSlideToggle.d.ts +3 -2
  67. package/lib/BryntumSlideToggle.js +1 -0
  68. package/lib/BryntumSlideToggle.js.map +1 -1
  69. package/lib/BryntumSlider.d.ts +1 -1
  70. package/lib/BryntumSplitter.d.ts +1 -1
  71. package/lib/BryntumTabPanel.d.ts +4 -4
  72. package/lib/BryntumTextAreaField.d.ts +2 -1
  73. package/lib/BryntumTextAreaField.js +1 -0
  74. package/lib/BryntumTextAreaField.js.map +1 -1
  75. package/lib/BryntumTextAreaPickerField.d.ts +2 -1
  76. package/lib/BryntumTextAreaPickerField.js +1 -0
  77. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  78. package/lib/BryntumTextField.d.ts +2 -1
  79. package/lib/BryntumTextField.js +1 -0
  80. package/lib/BryntumTextField.js.map +1 -1
  81. package/lib/BryntumTimeField.d.ts +2 -1
  82. package/lib/BryntumTimeField.js +1 -0
  83. package/lib/BryntumTimeField.js.map +1 -1
  84. package/lib/BryntumTimePicker.d.ts +1 -1
  85. package/lib/BryntumToolbar.d.ts +2 -2
  86. package/lib/BryntumWidget.d.ts +1 -1
  87. package/lib/BryntumYearPicker.d.ts +3 -3
  88. package/package.json +1 -1
  89. package/src/BryntumBooleanCombo.tsx +11 -1
  90. package/src/BryntumButton.tsx +3 -3
  91. package/src/BryntumButtonGroup.tsx +1 -1
  92. package/src/BryntumChatPanel.tsx +3 -3
  93. package/src/BryntumCheckbox.tsx +12 -2
  94. package/src/BryntumCheckboxGroup.tsx +3 -3
  95. package/src/BryntumChipView.tsx +2 -2
  96. package/src/BryntumCodeEditor.tsx +3 -3
  97. package/src/BryntumColorField.tsx +11 -1
  98. package/src/BryntumCombo.tsx +11 -1
  99. package/src/BryntumContainer.tsx +1 -1
  100. package/src/BryntumDateField.tsx +11 -1
  101. package/src/BryntumDatePicker.tsx +3 -3
  102. package/src/BryntumDateRangeField.tsx +11 -1
  103. package/src/BryntumDateTimeField.tsx +11 -1
  104. package/src/BryntumDemoCodeEditor.tsx +3 -3
  105. package/src/BryntumDisplayField.tsx +11 -1
  106. package/src/BryntumDurationField.tsx +11 -1
  107. package/src/BryntumEditor.tsx +5 -5
  108. package/src/BryntumFieldFilterPicker.tsx +1 -1
  109. package/src/BryntumFieldFilterPickerGroup.tsx +2 -2
  110. package/src/BryntumFieldSet.tsx +3 -3
  111. package/src/BryntumFileField.tsx +11 -1
  112. package/src/BryntumFilePicker.tsx +1 -1
  113. package/src/BryntumFilterField.tsx +11 -1
  114. package/src/BryntumHint.tsx +3 -3
  115. package/src/BryntumLabel.tsx +1 -1
  116. package/src/BryntumList.tsx +2 -2
  117. package/src/BryntumMenu.tsx +3 -3
  118. package/src/BryntumMonthPicker.tsx +3 -3
  119. package/src/BryntumNumberField.tsx +11 -1
  120. package/src/BryntumPagingToolbar.tsx +2 -2
  121. package/src/BryntumPanel.tsx +3 -3
  122. package/src/BryntumPasswordField.tsx +11 -1
  123. package/src/BryntumProgressBar.tsx +1 -1
  124. package/src/BryntumRadio.tsx +12 -2
  125. package/src/BryntumRadioGroup.tsx +3 -3
  126. package/src/BryntumSlideToggle.tsx +12 -2
  127. package/src/BryntumSlider.tsx +1 -1
  128. package/src/BryntumSplitter.tsx +1 -1
  129. package/src/BryntumTabPanel.tsx +4 -4
  130. package/src/BryntumTextAreaField.tsx +11 -1
  131. package/src/BryntumTextAreaPickerField.tsx +11 -1
  132. package/src/BryntumTextField.tsx +11 -1
  133. package/src/BryntumTimeField.tsx +11 -1
  134. package/src/BryntumTimePicker.tsx +1 -1
  135. package/src/BryntumToolbar.tsx +2 -2
  136. package/src/BryntumWidget.tsx +1 -1
  137. package/src/BryntumYearPicker.tsx +3 -3
@@ -92,6 +92,15 @@ export type BryntumDurationFieldProps = {
92
92
  * Set to `true` to centre the Widget in browser viewport space.
93
93
  */
94
94
  centered? : boolean
95
+ /**
96
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
97
+ * 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)
98
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
99
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-checkValidity)
100
+ * @param {Core.widget.Field} field The field being validated
101
+ * @returns {void}
102
+ */
103
+ checkValidity? : ((field: Field) => void)|string
95
104
  /**
96
105
  * 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
97
106
  * 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
@@ -660,7 +669,7 @@ export type BryntumDurationFieldProps = {
660
669
  * @param {object} event Event object
661
670
  * @param {Core.widget.Widget} event.source The widget being hidden.
662
671
  */
663
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
672
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
664
673
  /**
665
674
  * Triggered before a widget is shown. Return `false` to prevent the action.
666
675
  * @param {object} event Event object
@@ -808,6 +817,7 @@ export class BryntumDurationField extends React.Component<BryntumDurationFieldPr
808
817
  'autoSelect',
809
818
  'bubbleEvents',
810
819
  'centered',
820
+ 'checkValidity',
811
821
  'clearable',
812
822
  'color',
813
823
  'config',
@@ -593,7 +593,7 @@ export type BryntumEditorProps = {
593
593
  * @param {Event} event.event Included if the cancellation was triggered by a DOM event
594
594
  * @param {Core.widget.Editor} event.source The Editor that triggered the event.
595
595
  */
596
- onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
596
+ onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => boolean|void)|string
597
597
  /**
598
598
  * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
599
599
  * The completion may be vetoed, in which case, focus is moved back into the editor.
@@ -604,7 +604,7 @@ export type BryntumEditorProps = {
604
604
  * @param {Function} [event.finalize] An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
605
605
  * @param {object} [event.finalize.context] An object describing the editing context upon requested completion of the edit.
606
606
  */
607
- onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => Promise<boolean>|boolean|void)|string
607
+ onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => boolean|void)|string
608
608
  /**
609
609
  * Fires before an object is destroyed.
610
610
  * @param {object} event Event object
@@ -616,7 +616,7 @@ export type BryntumEditorProps = {
616
616
  * @param {object} event Event object
617
617
  * @param {Core.widget.Widget} event.source The widget being hidden.
618
618
  */
619
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
619
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
620
620
  /**
621
621
  * Fired before this container will load record values into its child fields. This is useful if you
622
622
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -634,7 +634,7 @@ export type BryntumEditorProps = {
634
634
  /**
635
635
  * Fired before the editor is shown to start an edit operation. Returning `false` from a handler vetoes the edit operation.
636
636
  * @param {object} event Event object
637
- * @param {HTMLElement} event.target The element which the Editor is to overlay to edit its content.
637
+ * @param {Element} event.target The element which the Editor is to overlay to edit its content.
638
638
  * @param {Core.data.Model} [event.record] The record being edited.
639
639
  * @param {string} [event.field] The name of the field if a record is being edited.
640
640
  * @param {object} event.value The value to be edited.
@@ -646,7 +646,7 @@ export type BryntumEditorProps = {
646
646
  * @param {boolean} event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/core/docs/api/Core/widget/Editor#config-matchFont)
647
647
  * @param {boolean} event.focus Whether to focus the editor's field.
648
648
  */
649
- onBeforeStart? : ((event: { target: HTMLElement, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => Promise<boolean>|boolean|void)|string
649
+ onBeforeStart? : ((event: { target: Element, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => boolean|void)|string
650
650
  /**
651
651
  * Edit has been canceled without updating the associated record or element.
652
652
  * @param {object} event Event object
@@ -592,7 +592,7 @@ export type BryntumFieldFilterPickerProps = {
592
592
  * @param {object} event Event object
593
593
  * @param {Core.widget.Widget} event.source The widget being hidden.
594
594
  */
595
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
595
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
596
596
  /**
597
597
  * Fired before this container will load record values into its child fields. This is useful if you
598
598
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -608,7 +608,7 @@ export type BryntumFieldFilterPickerGroupProps = {
608
608
  * @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
609
609
  * @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/core/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/core/docs/api/Core/widget/FieldFilterPicker).
610
610
  */
611
- onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => Promise<boolean>|boolean|void)|string
611
+ onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
612
612
  /**
613
613
  * Fires before an object is destroyed.
614
614
  * @param {object} event Event object
@@ -620,7 +620,7 @@ export type BryntumFieldFilterPickerGroupProps = {
620
620
  * @param {object} event Event object
621
621
  * @param {Core.widget.Widget} event.source The widget being hidden.
622
622
  */
623
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
623
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
624
624
  /**
625
625
  * Fired before this container will load record values into its child fields. This is useful if you
626
626
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -653,7 +653,7 @@ export type BryntumFieldSetProps = {
653
653
  * @param {object} event Event object
654
654
  * @param {Core.widget.Widget} event.source The widget being hidden.
655
655
  */
656
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
656
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
657
657
  /**
658
658
  * Fired before this container will load record values into its child fields. This is useful if you
659
659
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -673,13 +673,13 @@ export type BryntumFieldSetProps = {
673
673
  * @param {object} event Event object
674
674
  * @param {any} event.state State object config
675
675
  */
676
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
676
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
677
677
  /**
678
678
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
679
679
  * @param {object} event Event object
680
680
  * @param {any} event.state State object config
681
681
  */
682
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
682
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
683
683
  /**
684
684
  * Fires when any other event is fired from the object.
685
685
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#event-catchAll)
@@ -88,6 +88,15 @@ export type BryntumFileFieldProps = {
88
88
  * Set to `true` to centre the Widget in browser viewport space.
89
89
  */
90
90
  centered? : boolean
91
+ /**
92
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
93
+ * 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)
94
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
95
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
96
+ * @param {Core.widget.Field} field The field being validated
97
+ * @returns {void}
98
+ */
99
+ checkValidity? : ((field: Field) => void)|string
91
100
  /**
92
101
  * 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
93
102
  * 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
@@ -615,7 +624,7 @@ export type BryntumFileFieldProps = {
615
624
  * @param {object} event Event object
616
625
  * @param {Core.widget.Widget} event.source The widget being hidden.
617
626
  */
618
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
627
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
619
628
  /**
620
629
  * Triggered before a widget is shown. Return `false` to prevent the action.
621
630
  * @param {object} event Event object
@@ -764,6 +773,7 @@ export class BryntumFileField extends React.Component<BryntumFileFieldProps> {
764
773
  'autoSelect',
765
774
  'bubbleEvents',
766
775
  'centered',
776
+ 'checkValidity',
767
777
  'clearable',
768
778
  'color',
769
779
  'config',
@@ -545,7 +545,7 @@ export type BryntumFilePickerProps = {
545
545
  * @param {object} event Event object
546
546
  * @param {Core.widget.Widget} event.source The widget being hidden.
547
547
  */
548
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
548
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
549
549
  /**
550
550
  * Fired before this container will load record values into its child fields. This is useful if you
551
551
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -83,6 +83,15 @@ export type BryntumFilterFieldProps = {
83
83
  * Set to `true` to centre the Widget in browser viewport space.
84
84
  */
85
85
  centered? : boolean
86
+ /**
87
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
88
+ * 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)
89
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-checkValidity)
91
+ * @param {Core.widget.Field} field The field being validated
92
+ * @returns {void}
93
+ */
94
+ checkValidity? : ((field: Field) => void)|string
86
95
  /**
87
96
  * 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
97
  * 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
@@ -646,7 +655,7 @@ export type BryntumFilterFieldProps = {
646
655
  * @param {object} event Event object
647
656
  * @param {Core.widget.Widget} event.source The widget being hidden.
648
657
  */
649
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
658
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
650
659
  /**
651
660
  * Triggered before a widget is shown. Return `false` to prevent the action.
652
661
  * @param {object} event Event object
@@ -794,6 +803,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
794
803
  'autoSelect',
795
804
  'bubbleEvents',
796
805
  'centered',
806
+ 'checkValidity',
797
807
  'clearable',
798
808
  'color',
799
809
  'config',
@@ -719,7 +719,7 @@ export type BryntumHintProps = {
719
719
  * @param {object} event Event object
720
720
  * @param {Core.widget.Widget} event.source The widget being hidden.
721
721
  */
722
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
722
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
723
723
  /**
724
724
  * Fired before this container will load record values into its child fields. This is useful if you
725
725
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -739,13 +739,13 @@ export type BryntumHintProps = {
739
739
  * @param {object} event Event object
740
740
  * @param {any} event.state State object config
741
741
  */
742
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
742
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
743
743
  /**
744
744
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
745
745
  * @param {object} event Event object
746
746
  * @param {any} event.state State object config
747
747
  */
748
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
748
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
749
749
  /**
750
750
  * Fires when any other event is fired from the object.
751
751
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-catchAll)
@@ -433,7 +433,7 @@ export type BryntumLabelProps = {
433
433
  * @param {object} event Event object
434
434
  * @param {Core.widget.Widget} event.source The widget being hidden.
435
435
  */
436
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
436
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
437
437
  /**
438
438
  * Triggered before a widget is shown. Return `false` to prevent the action.
439
439
  * @param {object} event Event object
@@ -534,7 +534,7 @@ export type BryntumListProps = {
534
534
  * @param {object} event Event object
535
535
  * @param {Core.widget.Widget} event.source The widget being hidden.
536
536
  */
537
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
537
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
538
538
  /**
539
539
  * User going to activate an item in the list either by pointer or keyboard.
540
540
  * The active record, list item index, and the triggering event are passed.
@@ -546,7 +546,7 @@ export type BryntumListProps = {
546
546
  * @param {number} event.index List item index
547
547
  * @param {Event} event.event Triggering event
548
548
  */
549
- onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => Promise<boolean>|boolean|void)|string
549
+ onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
550
550
  /**
551
551
  * Triggered before a widget is shown. Return `false` to prevent the action.
552
552
  * @param {object} event Event object
@@ -715,7 +715,7 @@ export type BryntumMenuProps = {
715
715
  * @param {object} event Event object
716
716
  * @param {Core.widget.Widget} event.source The widget being hidden.
717
717
  */
718
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
718
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
719
719
  /**
720
720
  * Fired before this container will load record values into its child fields. This is useful if you
721
721
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -735,13 +735,13 @@ export type BryntumMenuProps = {
735
735
  * @param {object} event Event object
736
736
  * @param {any} event.state State object config
737
737
  */
738
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
738
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
739
739
  /**
740
740
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
741
741
  * @param {object} event Event object
742
742
  * @param {any} event.state State object config
743
743
  */
744
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
744
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
745
745
  /**
746
746
  * Fires when any other event is fired from the object.
747
747
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-catchAll)
@@ -643,7 +643,7 @@ export type BryntumMonthPickerProps = {
643
643
  * @param {object} event Event object
644
644
  * @param {Core.widget.Widget} event.source The widget being hidden.
645
645
  */
646
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
646
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
647
647
  /**
648
648
  * Fired before this container will load record values into its child fields. This is useful if you
649
649
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -663,13 +663,13 @@ export type BryntumMonthPickerProps = {
663
663
  * @param {object} event Event object
664
664
  * @param {any} event.state State object config
665
665
  */
666
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
666
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
667
667
  /**
668
668
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
669
669
  * @param {object} event Event object
670
670
  * @param {any} event.state State object config
671
671
  */
672
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
672
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
673
673
  /**
674
674
  * Fires when any other event is fired from the object.
675
675
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#event-catchAll)
@@ -89,6 +89,15 @@ export type BryntumNumberFieldProps = {
89
89
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
90
90
  */
91
91
  changeOnSpin? : boolean|number
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/NumberField#config-checkValidity)
97
+ * @param {Core.widget.Field} field The field being validated
98
+ * @returns {void}
99
+ */
100
+ checkValidity? : ((field: Field) => void)|string
92
101
  /**
93
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
94
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
@@ -652,7 +661,7 @@ export type BryntumNumberFieldProps = {
652
661
  * @param {object} event Event object
653
662
  * @param {Core.widget.Widget} event.source The widget being hidden.
654
663
  */
655
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
664
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
656
665
  /**
657
666
  * Triggered before a widget is shown. Return `false` to prevent the action.
658
667
  * @param {object} event Event object
@@ -801,6 +810,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
801
810
  'bubbleEvents',
802
811
  'centered',
803
812
  'changeOnSpin',
813
+ 'checkValidity',
804
814
  'clearable',
805
815
  'color',
806
816
  'config',
@@ -561,7 +561,7 @@ export type BryntumPagingToolbarProps = {
561
561
  * @param {object} event Event object
562
562
  * @param {Core.widget.Widget} event.source The widget being hidden.
563
563
  */
564
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
564
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
565
565
  /**
566
566
  * This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
567
567
  * a listener returns `false`.
@@ -570,7 +570,7 @@ export type BryntumPagingToolbarProps = {
570
570
  * @param {Core.widget.Widget} event.item The dragged item.
571
571
  * @param {Event} event.domEvent The browser event.
572
572
  */
573
- 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
574
574
  /**
575
575
  * Fired before this container will load record values into its child fields. This is useful if you
576
576
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -639,7 +639,7 @@ export type BryntumPanelProps = {
639
639
  * @param {object} event Event object
640
640
  * @param {Core.widget.Widget} event.source The widget being hidden.
641
641
  */
642
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
642
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
643
643
  /**
644
644
  * Fired before this container will load record values into its child fields. This is useful if you
645
645
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -659,13 +659,13 @@ export type BryntumPanelProps = {
659
659
  * @param {object} event Event object
660
660
  * @param {any} event.state State object config
661
661
  */
662
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
662
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
663
663
  /**
664
664
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
665
665
  * @param {object} event Event object
666
666
  * @param {any} event.state State object config
667
667
  */
668
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
668
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
669
669
  /**
670
670
  * Fires when any other event is fired from the object.
671
671
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
@@ -83,6 +83,15 @@ export type BryntumPasswordFieldProps = {
83
83
  * Set to `true` to centre the Widget in browser viewport space.
84
84
  */
85
85
  centered? : boolean
86
+ /**
87
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
88
+ * 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)
89
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
91
+ * @param {Core.widget.Field} field The field being validated
92
+ * @returns {void}
93
+ */
94
+ checkValidity? : ((field: Field) => void)|string
86
95
  /**
87
96
  * 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
97
  * 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
@@ -604,7 +613,7 @@ export type BryntumPasswordFieldProps = {
604
613
  * @param {object} event Event object
605
614
  * @param {Core.widget.Widget} event.source The widget being hidden.
606
615
  */
607
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
616
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
608
617
  /**
609
618
  * Triggered before a widget is shown. Return `false` to prevent the action.
610
619
  * @param {object} event Event object
@@ -752,6 +761,7 @@ export class BryntumPasswordField extends React.Component<BryntumPasswordFieldPr
752
761
  'autoSelect',
753
762
  'bubbleEvents',
754
763
  'centered',
764
+ 'checkValidity',
755
765
  'clearable',
756
766
  'color',
757
767
  'config',
@@ -452,7 +452,7 @@ export type BryntumProgressBarProps = {
452
452
  * @param {object} event Event object
453
453
  * @param {Core.widget.Widget} event.source The widget being hidden.
454
454
  */
455
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
455
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
456
456
  /**
457
457
  * Triggered before a widget is shown. Return `false` to prevent the action.
458
458
  * @param {object} event Event object
@@ -100,6 +100,15 @@ export type BryntumRadioProps = {
100
100
  * A value of `undefined` will cause this widget not to include its value when checked.
101
101
  */
102
102
  checkedValue? : any
103
+ /**
104
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
105
+ * 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)
106
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
107
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
108
+ * @param {Core.widget.Field} field The field being validated
109
+ * @returns {void}
110
+ */
111
+ checkValidity? : ((field: Field) => void)|string
103
112
  /**
104
113
  * Custom CSS classes to add to element.
105
114
  * May be specified as a space separated string, or as an object in which property names
@@ -610,7 +619,7 @@ export type BryntumRadioProps = {
610
619
  * @param {boolean} event.valid True if this field is in a valid state.
611
620
  * @param {Event} event.event The triggering DOM event if any
612
621
  */
613
- onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string
622
+ onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string
614
623
  /**
615
624
  * Fires before an object is destroyed.
616
625
  * @param {object} event Event object
@@ -622,7 +631,7 @@ export type BryntumRadioProps = {
622
631
  * @param {object} event Event object
623
632
  * @param {Core.widget.Widget} event.source The widget being hidden.
624
633
  */
625
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
634
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
626
635
  /**
627
636
  * Triggered before a widget is shown. Return `false` to prevent the action.
628
637
  * @param {object} event Event object
@@ -779,6 +788,7 @@ export class BryntumRadio extends React.Component<BryntumRadioProps> {
779
788
  'bubbleEvents',
780
789
  'centered',
781
790
  'checkedValue',
791
+ 'checkValidity',
782
792
  'color',
783
793
  'config',
784
794
  'constrainTo',
@@ -677,7 +677,7 @@ export type BryntumRadioGroupProps = {
677
677
  * @param {object} event Event object
678
678
  * @param {Core.widget.Widget} event.source The widget being hidden.
679
679
  */
680
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
680
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
681
681
  /**
682
682
  * Fired before this container will load record values into its child fields. This is useful if you
683
683
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -697,13 +697,13 @@ export type BryntumRadioGroupProps = {
697
697
  * @param {object} event Event object
698
698
  * @param {any} event.state State object config
699
699
  */
700
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
700
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
701
701
  /**
702
702
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
703
703
  * @param {object} event Event object
704
704
  * @param {any} event.state State object config
705
705
  */
706
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
706
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
707
707
  /**
708
708
  * Fires when any other event is fired from the object.
709
709
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#event-catchAll)
@@ -100,6 +100,15 @@ export type BryntumSlideToggleProps = {
100
100
  * A value of `undefined` will cause this widget not to include its value when checked.
101
101
  */
102
102
  checkedValue? : any
103
+ /**
104
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
105
+ * 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)
106
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
107
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
108
+ * @param {Core.widget.Field} field The field being validated
109
+ * @returns {void}
110
+ */
111
+ checkValidity? : ((field: Field) => void)|string
103
112
  /**
104
113
  * Custom CSS classes to add to element.
105
114
  * May be specified as a space separated string, or as an object in which property names
@@ -610,7 +619,7 @@ export type BryntumSlideToggleProps = {
610
619
  * @param {boolean} event.valid True if this field is in a valid state.
611
620
  * @param {Event} event.event The triggering DOM event if any
612
621
  */
613
- onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string
622
+ onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string
614
623
  /**
615
624
  * Fires before an object is destroyed.
616
625
  * @param {object} event Event object
@@ -622,7 +631,7 @@ export type BryntumSlideToggleProps = {
622
631
  * @param {object} event Event object
623
632
  * @param {Core.widget.Widget} event.source The widget being hidden.
624
633
  */
625
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
634
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
626
635
  /**
627
636
  * Triggered before a widget is shown. Return `false` to prevent the action.
628
637
  * @param {object} event Event object
@@ -779,6 +788,7 @@ export class BryntumSlideToggle extends React.Component<BryntumSlideToggleProps>
779
788
  'bubbleEvents',
780
789
  'centered',
781
790
  'checkedValue',
791
+ 'checkValidity',
782
792
  'color',
783
793
  'config',
784
794
  'constrainTo',
@@ -498,7 +498,7 @@ export type BryntumSliderProps = {
498
498
  * @param {object} event Event object
499
499
  * @param {Core.widget.Widget} event.source The widget being hidden.
500
500
  */
501
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
501
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
502
502
  /**
503
503
  * Triggered before a widget is shown. Return `false` to prevent the action.
504
504
  * @param {object} event Event object
@@ -440,7 +440,7 @@ export type BryntumSplitterProps = {
440
440
  * @param {object} event Event object
441
441
  * @param {Core.widget.Widget} event.source The widget being hidden.
442
442
  */
443
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
443
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
444
444
  /**
445
445
  * Triggered before a widget is shown. Return `false` to prevent the action.
446
446
  * @param {object} event Event object
@@ -664,7 +664,7 @@ export type BryntumTabPanelProps = {
664
664
  * @param {object} event Event object
665
665
  * @param {Core.widget.Widget} event.source The widget being hidden.
666
666
  */
667
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
667
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
668
668
  /**
669
669
  * Fired before this container will load record values into its child fields. This is useful if you
670
670
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -684,13 +684,13 @@ export type BryntumTabPanelProps = {
684
684
  * @param {object} event Event object
685
685
  * @param {any} event.state State object config
686
686
  */
687
- onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
687
+ onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
688
688
  /**
689
689
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
690
690
  * @param {object} event Event object
691
691
  * @param {any} event.state State object config
692
692
  */
693
- onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
693
+ onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
694
694
  /**
695
695
  * The active tab is about to be changed. Return `false` to prevent this.
696
696
  * @param {object} event Event object
@@ -699,7 +699,7 @@ export type BryntumTabPanelProps = {
699
699
  * @param {number} event.prevActiveIndex The previous active index.
700
700
  * @param {Core.widget.Widget} event.prevActiveItem The previous active child widget.
701
701
  */
702
- onBeforeTabChange? : ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => Promise<boolean>|boolean|void)|string
702
+ onBeforeTabChange? : ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => boolean|void)|string
703
703
  /**
704
704
  * Fires when any other event is fired from the object.
705
705
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#event-catchAll)