@bryntum/grid-vue-3 7.2.1 → 7.2.2

package/src/components/BryntumGroupBar.vue

@@ -538,7 +538,7 @@ defineProps<{
      */
     title ? : string
     /**
-     * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
+     * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
      */
     toggleAllIfCtrlPressed ? : Boolean
     /**

package/src/components/BryntumGroupBarProps.ts

@@ -524,7 +524,7 @@ export declare type BryntumGroupBarProps = {
      */
     title ? : string
     /**
-     * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
+     * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
      */
     toggleAllIfCtrlPressed ? : Boolean
     /**

package/src/components/BryntumHint.vue

@@ -113,7 +113,7 @@ defineProps<{
      */
     catchEventHandlerExceptions ? : Boolean
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**

package/src/components/BryntumHintProps.ts

@@ -99,7 +99,7 @@ export declare type BryntumHintProps = {
      */
     catchEventHandlerExceptions ? : Boolean
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**

package/src/components/BryntumList.vue

@@ -518,7 +518,7 @@ defineProps<{
      */
     title ? : string
     /**
-     * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
+     * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
      */
     toggleAllIfCtrlPressed ? : Boolean
     /**

package/src/components/BryntumListProps.ts

@@ -504,7 +504,7 @@ export declare type BryntumListProps = {
      */
     title ? : string
     /**
-     * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
+     * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
      */
     toggleAllIfCtrlPressed ? : Boolean
     /**

package/src/components/BryntumMenu.vue

@@ -133,7 +133,7 @@ defineProps<{
      */
     closeAction ? : 'hide'|'destroy'
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**

package/src/components/BryntumMenuProps.ts

@@ -119,7 +119,7 @@ export declare type BryntumMenuProps = {
      */
     closeAction ? : 'hide'|'destroy'
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**

package/src/components/BryntumNumberField.vue

@@ -530,7 +530,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumNumberFieldProps.ts

@@ -516,7 +516,7 @@ export declare type BryntumNumberFieldProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumPasswordField.vue

@@ -491,7 +491,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumPasswordFieldProps.ts

@@ -477,7 +477,7 @@ export declare type BryntumPasswordFieldProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumRadio.vue

@@ -488,7 +488,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumRadioProps.ts

@@ -474,7 +474,7 @@ export declare type BryntumRadioProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumSlideToggle.vue

@@ -488,7 +488,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumSlideToggleProps.ts

@@ -474,7 +474,7 @@ export declare type BryntumSlideToggleProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumSlider.vue

@@ -499,7 +499,7 @@ defineProps<{
     unit ? : string
     /**
      * Initial value.
-     * `String` value allows to link value by reference name.
+     * `String` value allows linking value by reference name.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-value)
      */

package/src/components/BryntumSliderProps.ts

@@ -485,7 +485,7 @@ export declare type BryntumSliderProps = {
     unit ? : string
     /**
      * Initial value.
-     * `String` value allows to link value by reference name.
+     * `String` value allows linking value by reference name.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-value)
      */

package/src/components/BryntumTextAreaField.vue

@@ -501,7 +501,7 @@ defineProps<{
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaFieldProps.ts

@@ -487,7 +487,7 @@ export declare type BryntumTextAreaFieldProps = {
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaPickerField.vue

@@ -516,7 +516,7 @@ defineProps<{
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaPickerFieldProps.ts

@@ -502,7 +502,7 @@ export declare type BryntumTextAreaPickerFieldProps = {
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTextField.vue

@@ -505,7 +505,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTextFieldProps.ts

@@ -491,7 +491,7 @@ export declare type BryntumTextFieldProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTimeField.vue

@@ -542,7 +542,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTimeFieldProps.ts

@@ -528,7 +528,7 @@ export declare type BryntumTimeFieldProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTreeCombo.vue

@@ -189,7 +189,7 @@ defineProps<{
     contentElementCls ? : string|object
     /**
      * If configured as `true`, this means that when an unmatched string is typed into the
-     * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
+     * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
      * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -684,7 +684,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTreeComboProps.ts

@@ -175,7 +175,7 @@ export declare type BryntumTreeComboProps = {
     contentElementCls ? : string|object
     /**
      * If configured as `true`, this means that when an unmatched string is typed into the
-     * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
+     * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
      * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -670,7 +670,7 @@ export declare type BryntumTreeComboProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTreeGrid.vue

@@ -590,7 +590,7 @@ defineProps<{
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -818,7 +818,7 @@ defineProps<{
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
      */
@@ -918,8 +918,8 @@ defineProps<{
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -1108,7 +1108,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {string} e Event name
      * @param {object} params Event parameters
@@ -2044,7 +2044,7 @@ const emit = defineEmits<{
      * @param {Response} params.event.response Optional response, if received
      * @param {Error} params.event.error Optional error, if exception occurred
      */
-    (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
+    (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
     /**
      * Fired when a Widget's read only state is toggled
      * @param {string} e Event name
@@ -2305,6 +2305,16 @@ const emit = defineEmits<{
      * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
      */
     (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.Grid} params.event.source The grid instance
+     * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
     /**
      * Fires when row locking is disabled.
      * @param {string} e Event name
@@ -2597,6 +2607,7 @@ const widgetData = {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'preserveScroll',
@@ -2746,6 +2757,7 @@ const widgetData = {
         'toggleGroup',
         'toggleNode',
         'toolClick',
+        'treeGroup',
         'unlockRows',
         'unsplit'
     ]

package/src/components/BryntumTreeGridProps.ts

@@ -553,7 +553,7 @@ export declare type BryntumTreeGridProps = {
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -781,7 +781,7 @@ export declare type BryntumTreeGridProps = {
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
      */
@@ -881,8 +881,8 @@ export declare type BryntumTreeGridProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)