@progress/kendo-vue-treelist 8.0.3-develop.2 → 8.0.3-develop.4

package/interfaces/DataItemWrapper.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * @hidden
+ */
+export interface DataItemWrapper {
+    dataItem: any;
+    level: number[];
+    height: number;
+    offsetTop: number;
+    levelCount: number;
+}

package/interfaces/TreeListCellProps.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { CellProps } from '@progress/kendo-vue-data-tools';
+/**
+ * Represents the props of the TreeListCell component.
+ */
+export interface TreeListCellProps extends CellProps {
+    /**
+     * An array of indexes of each parent and current item in the data tree.
+     */
+    level: number[];
+    /**
+     * Indicates that the data item of the cell has subitems.
+     */
+    hasChildren?: boolean;
+    /**
+     * If set to `true`, the cell will render indentation based on its level prop and
+     * the icons that are used for expanding and collapsing child rows.
+     */
+    expandable?: boolean;
+    /**
+     * The index of the column. Useful for applying `aria-colindex` accessibility attribute.
+     */
+    colIndex: number;
+    /**
+     * The event that is fired when the expand or collapse icon of the cell is clicked.
+     */
+    onExpandchange?: (event: any, dataItem: any, level: number[]) => void;
+    /**
+     * A function for overriding the default rendering of the cell.
+     */
+    render?: any;
+    /**
+     * If set to true will focus the first input inside the cell.
+     */
+    focusInputOnMount?: boolean;
+    /**
+     * The dataItem of the cell.
+     */
+    dataItem: any;
+    /**
+     * The field of the cell.
+     */
+    field: string;
+    /**
+     * The format of the cell.
+     */
+    format?: string;
+    /**
+     * The column span of the cell.
+     */
+    colSpan?: number;
+    /**
+     * The expanded state of the cell.
+     */
+    expanded?: boolean;
+}

package/interfaces/TreeListColumnProps.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TreeColumnBaseProps } from '@progress/kendo-vue-data-tools';
+/**
+ * The props of the columns of the TreeList component.
+ */
+export interface TreeListColumnProps extends TreeColumnBaseProps {
+    /**
+     * Defines the component that will be rendered as a cell. If not set, a `TreeListCell` will be rendered by default.
+     */
+    cell?: any;
+    /**
+     * Defines the component that will be rendered as an edit cell.
+     */
+    editCell?: any;
+    /**
+     * Defines the component that will be rendered as a header cell.
+     * If not set, a `TreeListHeaderCell` will be rendered by default.
+     */
+    headerCell?: any;
+    /**
+     * Defines the component that will be rendered as a filter cell.
+     */
+    filterCell?: any;
+    /**
+     * A collection of child columns.
+     */
+    children?: TreeListColumnProps[];
+    /**
+     * Defines if the column is locked (frozen or sticky).
+     * Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
+     * Defaults to `false`.
+     */
+    locked?: boolean;
+}

package/interfaces/TreeListFilterCellProps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { FilterCellProps } from '@progress/kendo-vue-data-tools';
+/**
+ * @hidden
+ */
+export interface TreeListFilterCellProps extends FilterCellProps {
+}

package/interfaces/TreeListFilterOperator.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { FilterOperator } from '@progress/kendo-vue-data-tools';
+/**
+ * The filter operator for the TreeList filters.
+ */
+export interface TreeListFilterOperator extends FilterOperator {
+    operator: string;
+    text: string;
+}

package/interfaces/TreeListHeaderCellProps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { HeaderCellProps } from '@progress/kendo-vue-data-tools';
+/**
+ * The props of the TreeListHeaderCell component.
+ */
+export interface TreeListHeaderCellProps extends HeaderCellProps {
+}

package/interfaces/TreeListProps.d.ts

@@ -0,0 +1,329 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { SortDescriptor, FilterDescriptor, CompositeFilterDescriptor } from '@progress/kendo-data-query';
+import { TreeListSortChangeEvent, TreeListFilterChangeEvent, TreeListExpandChangeEvent, TreeListSelectionChangeEvent, TreeListHeaderSelectionChangeEvent, TreeListItemChangeEvent, TreeListDataStateChangeEvent, TreeListRowClickEvent, TreeListColumnResizeEvent, TreeListColumnReorderEvent, TreeListPageChangeEvent, TreeListRowDragEvent, TreeListColumnMenuFilterChangeEvent, TreeListRowDoubleClickEvent, TreeListRowContextMenuEvent, TreeListKeyDownEvent, TreeListRowEvent } from './events';
+import { ScrollMode } from '../ScrollMode';
+import { SortSettings as TreeListSortSettings, FilterOperators } from '@progress/kendo-vue-data-tools';
+import { TreeListColumnProps } from './TreeListColumnProps';
+import { TreeListSelectableSettings } from './TreeListSelectableSettings';
+/**
+ * Represents the props of the [Kendo UI for Vue TreeList component]({% slug get_started_treelist %}).
+ */
+export interface TreeListProps {
+    /**
+     * Sets the TreeList row key prop to the value of this field in the dataItem.
+     * If not set, the dataItem index will be used for the row key, which might lead to row not updated during paging or scrolling.
+     */
+    dataItemKey?: string;
+    /**
+     * A collection of `TreeListColumnProps` for creating columns.
+     */
+    columns?: TreeListColumnProps[];
+    /**
+     * Enables the virtualization of the columns
+     * ([see example]({% slug virtual_columns_treelist %})).
+     * If enabled, the columns outside the viewport are not rendered.
+     */
+    columnVirtualization?: boolean;
+    /**
+     * Sets the data of the TreeList.
+     */
+    dataItems?: any[];
+    /**
+     * Enables sorting ([see example]({% slug sorting_treelist %})).
+     */
+    sortable?: TreeListSortSettings;
+    /**
+     * Fires when the sorting of the TreeList is changed ([see example]({% slug sorting_treelist %})).
+     * You have to handle the event yourself and sort the data.
+     */
+    onSortchange?: (event: TreeListSortChangeEvent) => void;
+    /**
+     * The descriptors by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
+     */
+    sort?: SortDescriptor[];
+    /**
+     * If set, it will be rendered instead of the default `FilterRow` TreeList component.
+     */
+    filterRow?: any;
+    /**
+     * If set and when the data item is in edit mode, the `editRow` value will be rendered.
+     */
+    /**
+     * @hidden
+     */
+    editRow?: any;
+    /**
+     * Configures the `size` of the TreeList.
+     *
+     * The available options are:
+     * - small
+     * - medium
+     *
+     * @default `undefined`
+     */
+    size?: 'small' | 'medium' | string;
+    /**
+     * Represents the TreeList toolbar component.
+     */
+    toolbar?: any;
+    /**
+     * Represents the component that will be rendered when the `data` property of the TreeList is empty or undefined.
+     */
+    noRecords?: any;
+    /**
+     * The descriptors by which the data is filtered ([more information and examples]({% slug filtering_treelist %})).
+     * This affects the values and buttons in the `FilterRow` of the TreeList.
+     */
+    filter?: FilterDescriptor[];
+    /**
+     * Enables the filtering of the columns with their `field` option set
+     */
+    filterable?: boolean;
+    /**
+     * The filter operators for the filters.
+     */
+    filterOperators?: FilterOperators;
+    /**
+     * Fires when the TreeList filter is modified through the UI
+     * ([more information and examples]({% slug filtering_treelist %})).
+     * You have to handle the event yourself and filter the data.
+     */
+    onFilterchange?: (event: TreeListFilterChangeEvent) => void;
+    /**
+     * Fires when the user clicks on the expand or collapse icon of a row.
+     */
+    onExpandchange?: (event: TreeListExpandChangeEvent) => void;
+    /**
+     * Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
+     */
+    expandField?: string;
+    /**
+     * Specifies the name of the field which will provide an array representation of the item subitems.
+     */
+    subItemsField?: string;
+    /**
+     * The TreeList selectable settings.
+     */
+    selectable?: TreeListSelectableSettings;
+    /**
+     * Specifies the name of the field which will provide a Boolean representation of the selected state of the item
+     * ([see example]({% slug selection_treelist %})).
+     */
+    selectedField?: string;
+    /**
+     * Fires when the user tries to select or deselect a row or cell.
+     * ([more information and example]({% slug selection_treelist %})).
+     */
+    onSelectionchange?: (event: TreeListSelectionChangeEvent) => void;
+    /**
+     * Fires when the user press keyboard key.
+     */
+    onKeyDown?: (event: TreeListKeyDownEvent) => void;
+    /**
+     * Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField`
+     * ([more information and example]({% slug selection_treelist %})).
+     */
+    /**
+     * @hidden
+     */
+    onHeaderselectionchange?: (event: TreeListHeaderSelectionChangeEvent) => void;
+    /**
+     * Fires when the user changes the values of the item.
+     * The event is not debounced and fires on every `onChange` event of the input in the current `EditCell`
+     * ([more information and examples]({% slug editing_inline_treelist %})).
+     */
+    onItemchange?: (event: TreeListItemChangeEvent) => void;
+    /**
+     * Fires when the user clicks a row.
+     */
+    onRowclick?: (event: TreeListRowClickEvent) => void;
+    /**
+     * Fires when the user double clicks a row.
+     */
+    /**
+     * @hidden
+     */
+    onRowdoubleclick?: (event: TreeListRowDoubleClickEvent) => void;
+    /**
+     * Fires when the user trigger the context menu of row.
+     */
+    onRowcontextmenu?: (event: TreeListRowContextMenuEvent) => void;
+    /**
+     * Fires when the mouse down is triggered on a row.
+     */
+    /**
+     * @hidden
+     */
+    onRowmousedown?: (event: TreeListRowEvent) => void;
+    /**
+     * Fires when the mouse up is triggered on a row.
+     */
+    /**
+     * @hidden
+     */
+    onRowmouseup?: (event: TreeListRowEvent) => void;
+    /**
+     * Fires when focus event is triggered on a row.
+     */
+    onRowfocus?: (event: TreeListRowEvent) => void;
+    /**
+     * Fires when blur event is triggered on a row.
+     */
+    onRowblur?: (event: TreeListRowEvent) => void;
+    /**
+     * Specifies the name of the field which will provide a Boolean representation of the edit state of the current item
+     * ([more information and examples]({% slug editing_inline_treelist %})).
+     */
+    editField?: string;
+    /**
+     * Defines the scroll mode of the TreeList.
+     *
+     * The available options are:
+     * - `none`—Renders no scrollbar.
+     * - `scrollable`—Represents the default scroll mode of the TreeList.
+     * Requires you to set the `overflow` and `height` (for vertical scrolling),
+     * or `width` (for horizontal scrolling) styles.
+     * - `virtual`—Enables the vertical virtual scrolling of the TreeList.
+     * Requires you to set the `overflow` and `height` styles and `rowHeight` prop of the TreeList.
+     */
+    scrollable?: ScrollMode | string;
+    /**
+     * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells.
+     */
+    /**
+     * @hidden
+     */
+    resizable?: boolean;
+    /**
+     * If set to `true`, the user can reorder columns by dragging their header cells.
+     */
+    reorderable?: boolean;
+    /**
+     * If set to `true`, the user can drag and drop rows.
+     */
+    /**
+     * @hidden
+     */
+    rowDraggable?: boolean;
+    /**
+     * Defines the row height and implements equal heights for all rows.
+     */
+    rowHeight?: number;
+    /**
+     * A props object that will be passed to the underlying HTML table.
+     */
+    tableProps?: any;
+    /**
+     * Configures the pager of the TreeList.
+     *
+     * The available options are:
+     * - `buttonCount: Number`—Sets the maximum numeric buttons count before the buttons are collapsed.
+     * - `info: Boolean`—Toggles the information about the current page and the total number of records.
+     * - `type: PagerType`—Accepts the `numeric` (buttons with numbers)
+     * and `input` (input for typing the page number) values.
+     * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size.
+     * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons.
+     */
+    pageable?: any;
+    /**
+     * A function that returns a custom class applied to the row.
+     *
+     * @param item - the item for the row.
+     */
+    rowClass?: Function;
+    /**
+     * @hidden
+     */
+    columnMenu?: any;
+    /**
+     * @hidden
+     */
+    columnMenuFilter?: CompositeFilterDescriptor[];
+    /**
+     * @hidden
+     */
+    onColumnmenufilterchange?: (event: TreeListColumnMenuFilterChangeEvent) => void;
+    /**
+     * The pager component that the TreeList will render.
+     */
+    pager?: any;
+    /**
+     * The number of records that will be skipped.
+     */
+    skip?: number;
+    /**
+     * The number of records that will be taken.
+     */
+    take?: number;
+    /**
+     * The styles of the wrapper component.
+     */
+    wrapperStyle?: Object;
+    /**
+     * The TreeList row component.
+     */
+    /**
+     * @hidden
+     */
+    row?: any;
+    /**
+     * If set to `true`, the rows of the TreeList can be reordered.
+     */
+    reordableRows?: boolean;
+    /**
+     * If set to `true`, the user can use dedicated shortcuts to interact with the TreeList.
+     * By default, navigation is disabled and the TreeList content is accessible in the normal tab sequence.
+     */
+    navigatable?: boolean;
+    /**
+     * Fires when the page of the TreeList is changed.
+     */
+    onPagechange?: (event: TreeListPageChangeEvent) => void;
+    /**
+     * Fires when the data state of the TreeList is changed.
+     */
+    onDatastatechange?: (event: TreeListDataStateChangeEvent) => void;
+    /**
+     * Fires when a column is resized.
+     */
+    /**
+     * @hidden
+     */
+    onColumnresize?: (event: TreeListColumnResizeEvent) => void;
+    /**
+     * Fires when the columns are reordered.
+     */
+    onColumnreorder?: (event: TreeListColumnReorderEvent) => void;
+    /**
+     * Fires when a row is dragged.
+     */
+    /**
+     * @hidden
+     */
+    onRowdrag?: (event: TreeListRowDragEvent) => void;
+    /**
+     * Fires when a row is dragged and dropped.
+     */
+    /**
+     * @hidden
+     */
+    onRowdrop?: (event: TreeListRowDragEvent) => void;
+    /**
+     * Fires when a row is about to be rendered. Useful for overriding the default rendering of the row.
+     */
+    rowRender?: any;
+    /**
+     * Fires when a cell is about to be rendered. Useful for overriding the default rendering of the cell.
+     */
+    cellRender?: any;
+    /**
+     * Fires when a header cell is about to be rendered. Useful for overriding the default rendering of the header cell.
+     */
+    headerCellRender?: any;
+}

package/interfaces/TreeListRowProps.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The props that the TreeList passes to the TreeListRow component when creating it.
+ * Accessible during the `rowRender` callback of the TreeList.
+ */
+export interface TreeListRowProps {
+    /**
+     * The class that is applied to the row.
+     */
+    className: string;
+    /**
+     * The `data` object that represents the current row.
+     */
+    dataItem: any;
+    /**
+     * The event that is fired when the row is clicked.
+     */
+    onClick?: any;
+    /**
+     * The event that is fired when the row is double clicked.
+     */
+    onDoubleClick?: any;
+    /**
+     * The event that is fired when the row context menu is triggered.
+     */
+    onContextmenu?: any;
+    /**
+     * The name of the field which will provide a Boolean representation of the selected state of the item.
+     */
+    selectedField?: string;
+    /**
+     * Sets the height of the row.
+     */
+    rowHeight?: number;
+    /**
+     * A function for overriding the default rendering of the row.
+     */
+    render?: any;
+    /**
+     * An array of indexes of each parent and current item in the data tree.
+     */
+    level: number[];
+    /**
+     * Fires when a row is dragged.
+     */
+    onDrag?: (event: {
+        nativeEvent: any;
+        dragged: number[];
+        draggedOver: number[] | null;
+        draggedItem: any;
+    }) => void;
+    /**
+     * Fires when a row is dragged and dropped.
+     */
+    onDrop?: (event: {
+        nativeEvent: any;
+        dragged: number[];
+        draggedOver: number[] | null;
+        draggedItem: any;
+    }) => void;
+    /**
+     * The expanded state of the row. Useful for applying `aria-expanded` accessibility attribute.
+     */
+    expanded: boolean;
+    /**
+     * The index of the row. Useful for applying `aria-rowindex` accessibility attribute.
+     */
+    rowIndex: number;
+    /**
+     * @hidden
+     */
+    levels: number[][];
+    /**
+     * @hidden
+     */
+    isAltRow?: boolean;
+    /**
+     * The index to be applied to the `aria-rowindex` attribute.
+     */
+    ariaRowIndex?: number;
+    /**
+     * The count of items on current level, applied to the `aria-setsize` attribute.
+     */
+    ariaSetSize?: number;
+    /**
+     * The index of the item on current level, applied to the `aria-posinset` attribute.
+     */
+    ariaPosInSet?: number;
+    /**
+     * Indicates if the row is selected.
+     */
+    isSelected: boolean;
+}

package/interfaces/TreeListSelectableSettings.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TableSelectableMode, TableSelectableSettings } from '@progress/kendo-vue-data-tools';
+/**
+ * Represents the available selection modes.
+ */
+export type TreeListSelectableMode = TableSelectableMode;
+/**
+ * Represents the TreeList selectable settings.
+ */
+export interface TreeListSelectableSettings extends TableSelectableSettings {
+    /**
+     * The available values are:
+     * * `single`
+     * * `multiple`
+     *
+     * @default "multiple"
+     */
+    mode?: TreeListSelectableMode;
+}

package/interfaces/TreeListSortSettings.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ColumnSortSettings, SortSettings } from '@progress/kendo-vue-data-tools';
+/**
+ * The settings for sorting the TreeList columns.
+ */
+export type TreeListColumnSortSettings = ColumnSortSettings;
+/**
+ * The settings for sorting the TreeList data.
+ */
+export type TreeListSortSettings = SortSettings;

package/interfaces/TreeListToolbarProps.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The props of the TreeListToolbar component.
+ */
+export interface TreeListToolbarProps {
+}