@bryntum/core-react-thin 7.3.0 → 7.3.1

package/src/BryntumTextAreaField.tsx

@@ -89,6 +89,15 @@ export type BryntumTextAreaFieldProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered? : boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * 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)
+     * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity? : ((field: Field) => void)|string
     /**
      * 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
      * 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
@@ -619,7 +628,7 @@ export type BryntumTextAreaFieldProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object
@@ -768,6 +777,7 @@ export class BryntumTextAreaField extends React.Component<BryntumTextAreaFieldPr
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/BryntumTextAreaPickerField.tsx

@@ -87,6 +87,15 @@ export type BryntumTextAreaPickerFieldProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered? : boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * 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)
+     * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity? : ((field: Field) => void)|string
     /**
      * 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
      * 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
@@ -628,7 +637,7 @@ export type BryntumTextAreaPickerFieldProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object
@@ -777,6 +786,7 @@ export class BryntumTextAreaPickerField extends React.Component<BryntumTextAreaP
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/BryntumTextField.tsx

@@ -83,6 +83,15 @@ export type BryntumTextFieldProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered? : boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * 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)
+     * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity? : ((field: Field) => void)|string
     /**
      * 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
      * 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
@@ -617,7 +626,7 @@ export type BryntumTextFieldProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object
@@ -765,6 +774,7 @@ export class BryntumTextField extends React.Component<BryntumTextFieldProps> {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/BryntumTimeField.tsx

@@ -87,6 +87,15 @@ export type BryntumTimeFieldProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered? : boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * 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)
+     * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity? : ((field: Field) => void)|string
     /**
      * 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
      * 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
@@ -669,7 +678,7 @@ export type BryntumTimeFieldProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object
@@ -818,6 +827,7 @@ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/BryntumTimePicker.tsx

@@ -553,7 +553,7 @@ export type BryntumTimePickerProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Fired before this container will load record values into its child fields. This is useful if you
      * want to modify the UI before data is loaded (e.g. set some input field to be readonly)

package/src/BryntumToolbar.tsx

@@ -555,7 +555,7 @@ export type BryntumToolbarProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
      * a listener returns `false`.
@@ -564,7 +564,7 @@ export type BryntumToolbarProps = {
      * @param {Core.widget.Widget} event.item The dragged item.
      * @param {Event} event.domEvent The browser event.
      */
-    onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => Promise<boolean>|boolean|void)|string
+    onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string
     /**
      * Fired before this container will load record values into its child fields. This is useful if you
      * want to modify the UI before data is loaded (e.g. set some input field to be readonly)

package/src/BryntumWidget.tsx

@@ -429,7 +429,7 @@ export type BryntumWidgetProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object

package/src/BryntumYearPicker.tsx

@@ -659,7 +659,7 @@ export type BryntumYearPickerProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Fired before this container will load record values into its child fields. This is useful if you
      * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -679,13 +679,13 @@ export type BryntumYearPickerProps = {
      * @param {object} event Event object
      * @param {any} event.state State object config
      */
-    onBeforeStateApply? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
+    onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
     /**
      * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
      * @param {object} event Event object
      * @param {any} event.state State object config
      */
-    onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
+    onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
     /**
      * Fires when any other event is fired from the object.
      * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#event-catchAll)