@progress/kendo-vue-treelist 5.3.0-dev.202410141143 → 5.3.0-develop.2

package/dist/npm/interfaces/TreeListProps.d.ts

@@ -1,345 +0,0 @@
-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 `medium`
-     */
-    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.
-     */
-    /**
-     * @hidden
-     */
-    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 %})).
-     */
-    /**
-     * @hidden
-     */
-    selectedField?: string;
-    /**
-     * Fires when the user tries to select or deselect a row or cell.
-     * ([more information and example]({% slug selection_treelist %})).
-     */
-    /**
-     * @hidden
-     */
-    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 %})).
-     */
-    /**
-     * @hidden
-     */
-    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 %})).
-     */
-    /**
-     * @hidden
-     */
-    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.
-     */
-    /**
-     * @hidden
-     */
-    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.
-     */
-    /**
-     * @hidden
-     */
-    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.
-     */
-    /**
-     * @hidden
-     */
-    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/dist/npm/interfaces/TreeListProps.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/npm/interfaces/TreeListRowProps.d.ts

@@ -1,92 +0,0 @@
-/**
- * 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/dist/npm/interfaces/TreeListRowProps.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/npm/interfaces/TreeListSelectableSettings.d.ts

@@ -1,18 +0,0 @@
-import { TableSelectableMode, TableSelectableSettings } from '@progress/kendo-vue-data-tools';
-/**
- * Represents the available selection modes.
- */
-export declare type TreeListSelectableMode = TableSelectableMode;
-/**
- * Represents the TreeList selectable settings.
- */
-export interface TreeListSelectableSettings extends TableSelectableSettings {
-    /**
-     * The available values are:
-     * * `single`
-     * * `multiple`
-     *
-     * @default "multiple"
-     */
-    mode?: TreeListSelectableMode;
-}

package/dist/npm/interfaces/TreeListSelectableSettings.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/npm/interfaces/TreeListSortSettings.d.ts

@@ -1,9 +0,0 @@
-import { ColumnSortSettings, SortSettings } from '@progress/kendo-vue-data-tools';
-/**
- * The settings for sorting the TreeList columns.
- */
-export declare type TreeListColumnSortSettings = ColumnSortSettings;
-/**
- * The settings for sorting the TreeList data.
- */
-export declare type TreeListSortSettings = SortSettings;

package/dist/npm/interfaces/TreeListSortSettings.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/npm/interfaces/TreeListToolbarProps.d.ts

@@ -1,5 +0,0 @@
-/**
- * The props of the TreeListToolbar component.
- */
-export interface TreeListToolbarProps {
-}

package/dist/npm/interfaces/TreeListToolbarProps.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});