@bryntum/grid-vue-3-thin 7.3.0 → 7.3.2

package/src/components/BryntumChecklistFilterCombo.vue

@@ -43,6 +43,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -105,6 +107,15 @@ defineProps<{
      * 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/grid/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -398,10 +409,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -802,44 +817,36 @@ const emit = defineEmits<{
      * The default action was performed (an item in the list was selected)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Combo} params.params.event.source The combo
-     * @param {any} params.params.event.value The [value](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-valueField) of the selected record
-     * @param {Core.data.Model} params.params.event.record Selected record
-     * @param {Core.data.Model[]} params.params.event.records Selected records as an array if [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`
-     * @param {boolean} params.params.event.userAction `true` if the value change is due to user interaction
+     * @param {object} params.event Event object
+     * @param {Core.widget.Combo} params.event.source The combo
+     * @param {any} params.event.value The [value](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-valueField) of the selected record
+     * @param {Core.data.Model} params.event.record Selected record
+     * @param {Core.data.Model[]} params.event.records Selected records as an array if [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`
+     * @param {boolean} params.event.userAction `true` if the value change is due to user interaction
      */
     (e: 'action', params: ((event: { source: Combo, value: any, record: Model, records: Model[], userAction: boolean }) => void)|string): void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.Base} params.params.event.source The Object that is being destroyed.
+     * @param {object} params.event Event object
+     * @param {Core.Base} params.event.source The Object that is being destroyed.
      */
     (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
     /**
      * Triggered before a widget is hidden. Return `false` to prevent the action.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget being hidden.
      */
-    (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget,any} params.event.source The widget being shown
      */
     (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
@@ -847,27 +854,23 @@ const emit = defineEmits<{
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-catchAll)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
-     * @param {string} params.params.event.event.type The type of the event which is caught by the listener
+     * @param {object} params.event Event object
+     * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
+     * @param {string} params.event.event.type The type of the event which is caught by the listener
      */
     (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
     /**
      * Fired when this field's value changes.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Field,any} params.params.event.source This Field
-     * @param {string,number,boolean,any} params.params.event.value This field's value
-     * @param {string,number,boolean,any} params.params.event.oldValue This field's previous value
-     * @param {boolean} params.params.event.valid True if this field is in a valid state
-     * @param {Event} params.params.event.event The triggering DOM event if any
-     * @param {boolean} params.params.event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
-     * @param {boolean} params.params.event.checked
+     * @param {object} params.event Event object
+     * @param {Core.widget.Field,any} params.event.source This Field
+     * @param {string,number,boolean,any} params.event.value This field's value
+     * @param {string,number,boolean,any} params.event.oldValue This field's previous value
+     * @param {boolean} params.event.valid True if this field is in a valid state
+     * @param {Event} params.event.event The triggering DOM event if any
+     * @param {boolean} params.event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
+     * @param {boolean} params.event.checked
      */
     (e: 'change', params: ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, userAction: boolean, checked: boolean }) => void)|string): void
     /**
@@ -875,45 +878,37 @@ const emit = defineEmits<{
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-clear)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Field,any} params.params.event.source This Field
+     * @param {object} params.event Event object
+     * @param {Core.widget.Field,any} params.event.source This Field
      */
     (e: 'clear', params: ((event: { source: Field|any }) => void)|string): void
     /**
      * Fires when an object is destroyed.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.Base} params.params.event.source The Object that is being destroyed.
+     * @param {object} params.event Event object
+     * @param {Core.Base} params.event.source The Object that is being destroyed.
      */
     (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
     /**
      * Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {HTMLElement} params.params.event.element The Widget's element.
+     * @param {object} params.event Event object
+     * @param {HTMLElement} params.event.element The Widget's element.
      */
     (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
     /**
      * Fired when focus enters this Widget.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
-     * @param {HTMLElement} params.params.event.toElement The element which gained focus.
-     * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
-     * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
-     * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {HTMLElement} params.event.fromElement The element which lost focus.
+     * @param {HTMLElement} params.event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
+     * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
      */
     (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
     /**
@@ -922,25 +917,21 @@ const emit = defineEmits<{
      * will not trigger this event. This is when focus exits this widget completely.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
-     * @param {HTMLElement} params.params.event.toElement The element which gained focus.
-     * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
-     * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
-     * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {HTMLElement} params.event.fromElement The element which lost focus.
+     * @param {HTMLElement} params.event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
+     * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
      */
     (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
     /**
      * Triggered after a widget was hidden
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget
      */
     (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
     /**
@@ -948,12 +939,10 @@ const emit = defineEmits<{
      * not the combos value
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Combo} params.params.event.source The combo.
-     * @param {string} params.params.event.value Raw input value
-     * @param {Event} params.params.event.event The triggering DOM event if any.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Combo} params.event.source The combo.
+     * @param {string} params.event.value Raw input value
+     * @param {Event} params.event.event The triggering DOM event if any.
      */
     (e: 'input', params: ((event: { source: Combo, value: string, event: Event }) => void)|string): void
     /**
@@ -962,21 +951,17 @@ const emit = defineEmits<{
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-paint)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget being painted.
-     * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget being painted.
+     * @param {boolean} params.event.firstPaint `true` if this is the first paint.
      */
     (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
     /**
      * Fired when a Widget's read only state is toggled
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {boolean} params.params.event.readOnly Read only or not
+     * @param {object} params.event Event object
+     * @param {boolean} params.event.readOnly Read only or not
      */
     (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
     /**
@@ -988,48 +973,40 @@ const emit = defineEmits<{
      * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {number} params.params.event.width The new width
-     * @param {number} params.params.event.height The new height
-     * @param {number} params.params.event.oldWidth The old width
-     * @param {number} params.params.event.oldHeight The old height
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {number} params.event.width The new width
+     * @param {number} params.event.height The new height
+     * @param {number} params.event.oldWidth The old width
+     * @param {number} params.event.oldHeight The old height
      */
     (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
     /**
      * An item in the list was selected
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Combo} params.params.event.source The combo
-     * @param {Core.data.Model} params.params.event.record Selected record
-     * @param {Core.data.Model[]} params.params.event.records Selected records as an array if [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`
-     * @param {boolean} params.params.event.userAction `true` if the value change is due to user interaction
+     * @param {object} params.event Event object
+     * @param {Core.widget.Combo} params.event.source The combo
+     * @param {Core.data.Model} params.event.record Selected record
+     * @param {Core.data.Model[]} params.event.records Selected records as an array if [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`
+     * @param {boolean} params.event.userAction `true` if the value change is due to user interaction
      */
     (e: 'select', params: ((event: { source: Combo, record: Model, records: Model[], userAction: boolean }) => void)|string): void
     /**
      * Triggered after a widget is shown.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget
      */
     (e: 'show', params: ((event: { source: Widget }) => void)|string): void
     /**
      * User clicked one of this field's [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Field,any} params.params.event.source This field
-     * @param {Core.widget.Widget} params.params.event.trigger The trigger activated by click or touch tap.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Field,any} params.event.source This field
+     * @param {Core.widget.Widget} params.event.trigger The trigger activated by click or touch tap.
      */
     (e: 'trigger', params: ((event: { source: Field|any, trigger: Widget }) => void)|string): void
 }>();
@@ -1051,6 +1028,7 @@ const widgetData = {
         'cacheLastResult',
         'caseSensitive',
         'centered',
+        'checkValidity',
         'chipView',
         'clearable',
         'clearTextOnPickerHide',

package/src/components/BryntumChecklistFilterComboProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumChecklistFilterComboProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -90,6 +92,15 @@ export declare type BryntumChecklistFilterComboProps = {
      * 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/grid/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -383,10 +394,14 @@ export declare type BryntumChecklistFilterComboProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**