@progress/kendo-react-treelist 13.3.0-develop.9 → 13.4.0-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ScrollMode.d.ts +8 -0
- package/TreeList.d.ts +145 -0
- package/TreeList.js +1 -1
- package/TreeList.mjs +11 -11
- package/TreeListNoRecords.d.ts +19 -0
- package/TreeListToolbar.d.ts +29 -0
- package/cells/EditCells/TreeListBooleanEditor.d.ts +15 -0
- package/cells/EditCells/TreeListBooleanEditor.js +1 -1
- package/cells/EditCells/TreeListBooleanEditor.mjs +11 -11
- package/cells/EditCells/TreeListDateEditor.d.ts +15 -0
- package/cells/EditCells/TreeListNumericEditor.d.ts +15 -0
- package/cells/EditCells/TreeListTextEditor.d.ts +15 -0
- package/cells/FilterCells/TreeListBooleanFilter.d.ts +17 -0
- package/cells/FilterCells/TreeListDateFilter.d.ts +17 -0
- package/cells/FilterCells/TreeListNumericFilter.d.ts +17 -0
- package/cells/FilterCells/TreeListTextFilter.d.ts +17 -0
- package/cells/FilterCells/utils.d.ts +45 -0
- package/cells/FilterCells/utils.mjs +3 -3
- package/cells/TreeListCell.d.ts +13 -0
- package/cells/TreeListSelectionCell.d.ts +15 -0
- package/cells/TreeListSelectionCell.js +1 -1
- package/cells/TreeListSelectionCell.mjs +1 -1
- package/codemods/utils.js +1 -8
- package/codemods/v11/toolbar-handle.js +1 -8
- package/constants/index.d.ts +13 -0
- package/constants/index.mjs +2 -2
- package/dist/cdn/js/kendo-react-treelist.js +1 -1
- package/header/TreeListHeaderCell.d.ts +10 -0
- package/header/TreeListHeaderSelectionCell.d.ts +18 -0
- package/index.d.mts +33 -1192
- package/index.d.ts +33 -1192
- package/interfaces/DataItemWrapper.d.ts +17 -0
- package/interfaces/TreeListCellProps.d.ts +48 -0
- package/interfaces/TreeListColumnProps.d.ts +48 -0
- package/interfaces/TreeListFilterCellProps.d.ts +13 -0
- package/interfaces/TreeListFilterOperator.d.ts +13 -0
- package/interfaces/TreeListHeaderCellProps.d.ts +13 -0
- package/interfaces/TreeListNoRecordsProps.d.ts +16 -0
- package/interfaces/TreeListProps.d.ts +285 -0
- package/interfaces/TreeListRowProps.d.ts +99 -0
- package/interfaces/TreeListSelectableSettings.d.ts +25 -0
- package/interfaces/TreeListSortSettings.d.ts +16 -0
- package/interfaces/TreeListToolbarProps.d.ts +17 -0
- package/interfaces/events.d.ts +272 -0
- package/messages/index.d.ts +127 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +10 -16
- package/package.json +9 -9
- package/rows/TreeListDraggableRow.d.ts +39 -0
- package/rows/TreeListDraggableRow.js +1 -1
- package/rows/TreeListDraggableRow.mjs +5 -5
- package/rows/TreeListRow.d.ts +13 -0
- package/utils/index.d.ts +24 -0
package/index.d.ts
CHANGED
|
@@ -5,1195 +5,36 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
23
|
-
import {
|
|
24
|
-
import {
|
|
25
|
-
import {
|
|
26
|
-
import {
|
|
27
|
-
import {
|
|
28
|
-
import {
|
|
29
|
-
import {
|
|
30
|
-
import {
|
|
31
|
-
import {
|
|
32
|
-
import {
|
|
33
|
-
import {
|
|
34
|
-
import {
|
|
35
|
-
import
|
|
36
|
-
import {
|
|
37
|
-
import {
|
|
38
|
-
import {
|
|
39
|
-
import {
|
|
40
|
-
|
|
41
|
-
import { TableKeyboardNavigationContextType } from '@progress/kendo-react-data-tools';
|
|
42
|
-
import { TableKeyDownEvent } from '@progress/kendo-react-data-tools';
|
|
43
|
-
import { TableSelectableMode } from '@progress/kendo-react-data-tools';
|
|
44
|
-
import { TableSelectableSettings } from '@progress/kendo-react-data-tools';
|
|
45
|
-
import { TableSelectionChangeEvent } from '@progress/kendo-react-data-tools';
|
|
46
|
-
import { ToolbarProps } from '@progress/kendo-react-buttons';
|
|
47
|
-
import { TreeColumnBaseProps } from '@progress/kendo-react-data-tools';
|
|
48
|
-
import { treeToFlat } from '@progress/kendo-react-data-tools';
|
|
49
|
-
|
|
50
|
-
declare interface ColumnDragEvent {
|
|
51
|
-
/**
|
|
52
|
-
* An event target.
|
|
53
|
-
*/
|
|
54
|
-
target: TreeList;
|
|
55
|
-
/**
|
|
56
|
-
* A native DOM event.
|
|
57
|
-
*/
|
|
58
|
-
nativeEvent: any;
|
|
59
|
-
/**
|
|
60
|
-
* The current columns collection.
|
|
61
|
-
*/
|
|
62
|
-
columns: TreeListColumnProps[];
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
export { createDataTree }
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
* @hidden
|
|
69
|
-
*/
|
|
70
|
-
export declare interface DataItemWrapper {
|
|
71
|
-
dataItem: any;
|
|
72
|
-
level: number[];
|
|
73
|
-
height: number;
|
|
74
|
-
offsetTop: number;
|
|
75
|
-
levelCount: number;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export { extendDataItem }
|
|
79
|
-
|
|
80
|
-
export { filterBy }
|
|
81
|
-
|
|
82
|
-
export { flatData }
|
|
83
|
-
|
|
84
|
-
export { getItemPath }
|
|
85
|
-
|
|
86
|
-
export { getNestedValue }
|
|
87
|
-
|
|
88
|
-
export { getSelectedState }
|
|
89
|
-
|
|
90
|
-
export { getSelectedStateFromKeyDown }
|
|
91
|
-
|
|
92
|
-
export { mapTree }
|
|
93
|
-
|
|
94
|
-
export { mapTreeItem }
|
|
95
|
-
|
|
96
|
-
export { modifySubItems }
|
|
97
|
-
|
|
98
|
-
export { moveTreeItem }
|
|
99
|
-
|
|
100
|
-
export { orderBy }
|
|
101
|
-
|
|
102
|
-
export { removeItems }
|
|
103
|
-
|
|
104
|
-
declare interface RowDragClueProps {
|
|
105
|
-
visible: boolean;
|
|
106
|
-
top: number;
|
|
107
|
-
left: number;
|
|
108
|
-
text: string;
|
|
109
|
-
allowDrop: boolean;
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
declare type ScrollMode = 'none' | 'scrollable' | 'virtual';
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* @hidden
|
|
116
|
-
*/
|
|
117
|
-
export declare function setHeaderRowsTop(table: HTMLTableElement, toolbarHeight: number, rowHeight?: (row: HTMLTableRowElement) => string | undefined): void;
|
|
118
|
-
|
|
119
|
-
export { setSelectedState }
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* @hidden
|
|
123
|
-
*/
|
|
124
|
-
export declare function tableRowsVirtualization(args: {
|
|
125
|
-
rows: DataItemWrapper[];
|
|
126
|
-
tableViewPortHeight: number;
|
|
127
|
-
scrollTop: number;
|
|
128
|
-
}): DataItemWrapper[];
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* Represents the [KendoReact TreeList component](https://www.telerik.com/kendo-react-ui/components/treelist/get-started).
|
|
132
|
-
*/
|
|
133
|
-
export declare class TreeList extends React_2.Component<TreeListProps, {}> {
|
|
134
|
-
/**
|
|
135
|
-
* @hidden
|
|
136
|
-
*/
|
|
137
|
-
static propTypes: {
|
|
138
|
-
data: default_2.Requireable<any[]>;
|
|
139
|
-
resizable: default_2.Requireable<boolean>;
|
|
140
|
-
reorderable: default_2.Requireable<boolean>;
|
|
141
|
-
sortable: default_2.Requireable<NonNullable<boolean | default_2.InferProps<{
|
|
142
|
-
mode: default_2.Requireable<string>;
|
|
143
|
-
allowUnsort: default_2.Requireable<boolean>;
|
|
144
|
-
}> | null | undefined>>;
|
|
145
|
-
onSortChange: default_2.Requireable<(...args: any[]) => any>;
|
|
146
|
-
sort: default_2.Requireable<any[]>;
|
|
147
|
-
columns: default_2.Requireable<(object | null | undefined)[]>;
|
|
148
|
-
columnVirtualization: default_2.Requireable<boolean>;
|
|
149
|
-
filter: default_2.Requireable<any[]>;
|
|
150
|
-
onFilterChange: default_2.Requireable<(...args: any[]) => any>;
|
|
151
|
-
filterRow: default_2.Requireable<any>;
|
|
152
|
-
toolbar: default_2.Requireable<any>;
|
|
153
|
-
noRecords: default_2.Requireable<any>;
|
|
154
|
-
onExpandChange: default_2.Requireable<(...args: any[]) => any>;
|
|
155
|
-
expandField: default_2.Requireable<string>;
|
|
156
|
-
subItemsField: default_2.Requireable<string>;
|
|
157
|
-
selectedField: default_2.Requireable<string>;
|
|
158
|
-
onSelectionChange: default_2.Requireable<(...args: any[]) => any>;
|
|
159
|
-
onHeaderSelectionChange: default_2.Requireable<(...args: any[]) => any>;
|
|
160
|
-
onRowClick: default_2.Requireable<(...args: any[]) => any>;
|
|
161
|
-
onItemChange: default_2.Requireable<(...args: any[]) => any>;
|
|
162
|
-
editField: default_2.Requireable<string>;
|
|
163
|
-
scrollable: default_2.Requireable<string>;
|
|
164
|
-
rowHeight: default_2.Requireable<number>;
|
|
165
|
-
style: default_2.Requireable<object>;
|
|
166
|
-
tableProps: default_2.Requireable<object>;
|
|
167
|
-
pager: default_2.Requireable<any>;
|
|
168
|
-
skip: default_2.Requireable<number>;
|
|
169
|
-
take: default_2.Requireable<number>;
|
|
170
|
-
onPageChange: default_2.Requireable<(...args: any[]) => any>;
|
|
171
|
-
onDataStateChange: default_2.Requireable<(...args: any[]) => any>;
|
|
172
|
-
onColumnResize: default_2.Requireable<(...args: any[]) => any>;
|
|
173
|
-
onColumnReorder: default_2.Requireable<(...args: any[]) => any>;
|
|
174
|
-
dataItemKey: default_2.Requireable<string>;
|
|
175
|
-
navigatable: default_2.Requireable<boolean>;
|
|
176
|
-
};
|
|
177
|
-
/** @hidden */
|
|
178
|
-
static contextType: React_2.Context<TableKeyboardNavigationContextType | undefined>;
|
|
179
|
-
/**
|
|
180
|
-
* The HTML element of the TreeList component.
|
|
181
|
-
*/
|
|
182
|
-
element: HTMLDivElement | null;
|
|
183
|
-
private wrapperScrollLeft;
|
|
184
|
-
private wrapperScrollTop;
|
|
185
|
-
private updateOnScroll;
|
|
186
|
-
private tbodyOffsetTop;
|
|
187
|
-
private prevData;
|
|
188
|
-
private flattedData;
|
|
189
|
-
private extendedColumn;
|
|
190
|
-
private columnsMap;
|
|
191
|
-
private columnResize;
|
|
192
|
-
protected dragLogic: CommonDragLogic<TreeListCellProps, TreeListHeaderCellProps, TreeListFilterCellProps>;
|
|
193
|
-
private get _treeListId();
|
|
194
|
-
private get document();
|
|
195
|
-
private contextStateRef;
|
|
196
|
-
private navigationStateRef;
|
|
197
|
-
private readonly showLicenseWatermark;
|
|
198
|
-
private readonly licenseMessage;
|
|
199
|
-
constructor(props: TreeListProps);
|
|
200
|
-
/**
|
|
201
|
-
* Method to allow the scroll to be set to a specific row index.
|
|
202
|
-
*
|
|
203
|
-
* @param options - Object, containing the rowIndex to which is going to be scrolled.
|
|
204
|
-
*/
|
|
205
|
-
scrollIntoView: (options: {
|
|
206
|
-
rowIndex?: number;
|
|
207
|
-
}) => void;
|
|
208
|
-
/**
|
|
209
|
-
* @hidden
|
|
210
|
-
*/
|
|
211
|
-
componentDidMount(): void;
|
|
212
|
-
/**
|
|
213
|
-
* @hidden
|
|
214
|
-
*/
|
|
215
|
-
getSnapshotBeforeUpdate(): null;
|
|
216
|
-
/**
|
|
217
|
-
* @hidden
|
|
218
|
-
*/
|
|
219
|
-
componentDidUpdate(prevProps: TreeListProps): void;
|
|
220
|
-
/**
|
|
221
|
-
* @hidden
|
|
222
|
-
*/
|
|
223
|
-
componentWillUnmount(): void;
|
|
224
|
-
/**
|
|
225
|
-
* @hidden
|
|
226
|
-
*/
|
|
227
|
-
render(): JSX.Element;
|
|
228
|
-
private getExtendedColumn;
|
|
229
|
-
private getColumnsMap;
|
|
230
|
-
private get columns();
|
|
231
|
-
private get flatData();
|
|
232
|
-
private onKeyDown;
|
|
233
|
-
private onFocus;
|
|
234
|
-
private onRowDrag;
|
|
235
|
-
private onRowDrop;
|
|
236
|
-
private columnReorder;
|
|
237
|
-
private onResize;
|
|
238
|
-
private handleOnScroll;
|
|
239
|
-
private calculateSizes;
|
|
240
|
-
private itemChange;
|
|
241
|
-
private selectionChange;
|
|
242
|
-
private onHeaderSelectionChange;
|
|
243
|
-
private selectionRelease;
|
|
244
|
-
private sortChange;
|
|
245
|
-
private headerFilterChange;
|
|
246
|
-
private filterChange;
|
|
247
|
-
private columnMenuFilterChange;
|
|
248
|
-
private expandChange;
|
|
249
|
-
private rowClick;
|
|
250
|
-
private rowDoubleClick;
|
|
251
|
-
private rowContextMenu;
|
|
252
|
-
private onPageChange;
|
|
253
|
-
private raiseDataEvent;
|
|
254
|
-
private getDataState;
|
|
255
|
-
private getArguments;
|
|
256
|
-
private expandedSubItems;
|
|
257
|
-
private getLeafDataItems;
|
|
258
|
-
private expanded;
|
|
259
|
-
private hasChildren;
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
/** The attribute required by the TreeList selection on TreeList `td` elements. */
|
|
263
|
-
export declare const TREELIST_COL_INDEX_ATTRIBUTE = "data-grid-col-index";
|
|
264
|
-
|
|
265
|
-
/** Attribute which disable selection start from this element. */
|
|
266
|
-
export declare const TREELIST_PREVENT_SELECTION_ELEMENT = "data-prevent-selection";
|
|
267
|
-
|
|
268
|
-
/** The attribute required by the TreeList selection on TreeList `tr` elements. */
|
|
269
|
-
export declare const TREELIST_ROW_INDEX_ATTRIBUTE = "data-grid-row-index";
|
|
270
|
-
|
|
271
|
-
export declare const TreeListBooleanEditor: {
|
|
272
|
-
(props: TreeListBooleanEditorProps): JSX.Element | null;
|
|
273
|
-
displayName: string;
|
|
274
|
-
};
|
|
275
|
-
|
|
276
|
-
export declare interface TreeListBooleanEditorProps extends TreeListCellProps {
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
export declare const TreeListBooleanFilter: React_2.FunctionComponent<TreeListBooleanFilterProps>;
|
|
280
|
-
|
|
281
|
-
export declare interface TreeListBooleanFilterProps extends FilterComponentProps {
|
|
282
|
-
/**
|
|
283
|
-
* The list of the operators.
|
|
284
|
-
*/
|
|
285
|
-
operators?: TreeListFilterOperator[];
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
export declare const TreeListCell: {
|
|
289
|
-
(props: TreeListCellProps): JSX.Element | null;
|
|
290
|
-
displayName: string;
|
|
291
|
-
};
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* Represents the props of the TreeListCell component.
|
|
295
|
-
*/
|
|
296
|
-
export declare interface TreeListCellProps extends Omit<CellProps, 'onExpandChange' | 'render' | 'onChange'> {
|
|
297
|
-
/**
|
|
298
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
299
|
-
*/
|
|
300
|
-
level: number[];
|
|
301
|
-
/**
|
|
302
|
-
* Indicates that the data item of the cell has subitems.
|
|
303
|
-
*/
|
|
304
|
-
hasChildren?: boolean;
|
|
305
|
-
/**
|
|
306
|
-
* If set to `true`, the cell will render indentation based on its level prop and
|
|
307
|
-
* the icons that are used for expanding and collapsing child rows.
|
|
308
|
-
*/
|
|
309
|
-
expandable?: boolean;
|
|
310
|
-
/**
|
|
311
|
-
* The index of the column. Useful for applying `aria-colindex` accessibility attribute.
|
|
312
|
-
*/
|
|
313
|
-
colIndex: number;
|
|
314
|
-
/**
|
|
315
|
-
* The event that is fired when the expand or collapse icon of the cell is clicked.
|
|
316
|
-
*/
|
|
317
|
-
onExpandChange: (event: React.MouseEvent<HTMLSpanElement>, dataItem: any, level: number[]) => void;
|
|
318
|
-
/**
|
|
319
|
-
* A function for overriding the default rendering of the cell.
|
|
320
|
-
*/
|
|
321
|
-
render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: TreeListCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
322
|
-
/**
|
|
323
|
-
* The event that is fired when the cell value is changed.
|
|
324
|
-
*/
|
|
325
|
-
onChange?: (event: {
|
|
326
|
-
dataItem: any;
|
|
327
|
-
level: number[];
|
|
328
|
-
syntheticEvent: React.SyntheticEvent<any>;
|
|
329
|
-
field?: string;
|
|
330
|
-
value?: any;
|
|
331
|
-
}) => void;
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* Represents the object of the `onColumnMenuFilterChange` TreeList event.
|
|
336
|
-
*/
|
|
337
|
-
export declare interface TreeListColumnMenuFilterChangeEvent extends TreeListEvent {
|
|
338
|
-
/**
|
|
339
|
-
* The new `CompositeFilterDescriptor` based on the user action.
|
|
340
|
-
*/
|
|
341
|
-
filter: CompositeFilterDescriptor[];
|
|
342
|
-
/**
|
|
343
|
-
* The field of the column which triggers the event.
|
|
344
|
-
*/
|
|
345
|
-
field: string;
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
/**
|
|
349
|
-
* The props of the columns of the TreeList component.
|
|
350
|
-
*/
|
|
351
|
-
export declare interface TreeListColumnProps extends Omit<TreeColumnBaseProps, 'children' | 'cell' | 'editCell' | 'disableReorder'> {
|
|
352
|
-
/**
|
|
353
|
-
* Defines the component that will be rendered as a cell. If not set, a `TreeListCell` will be rendered by default.
|
|
354
|
-
*/
|
|
355
|
-
cell?: ComponentType<TreeListCellProps>;
|
|
356
|
-
/**
|
|
357
|
-
* Defines the component that will be rendered as an edit cell.
|
|
358
|
-
*/
|
|
359
|
-
editCell?: ComponentType<TreeListCellProps>;
|
|
360
|
-
/**
|
|
361
|
-
* Defines the component that will be rendered as a header cell.
|
|
362
|
-
* If not set, a `TreeListHeaderCell` will be rendered by default.
|
|
363
|
-
*/
|
|
364
|
-
headerCell?: ComponentType<TreeListHeaderCellProps>;
|
|
365
|
-
/**
|
|
366
|
-
* **Deprecated**. Use `filterCell` prop instead.
|
|
367
|
-
*/
|
|
368
|
-
filter?: ComponentType<TreeListFilterCellProps>;
|
|
369
|
-
/**
|
|
370
|
-
* Defines the component that will be rendered as a filter cell.
|
|
371
|
-
*/
|
|
372
|
-
filterCell?: ComponentType<TreeListFilterCellProps>;
|
|
373
|
-
/**
|
|
374
|
-
* A collection of child columns.
|
|
375
|
-
*/
|
|
376
|
-
children?: TreeListColumnProps[];
|
|
377
|
-
/**
|
|
378
|
-
* Defines if the column is locked (frozen or sticky).
|
|
379
|
-
* Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
|
|
380
|
-
* Defaults to `false`.
|
|
381
|
-
*/
|
|
382
|
-
locked?: boolean;
|
|
383
|
-
}
|
|
384
|
-
|
|
385
|
-
/**
|
|
386
|
-
* Represents the object of the `onColumnReorder` TreeList event.
|
|
387
|
-
*/
|
|
388
|
-
export declare interface TreeListColumnReorderEvent extends ColumnDragEvent {
|
|
389
|
-
}
|
|
390
|
-
|
|
391
|
-
/**
|
|
392
|
-
* Represents the object of the `onColumnResize` TreeList event.
|
|
393
|
-
*/
|
|
394
|
-
export declare interface TreeListColumnResizeEvent extends ColumnDragEvent {
|
|
395
|
-
/**
|
|
396
|
-
* The index of the column.
|
|
397
|
-
*/
|
|
398
|
-
index: number;
|
|
399
|
-
/**
|
|
400
|
-
* The new width of the column.
|
|
401
|
-
*/
|
|
402
|
-
newWidth: number;
|
|
403
|
-
/**
|
|
404
|
-
* The actual width of the column prior to resizing.
|
|
405
|
-
*/
|
|
406
|
-
oldWidth: number;
|
|
407
|
-
/**
|
|
408
|
-
* Indicates that resizing is complete and the user has dropped the resize handler.
|
|
409
|
-
*/
|
|
410
|
-
end: boolean;
|
|
411
|
-
/**
|
|
412
|
-
* The total width of the columns after the resizing.
|
|
413
|
-
*/
|
|
414
|
-
totalWidth: number;
|
|
415
|
-
}
|
|
416
|
-
|
|
417
|
-
/**
|
|
418
|
-
* The settings for sorting the TreeList columns.
|
|
419
|
-
*/
|
|
420
|
-
export declare type TreeListColumnSortSettings = ColumnSortSettings;
|
|
421
|
-
|
|
422
|
-
/**
|
|
423
|
-
* Represents the object of the `onDataStateChange` TreeList event.
|
|
424
|
-
*/
|
|
425
|
-
export declare interface TreeListDataStateChangeEvent extends TreeListEvent {
|
|
426
|
-
/**
|
|
427
|
-
* The state of the TreeList based on the user action.
|
|
428
|
-
*/
|
|
429
|
-
dataState: {
|
|
430
|
-
/**
|
|
431
|
-
* The descriptors that are used for sorting.
|
|
432
|
-
*/
|
|
433
|
-
sort?: Array<SortDescriptor>;
|
|
434
|
-
/**
|
|
435
|
-
* The descriptors that are used for filtering.
|
|
436
|
-
*/
|
|
437
|
-
filter?: Array<FilterDescriptor>;
|
|
438
|
-
/**
|
|
439
|
-
* The field of the column which triggers the event.
|
|
440
|
-
*/
|
|
441
|
-
field?: string;
|
|
442
|
-
};
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
export declare const TreeListDateEditor: {
|
|
446
|
-
(props: TreeListDateEditorProps): JSX.Element | null;
|
|
447
|
-
displayName: string;
|
|
448
|
-
};
|
|
449
|
-
|
|
450
|
-
export declare interface TreeListDateEditorProps extends TreeListCellProps {
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
export declare const TreeListDateFilter: React_2.FunctionComponent<TreeListDateFilterProps>;
|
|
454
|
-
|
|
455
|
-
export declare interface TreeListDateFilterProps extends FilterComponentProps {
|
|
456
|
-
/**
|
|
457
|
-
* The list of the operators.
|
|
458
|
-
*/
|
|
459
|
-
operators?: TreeListFilterOperator[];
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
/**
|
|
463
|
-
* The TreeList draggable row component.
|
|
464
|
-
*/
|
|
465
|
-
export declare class TreeListDraggableRow extends React_2.Component<TreeListRowProps, TreeListRowState> {
|
|
466
|
-
/**
|
|
467
|
-
* @hidden
|
|
468
|
-
*/
|
|
469
|
-
readonly state: TreeListRowState;
|
|
470
|
-
private draggable;
|
|
471
|
-
private dragged;
|
|
472
|
-
private draggedOver;
|
|
473
|
-
/**
|
|
474
|
-
* @hidden
|
|
475
|
-
*/
|
|
476
|
-
render(): JSX.Element;
|
|
477
|
-
private onPress;
|
|
478
|
-
private onDrag;
|
|
479
|
-
private onRelease;
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
/** @hidden */
|
|
483
|
-
export declare interface TreeListDragSelectionReleaseEvent extends TableDragSelectionReleaseEvent {
|
|
484
|
-
}
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* Represents the base event object of the TreeList.
|
|
488
|
-
*/
|
|
489
|
-
export declare interface TreeListEvent extends BaseEvent<TreeList> {
|
|
490
|
-
}
|
|
491
|
-
|
|
492
|
-
/**
|
|
493
|
-
* Represents the object of the `onExpandChange` TreeList event.
|
|
494
|
-
*/
|
|
495
|
-
export declare interface TreeListExpandChangeEvent extends TreeListEvent {
|
|
496
|
-
/**
|
|
497
|
-
* The data item which is expanded or collapsed.
|
|
498
|
-
*/
|
|
499
|
-
dataItem: any;
|
|
500
|
-
/**
|
|
501
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
502
|
-
*/
|
|
503
|
-
level: number[];
|
|
504
|
-
/**
|
|
505
|
-
* The available values are:
|
|
506
|
-
* - `true`—If the data item is expanded.
|
|
507
|
-
* - `false`—If the data item is collapsed.
|
|
508
|
-
*/
|
|
509
|
-
value: boolean;
|
|
510
|
-
}
|
|
511
|
-
|
|
512
|
-
/**
|
|
513
|
-
* @hidden
|
|
514
|
-
*/
|
|
515
|
-
declare interface TreeListFilterCellProps extends FilterCellProps {
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
/**
|
|
519
|
-
* Represents the object of the `onFilterChange` TreeList event.
|
|
520
|
-
*/
|
|
521
|
-
export declare interface TreeListFilterChangeEvent extends TreeListEvent {
|
|
522
|
-
/**
|
|
523
|
-
* The new `FilterDescriptor` based on the user action.
|
|
524
|
-
*/
|
|
525
|
-
filter: FilterDescriptor[];
|
|
526
|
-
/**
|
|
527
|
-
* The field of the column which triggers the event.
|
|
528
|
-
*/
|
|
529
|
-
field: string;
|
|
530
|
-
}
|
|
531
|
-
|
|
532
|
-
/**
|
|
533
|
-
* The filter operator for the TreeList filters.
|
|
534
|
-
*/
|
|
535
|
-
declare interface TreeListFilterOperator extends FilterOperator {
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
export declare const TreeListHeaderCell: React_2.FunctionComponent<TreeListHeaderCellProps>;
|
|
539
|
-
|
|
540
|
-
/**
|
|
541
|
-
* The props of the TreeListHeaderCell component.
|
|
542
|
-
*/
|
|
543
|
-
export declare interface TreeListHeaderCellProps extends HeaderCellProps {
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
export declare class TreeListHeaderSelectionCell extends React_2.Component<TreeListHeaderSelectionCellProps> {
|
|
547
|
-
private _inputId;
|
|
548
|
-
/**
|
|
549
|
-
* @hidden
|
|
550
|
-
*/
|
|
551
|
-
render(): JSX.Element;
|
|
552
|
-
}
|
|
553
|
-
|
|
554
|
-
export declare interface TreeListHeaderSelectionCellProps extends HeaderCellProps {
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
/**
|
|
558
|
-
* Represents the object of the `onHeaderSelectionChange` TreeList event.
|
|
559
|
-
*/
|
|
560
|
-
export declare interface TreeListHeaderSelectionChangeEvent extends TreeListEvent {
|
|
561
|
-
/**
|
|
562
|
-
* The field of the column in which the cell is located.
|
|
563
|
-
*/
|
|
564
|
-
field?: string;
|
|
565
|
-
/**
|
|
566
|
-
* The current data as flatted array.
|
|
567
|
-
*/
|
|
568
|
-
dataItems: any[];
|
|
569
|
-
}
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
* Represents the object of the `onItemChange` TreeList event.
|
|
573
|
-
*/
|
|
574
|
-
export declare interface TreeListItemChangeEvent extends TreeListEvent {
|
|
575
|
-
/**
|
|
576
|
-
* The data item which corresponds to the current row.
|
|
577
|
-
*/
|
|
578
|
-
dataItem: any;
|
|
579
|
-
/**
|
|
580
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
581
|
-
*/
|
|
582
|
-
level: number[];
|
|
583
|
-
/**
|
|
584
|
-
* The field to which the row is bound.
|
|
585
|
-
*/
|
|
586
|
-
field?: string;
|
|
587
|
-
/**
|
|
588
|
-
* The value of the item.
|
|
589
|
-
*/
|
|
590
|
-
value: any;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
/**
|
|
594
|
-
* Represents the object of the `onKeyDownEvent` TreeList event.
|
|
595
|
-
*/
|
|
596
|
-
export declare interface TreeListKeyDownEvent extends TreeListEvent, TableKeyDownEvent<TreeList> {
|
|
597
|
-
}
|
|
598
|
-
|
|
599
|
-
/**
|
|
600
|
-
* Represents the TreeListNoRecords component.
|
|
601
|
-
* The component is rendered when the `data` property of the TreeList is an empty array or undefined.
|
|
602
|
-
*/
|
|
603
|
-
export declare class TreeListNoRecords extends React_2.Component<TreeListNoRecordsProps, {}> {
|
|
604
|
-
/**
|
|
605
|
-
* @hidden
|
|
606
|
-
*/
|
|
607
|
-
render(): any;
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
/**
|
|
611
|
-
* The props of the TreeListNoRecords component.
|
|
612
|
-
*/
|
|
613
|
-
export declare interface TreeListNoRecordsProps {
|
|
614
|
-
/**
|
|
615
|
-
* The React elements which will be rendered inside the TreeList when no records are available.
|
|
616
|
-
*/
|
|
617
|
-
children?: React.ReactNode;
|
|
618
|
-
}
|
|
619
|
-
|
|
620
|
-
export declare const TreeListNumericEditor: {
|
|
621
|
-
(props: TreeListNumericEditorProps): React_2.ReactElement<HTMLTableCellElement, string | React_2.JSXElementConstructor<any>> | null;
|
|
622
|
-
displayName: string;
|
|
623
|
-
};
|
|
624
|
-
|
|
625
|
-
export declare interface TreeListNumericEditorProps extends TreeListCellProps {
|
|
626
|
-
}
|
|
627
|
-
|
|
628
|
-
export declare const TreeListNumericFilter: React_2.FunctionComponent<TreeListNumericFilterProps>;
|
|
629
|
-
|
|
630
|
-
export declare interface TreeListNumericFilterProps extends FilterComponentProps {
|
|
631
|
-
/**
|
|
632
|
-
* The list of the operators.
|
|
633
|
-
*/
|
|
634
|
-
operators?: TreeListFilterOperator[];
|
|
635
|
-
}
|
|
636
|
-
|
|
637
|
-
/**
|
|
638
|
-
* Represents the object of the `onPageChange` TreeList event.
|
|
639
|
-
*/
|
|
640
|
-
export declare interface TreeListPageChangeEvent extends TreeListEvent {
|
|
641
|
-
/**
|
|
642
|
-
* The number of records that will be skipped.
|
|
643
|
-
*/
|
|
644
|
-
skip: number;
|
|
645
|
-
/**
|
|
646
|
-
* The number of records that will be taken.
|
|
647
|
-
*/
|
|
648
|
-
take: number;
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
/**
|
|
652
|
-
* Represents the props of the [KendoReact TreeList component](https://www.telerik.com/kendo-react-ui/components/treelist/get-started).
|
|
653
|
-
*/
|
|
654
|
-
export declare interface TreeListProps {
|
|
655
|
-
/**
|
|
656
|
-
* Sets the unique key for each row in the TreeList. If not set, the row index is used.
|
|
657
|
-
*
|
|
658
|
-
* Example:
|
|
659
|
-
* ```jsx
|
|
660
|
-
* <TreeList dataItemKey="id" />
|
|
661
|
-
* ```
|
|
662
|
-
*/
|
|
663
|
-
dataItemKey?: string;
|
|
664
|
-
/**
|
|
665
|
-
* Adds custom CSS classes to the TreeList container element.
|
|
666
|
-
*
|
|
667
|
-
* Example:
|
|
668
|
-
* ```jsx
|
|
669
|
-
* <TreeList className="custom-treelist-class" />
|
|
670
|
-
* ```
|
|
671
|
-
*/
|
|
672
|
-
className?: string;
|
|
673
|
-
/**
|
|
674
|
-
* Specifies the `id` attribute of the TreeList container element.
|
|
675
|
-
*
|
|
676
|
-
* Example:
|
|
677
|
-
* ```jsx
|
|
678
|
-
* <TreeList id="treelist-component" />
|
|
679
|
-
* ```
|
|
680
|
-
*/
|
|
681
|
-
id?: string;
|
|
682
|
-
/**
|
|
683
|
-
* Defines the columns of the TreeList using an array of `TreeListColumnProps`.
|
|
684
|
-
*
|
|
685
|
-
* Example:
|
|
686
|
-
* ```jsx
|
|
687
|
-
* <TreeList columns={[{ field: 'name', title: 'Name' }]} />
|
|
688
|
-
* ```
|
|
689
|
-
*/
|
|
690
|
-
columns?: TreeListColumnProps[];
|
|
691
|
-
/**
|
|
692
|
-
* Enables column virtualization to improve performance by rendering only visible columns.
|
|
693
|
-
*
|
|
694
|
-
* Example:
|
|
695
|
-
* ```jsx
|
|
696
|
-
* <TreeList columnVirtualization={true} />
|
|
697
|
-
* ```
|
|
698
|
-
*/
|
|
699
|
-
columnVirtualization?: boolean;
|
|
700
|
-
/**
|
|
701
|
-
* Provides the data to be displayed in the TreeList.
|
|
702
|
-
*
|
|
703
|
-
* Example:
|
|
704
|
-
* ```jsx
|
|
705
|
-
* <TreeList data={[{ id: 1, name: 'Item 1' }]} />
|
|
706
|
-
* ```
|
|
707
|
-
*/
|
|
708
|
-
data?: any[];
|
|
709
|
-
/**
|
|
710
|
-
* Enables sorting functionality for the TreeList.
|
|
711
|
-
*
|
|
712
|
-
* Example:
|
|
713
|
-
* ```jsx
|
|
714
|
-
* <TreeList sortable={{ mode: 'single', allowUnsort: true }} />
|
|
715
|
-
* ```
|
|
716
|
-
*/
|
|
717
|
-
sortable?: SortSettings;
|
|
718
|
-
/**
|
|
719
|
-
* Triggered when the sorting state changes. The event must be handled to apply sorting.
|
|
720
|
-
*
|
|
721
|
-
* Example:
|
|
722
|
-
* ```jsx
|
|
723
|
-
* <TreeList onSortChange={(event) => console.log(event.sort)} />
|
|
724
|
-
* ```
|
|
725
|
-
*/
|
|
726
|
-
onSortChange?: (event: TreeListSortChangeEvent) => void;
|
|
727
|
-
/**
|
|
728
|
-
* Specifies the current sorting descriptors for the TreeList.
|
|
729
|
-
*
|
|
730
|
-
* Example:
|
|
731
|
-
* ```jsx
|
|
732
|
-
* <TreeList sort={[{ field: 'name', dir: 'asc' }]} />
|
|
733
|
-
* ```
|
|
734
|
-
*/
|
|
735
|
-
sort?: SortDescriptor[];
|
|
736
|
-
/**
|
|
737
|
-
* If set, it will be rendered instead of the default `FilterRow` TreeList component.
|
|
738
|
-
*/
|
|
739
|
-
filterRow?: React.ComponentType<FilterRowProps>;
|
|
740
|
-
/**
|
|
741
|
-
* If set and when the data item is in edit mode, the `editRow` value will be rendered.
|
|
742
|
-
*/
|
|
743
|
-
editRow?: React.ComponentType<TreeListRowProps>;
|
|
744
|
-
/**
|
|
745
|
-
* Represents the TreeList toolbar component.
|
|
746
|
-
*/
|
|
747
|
-
toolbar?: React.ReactElement<TreeListToolbarProps>;
|
|
748
|
-
/**
|
|
749
|
-
* Represents the component that will be rendered when the `data` property of the TreeList is empty or undefined.
|
|
750
|
-
*/
|
|
751
|
-
noRecords?: React.ReactElement<TreeListNoRecordsProps>;
|
|
752
|
-
/**
|
|
753
|
-
* Specifies the current filter descriptors for the TreeList.
|
|
754
|
-
*/
|
|
755
|
-
filter?: FilterDescriptor[];
|
|
756
|
-
/**
|
|
757
|
-
* Triggered when the filter state changes. The event must be handled to apply filtering.
|
|
758
|
-
*/
|
|
759
|
-
onFilterChange?: (event: TreeListFilterChangeEvent) => void;
|
|
760
|
-
/**
|
|
761
|
-
* Triggered when the user clicks on the expand or collapse icon of a row.
|
|
762
|
-
*/
|
|
763
|
-
onExpandChange?: (event: TreeListExpandChangeEvent) => void;
|
|
764
|
-
/**
|
|
765
|
-
* Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
|
|
766
|
-
*/
|
|
767
|
-
expandField?: string;
|
|
768
|
-
/**
|
|
769
|
-
* Specifies the name of the field which will provide an array representation of the item subitems.
|
|
770
|
-
*/
|
|
771
|
-
subItemsField?: string;
|
|
772
|
-
/**
|
|
773
|
-
* Configures the selection settings for the TreeList.
|
|
774
|
-
*/
|
|
775
|
-
selectable?: TreeListSelectableSettings;
|
|
776
|
-
/**
|
|
777
|
-
* Specifies the name of the field which will provide a Boolean representation of the selected state of the item.
|
|
778
|
-
*/
|
|
779
|
-
selectedField?: string;
|
|
780
|
-
/**
|
|
781
|
-
* Triggered when the user selects or deselects a row or cell.
|
|
782
|
-
*/
|
|
783
|
-
onSelectionChange?: (event: TreeListSelectionChangeEvent) => void;
|
|
784
|
-
/**
|
|
785
|
-
* Triggered when the user presses a keyboard key.
|
|
786
|
-
*/
|
|
787
|
-
onKeyDown?: (event: TreeListKeyDownEvent) => void;
|
|
788
|
-
/**
|
|
789
|
-
* Triggered when the user clicks the checkbox of a column header whose `field` matches `selectedField`.
|
|
790
|
-
*/
|
|
791
|
-
onHeaderSelectionChange?: (event: TreeListHeaderSelectionChangeEvent) => void;
|
|
792
|
-
/**
|
|
793
|
-
* Triggered when the user changes the values of the item.
|
|
794
|
-
* The event is not debounced and fires on every `onChange` event of the input in the current `EditCell`.
|
|
795
|
-
*/
|
|
796
|
-
onItemChange?: (event: TreeListItemChangeEvent) => void;
|
|
797
|
-
/**
|
|
798
|
-
* Triggered when the user clicks a row.
|
|
799
|
-
*/
|
|
800
|
-
onRowClick?: (event: TreeListRowClickEvent) => void;
|
|
801
|
-
/**
|
|
802
|
-
* Triggered when the user double clicks a row.
|
|
803
|
-
*/
|
|
804
|
-
onRowDoubleClick?: (event: TreeListRowDoubleClickEvent) => void;
|
|
805
|
-
/**
|
|
806
|
-
* Triggered when the user opens the context menu of a row.
|
|
807
|
-
*/
|
|
808
|
-
onRowContextMenu?: (event: TreeListRowContextMenuEvent) => void;
|
|
809
|
-
/**
|
|
810
|
-
* Specifies the name of the field which will provide a Boolean representation of the edit state of the current item.
|
|
811
|
-
*/
|
|
812
|
-
editField?: string;
|
|
813
|
-
/**
|
|
814
|
-
* Defines the scroll mode of the TreeList.
|
|
815
|
-
*
|
|
816
|
-
* The available options are:
|
|
817
|
-
* - `none`—Renders no scrollbar.
|
|
818
|
-
* - `scrollable`—Represents the default scroll mode of the TreeList.
|
|
819
|
-
* Requires you to set the `overflow` and `height` (for vertical scrolling),
|
|
820
|
-
* or `width` (for horizontal scrolling) styles.
|
|
821
|
-
* - `virtual`—Enables the vertical virtual scrolling of the TreeList.
|
|
822
|
-
* Requires you to set the `overflow` and `height` styles and `rowHeight` prop of the TreeList.
|
|
823
|
-
*/
|
|
824
|
-
scrollable?: ScrollMode;
|
|
825
|
-
/**
|
|
826
|
-
* Enables column resizing by dragging the edges of their header cells.
|
|
827
|
-
*/
|
|
828
|
-
resizable?: boolean;
|
|
829
|
-
/**
|
|
830
|
-
* Enables column reordering by dragging their header cells.
|
|
831
|
-
*/
|
|
832
|
-
reorderable?: boolean;
|
|
833
|
-
/**
|
|
834
|
-
* Enables row dragging and dropping.
|
|
835
|
-
*/
|
|
836
|
-
rowDraggable?: boolean;
|
|
837
|
-
/**
|
|
838
|
-
* Specifies the height of each row in the TreeList.
|
|
839
|
-
*/
|
|
840
|
-
rowHeight?: number;
|
|
841
|
-
/**
|
|
842
|
-
* Represents the `style` HTML attribute.
|
|
843
|
-
*/
|
|
844
|
-
style?: React.CSSProperties;
|
|
845
|
-
/**
|
|
846
|
-
* A props object that will be passed to the underlying HTML table.
|
|
847
|
-
*/
|
|
848
|
-
tableProps?: React.DetailedHTMLProps<React.TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>;
|
|
849
|
-
/**
|
|
850
|
-
* Specifies the column menu component to be used by the TreeList.
|
|
851
|
-
*/
|
|
852
|
-
columnMenu?: React.ComponentType<any>;
|
|
853
|
-
/**
|
|
854
|
-
* Specifies the composite filter descriptor for the column menu filter.
|
|
855
|
-
*/
|
|
856
|
-
columnMenuFilter?: CompositeFilterDescriptor[];
|
|
857
|
-
/**
|
|
858
|
-
* Triggered when the column menu filter state changes.
|
|
859
|
-
*/
|
|
860
|
-
onColumnMenuFilterChange?: (event: TreeListColumnMenuFilterChangeEvent) => void;
|
|
861
|
-
/**
|
|
862
|
-
* Specifies the pager component to be used by the TreeList.
|
|
863
|
-
*/
|
|
864
|
-
pager?: React.ComponentType<any>;
|
|
865
|
-
/**
|
|
866
|
-
* Specifies the number of records to be skipped.
|
|
867
|
-
*/
|
|
868
|
-
skip?: number;
|
|
869
|
-
/**
|
|
870
|
-
* Specifies the number of records to be taken.
|
|
871
|
-
*/
|
|
872
|
-
take?: number;
|
|
873
|
-
/**
|
|
874
|
-
* Specifies the row component to be used by the TreeList.
|
|
875
|
-
*/
|
|
876
|
-
row?: React.ComponentType<TreeListRowProps>;
|
|
877
|
-
/**
|
|
878
|
-
* Enables keyboard navigation for the TreeList.
|
|
879
|
-
*/
|
|
880
|
-
navigatable?: boolean;
|
|
881
|
-
/**
|
|
882
|
-
* Triggered when the page state changes. The event must be handled to apply paging.
|
|
883
|
-
*/
|
|
884
|
-
onPageChange?: (event: TreeListPageChangeEvent) => void;
|
|
885
|
-
/**
|
|
886
|
-
* Triggered when the data state changes. The event must be handled to apply the new state.
|
|
887
|
-
*/
|
|
888
|
-
onDataStateChange?: (event: TreeListDataStateChangeEvent) => void;
|
|
889
|
-
/**
|
|
890
|
-
* Triggered when a column is resized.
|
|
891
|
-
*/
|
|
892
|
-
onColumnResize?: (event: TreeListColumnResizeEvent) => void;
|
|
893
|
-
/**
|
|
894
|
-
* Triggered when columns are reordered.
|
|
895
|
-
*/
|
|
896
|
-
onColumnReorder?: (event: TreeListColumnReorderEvent) => void;
|
|
897
|
-
/**
|
|
898
|
-
* Triggered when a row is dragged.
|
|
899
|
-
*/
|
|
900
|
-
onRowDrag?: (event: TreeListRowDragEvent) => void;
|
|
901
|
-
/**
|
|
902
|
-
* Triggered when a row is dragged and dropped.
|
|
903
|
-
*/
|
|
904
|
-
onRowDrop?: (event: TreeListRowDragEvent) => void;
|
|
905
|
-
/**
|
|
906
|
-
* Triggered before a row is rendered. Useful for customizing the row rendering.
|
|
907
|
-
*/
|
|
908
|
-
rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: TreeListRowProps) => React.ReactNode;
|
|
909
|
-
/**
|
|
910
|
-
* Triggered before a cell is rendered. Useful for customizing the cell rendering.
|
|
911
|
-
*/
|
|
912
|
-
cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: TreeListCellProps) => React.ReactElement<HTMLTableCellElement> | null;
|
|
913
|
-
/**
|
|
914
|
-
* Triggered before a header cell is rendered. Useful for customizing the header cell rendering.
|
|
915
|
-
*/
|
|
916
|
-
headerCellRender?: (defaultRendering: React.ReactNode | null, props: TreeListHeaderCellProps) => React.ReactNode;
|
|
917
|
-
}
|
|
918
|
-
|
|
919
|
-
/**
|
|
920
|
-
* The default row component of the TreeList.
|
|
921
|
-
*/
|
|
922
|
-
export declare const TreeListRow: React_2.ForwardRefExoticComponent<TreeListRowProps & React_2.RefAttributes<HTMLTableRowElement>>;
|
|
923
|
-
|
|
924
|
-
/**
|
|
925
|
-
* Represents the object of the `onRowClick` TreeList event.
|
|
926
|
-
*/
|
|
927
|
-
export declare interface TreeListRowClickEvent extends TreeListEvent {
|
|
928
|
-
/**
|
|
929
|
-
* The data item which corresponds to the clicked row.
|
|
930
|
-
*/
|
|
931
|
-
dataItem: any;
|
|
932
|
-
/**
|
|
933
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
934
|
-
*/
|
|
935
|
-
level: number[];
|
|
936
|
-
}
|
|
937
|
-
|
|
938
|
-
/**
|
|
939
|
-
* Represents the object of the `onRowContextMenu` TreeList event.
|
|
940
|
-
*/
|
|
941
|
-
export declare interface TreeListRowContextMenuEvent extends TreeListEvent {
|
|
942
|
-
/**
|
|
943
|
-
* The data item which corresponds to the clicked row.
|
|
944
|
-
*/
|
|
945
|
-
dataItem: any;
|
|
946
|
-
/**
|
|
947
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
948
|
-
*/
|
|
949
|
-
level: number[];
|
|
950
|
-
}
|
|
951
|
-
|
|
952
|
-
/**
|
|
953
|
-
* Represents the object of the `onRowDoubleClick` TreeList event.
|
|
954
|
-
*/
|
|
955
|
-
export declare interface TreeListRowDoubleClickEvent extends TreeListEvent {
|
|
956
|
-
/**
|
|
957
|
-
* The data item which corresponds to the clicked row.
|
|
958
|
-
*/
|
|
959
|
-
dataItem: any;
|
|
960
|
-
/**
|
|
961
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
962
|
-
*/
|
|
963
|
-
level: number[];
|
|
964
|
-
}
|
|
965
|
-
|
|
966
|
-
/**
|
|
967
|
-
* Represents the object of the TreeList row Drag and Drop event.
|
|
968
|
-
*/
|
|
969
|
-
export declare interface TreeListRowDragEvent {
|
|
970
|
-
/**
|
|
971
|
-
* A native DOM event.
|
|
972
|
-
*/
|
|
973
|
-
nativeEvent: any;
|
|
974
|
-
/**
|
|
975
|
-
* An event target.
|
|
976
|
-
*/
|
|
977
|
-
target: TreeList;
|
|
978
|
-
/**
|
|
979
|
-
* The level of the dragged row.
|
|
980
|
-
* The level represents an array of indexes of each parent and current item in the data tree.
|
|
981
|
-
*/
|
|
982
|
-
dragged: number[];
|
|
983
|
-
/**
|
|
984
|
-
* The level of the draggedOver row.
|
|
985
|
-
* The level represents an array of indexes of each parent and current item in the data tree.
|
|
986
|
-
*/
|
|
987
|
-
draggedOver: number[] | null;
|
|
988
|
-
/**
|
|
989
|
-
* The data item which corresponds to the dragged row.
|
|
990
|
-
*/
|
|
991
|
-
draggedItem: any;
|
|
992
|
-
}
|
|
993
|
-
|
|
994
|
-
/**
|
|
995
|
-
* The props that the TreeList passes to the TreeListRow component when creating it.
|
|
996
|
-
* Accessible during the `rowRender` callback of the TreeList.
|
|
997
|
-
*/
|
|
998
|
-
export declare interface TreeListRowProps {
|
|
999
|
-
/**
|
|
1000
|
-
* The `data` object that represents the current row.
|
|
1001
|
-
*/
|
|
1002
|
-
dataItem: any;
|
|
1003
|
-
/**
|
|
1004
|
-
* The event that is fired when the row is clicked.
|
|
1005
|
-
*/
|
|
1006
|
-
onClick?: any;
|
|
1007
|
-
/**
|
|
1008
|
-
* The event that is fired when the row is double clicked.
|
|
1009
|
-
*/
|
|
1010
|
-
onDoubleClick?: any;
|
|
1011
|
-
/**
|
|
1012
|
-
* The event that is fired when the row context menu is triggered.
|
|
1013
|
-
*/
|
|
1014
|
-
onContextMenu?: any;
|
|
1015
|
-
/**
|
|
1016
|
-
* The name of the field which will provide a Boolean representation of the selected state of the item.
|
|
1017
|
-
*/
|
|
1018
|
-
selectedField?: string;
|
|
1019
|
-
/**
|
|
1020
|
-
* Sets the height of the row.
|
|
1021
|
-
*/
|
|
1022
|
-
rowHeight?: number;
|
|
1023
|
-
/**
|
|
1024
|
-
* A function for overriding the default rendering of the row.
|
|
1025
|
-
*/
|
|
1026
|
-
render?: (row: React.ReactElement<HTMLTableRowElement>, props: TreeListRowProps) => React.ReactNode;
|
|
1027
|
-
/**
|
|
1028
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
1029
|
-
*/
|
|
1030
|
-
level: number[];
|
|
1031
|
-
/**
|
|
1032
|
-
* Fires when a row is dragged.
|
|
1033
|
-
*/
|
|
1034
|
-
onDrag?: (event: {
|
|
1035
|
-
nativeEvent: any;
|
|
1036
|
-
dragged: number[];
|
|
1037
|
-
draggedOver: number[] | null;
|
|
1038
|
-
draggedItem: any;
|
|
1039
|
-
}) => void;
|
|
1040
|
-
/**
|
|
1041
|
-
* Fires when a row is dragged and dropped.
|
|
1042
|
-
*/
|
|
1043
|
-
onDrop?: (event: {
|
|
1044
|
-
nativeEvent: any;
|
|
1045
|
-
dragged: number[];
|
|
1046
|
-
draggedOver: number[] | null;
|
|
1047
|
-
draggedItem: any;
|
|
1048
|
-
}) => void;
|
|
1049
|
-
/**
|
|
1050
|
-
* The expanded state of the row. Useful for applying `aria-expanded` accessibility attribute.
|
|
1051
|
-
*/
|
|
1052
|
-
expanded: boolean;
|
|
1053
|
-
/**
|
|
1054
|
-
* The index of the row. Useful for applying `aria-rowindex` accessibility attribute.
|
|
1055
|
-
*/
|
|
1056
|
-
rowIndex: number;
|
|
1057
|
-
/**
|
|
1058
|
-
* @hidden
|
|
1059
|
-
*/
|
|
1060
|
-
children: React.ReactNode;
|
|
1061
|
-
/**
|
|
1062
|
-
* @hidden
|
|
1063
|
-
*/
|
|
1064
|
-
levels: number[][];
|
|
1065
|
-
/**
|
|
1066
|
-
* @hidden
|
|
1067
|
-
*/
|
|
1068
|
-
isAltRow?: boolean;
|
|
1069
|
-
/**
|
|
1070
|
-
* The index to be applied to the `aria-rowindex` attribute.
|
|
1071
|
-
*/
|
|
1072
|
-
ariaRowIndex?: number;
|
|
1073
|
-
/**
|
|
1074
|
-
* The count of items on current level, applied to the `aria-setsize` attribute.
|
|
1075
|
-
*/
|
|
1076
|
-
ariaSetSize?: number;
|
|
1077
|
-
/**
|
|
1078
|
-
* The index of the item on current level, applied to the `aria-posinset` attribute.
|
|
1079
|
-
*/
|
|
1080
|
-
ariaPosInSet?: number;
|
|
1081
|
-
/**
|
|
1082
|
-
* Indicates if the row is selected.
|
|
1083
|
-
*/
|
|
1084
|
-
isSelected: boolean;
|
|
1085
|
-
}
|
|
1086
|
-
|
|
1087
|
-
declare interface TreeListRowState {
|
|
1088
|
-
clueProps: RowDragClueProps;
|
|
1089
|
-
}
|
|
1090
|
-
|
|
1091
|
-
/**
|
|
1092
|
-
* Represents the available selection modes.
|
|
1093
|
-
*/
|
|
1094
|
-
export declare type TreeListSelectableMode = TableSelectableMode;
|
|
1095
|
-
|
|
1096
|
-
/**
|
|
1097
|
-
* Represents the TreeList selectable settings.
|
|
1098
|
-
*/
|
|
1099
|
-
export declare interface TreeListSelectableSettings extends TableSelectableSettings {
|
|
1100
|
-
/**
|
|
1101
|
-
* The available values are:
|
|
1102
|
-
* * `single`
|
|
1103
|
-
* * `multiple`
|
|
1104
|
-
*
|
|
1105
|
-
* @default "multiple"
|
|
1106
|
-
*/
|
|
1107
|
-
mode?: TreeListSelectableMode;
|
|
1108
|
-
}
|
|
1109
|
-
|
|
1110
|
-
export declare const TreeListSelectionCell: {
|
|
1111
|
-
(props: TreeListSelectionCellProps): JSX.Element | null;
|
|
1112
|
-
displayName: string;
|
|
1113
|
-
};
|
|
1114
|
-
|
|
1115
|
-
export declare interface TreeListSelectionCellProps extends TreeListCellProps {
|
|
1116
|
-
}
|
|
1117
|
-
|
|
1118
|
-
/**
|
|
1119
|
-
* Represents the object of the `onSelectionChange` TreeList event.
|
|
1120
|
-
*/
|
|
1121
|
-
export declare interface TreeListSelectionChangeEvent extends TreeListEvent, TableSelectionChangeEvent<TreeList> {
|
|
1122
|
-
/**
|
|
1123
|
-
* An array of indexes of each parent and current item in the data tree.
|
|
1124
|
-
*/
|
|
1125
|
-
level: number[];
|
|
1126
|
-
}
|
|
1127
|
-
|
|
1128
|
-
/**
|
|
1129
|
-
* Represents the object of the `onSortChange` TreeList event.
|
|
1130
|
-
*/
|
|
1131
|
-
export declare interface TreeListSortChangeEvent extends TreeListEvent {
|
|
1132
|
-
/**
|
|
1133
|
-
* The new `SortDescriptor` according to the user action.
|
|
1134
|
-
*/
|
|
1135
|
-
sort: SortDescriptor[];
|
|
1136
|
-
/**
|
|
1137
|
-
* The field of the column which triggers the event.
|
|
1138
|
-
*/
|
|
1139
|
-
field: string;
|
|
1140
|
-
}
|
|
1141
|
-
|
|
1142
|
-
/**
|
|
1143
|
-
* The settings for sorting the TreeList data.
|
|
1144
|
-
*/
|
|
1145
|
-
export declare type TreeListSortSettings = SortSettings;
|
|
1146
|
-
|
|
1147
|
-
export declare const TreeListTextEditor: {
|
|
1148
|
-
(props: TreeListTextEditorProps): JSX.Element | null;
|
|
1149
|
-
displayName: string;
|
|
1150
|
-
};
|
|
1151
|
-
|
|
1152
|
-
export declare interface TreeListTextEditorProps extends TreeListCellProps {
|
|
1153
|
-
}
|
|
1154
|
-
|
|
1155
|
-
export declare const TreeListTextFilter: React_2.FunctionComponent<TreeListTextFilterProps>;
|
|
1156
|
-
|
|
1157
|
-
export declare interface TreeListTextFilterProps extends FilterComponentProps {
|
|
1158
|
-
/**
|
|
1159
|
-
* The list of the operators.
|
|
1160
|
-
*/
|
|
1161
|
-
operators?: TreeListFilterOperator[];
|
|
1162
|
-
}
|
|
1163
|
-
|
|
1164
|
-
/**
|
|
1165
|
-
* Represents the TreeListToolbar component rendered by the [KendoReact TreeList component](https://www.telerik.com/kendo-react-ui/components/treelist).
|
|
1166
|
-
*/
|
|
1167
|
-
export declare const TreeListToolbar: React_2.ForwardRefExoticComponent<TreeListToolbarProps & React_2.RefAttributes<TreeListToolbarHandle>>;
|
|
1168
|
-
|
|
1169
|
-
export declare type TreeListToolbar = TreeListToolbarHandle;
|
|
1170
|
-
|
|
1171
|
-
/**
|
|
1172
|
-
* Represents the object which is returned from the `ref` callback of the [TreeListToolbar](https://www.telerik.com/kendo-react-ui/components/treelist/api/treelisttoolbar).
|
|
1173
|
-
*
|
|
1174
|
-
* For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
|
|
1175
|
-
*/
|
|
1176
|
-
export declare interface TreeListToolbarHandle {
|
|
1177
|
-
/**
|
|
1178
|
-
* The DOM element of the TreeListToolbar.
|
|
1179
|
-
*/
|
|
1180
|
-
element: HTMLDivElement | null;
|
|
1181
|
-
/**
|
|
1182
|
-
* The props of the TreeListToolbar.
|
|
1183
|
-
*/
|
|
1184
|
-
props: TreeListToolbarProps;
|
|
1185
|
-
}
|
|
1186
|
-
|
|
1187
|
-
/**
|
|
1188
|
-
* The props of the TreeListToolbar component.
|
|
1189
|
-
*/
|
|
1190
|
-
export declare interface TreeListToolbarProps extends ToolbarProps {
|
|
1191
|
-
/**
|
|
1192
|
-
* The React elements that will be rendered inside the toolbar of the TreeList.
|
|
1193
|
-
*/
|
|
1194
|
-
children?: React.ReactNode;
|
|
1195
|
-
}
|
|
1196
|
-
|
|
1197
|
-
export { treeToFlat }
|
|
1198
|
-
|
|
1199
|
-
export { }
|
|
8
|
+
import { TreeList } from './TreeList.js';
|
|
9
|
+
import { TreeListProps } from './interfaces/TreeListProps.js';
|
|
10
|
+
import { TreeListColumnProps } from './interfaces/TreeListColumnProps.js';
|
|
11
|
+
import { TreeListCellProps } from './interfaces/TreeListCellProps.js';
|
|
12
|
+
import { TreeListCell } from './cells/TreeListCell.js';
|
|
13
|
+
import { TreeListHeaderCell } from './header/TreeListHeaderCell.js';
|
|
14
|
+
import { TreeListHeaderCellProps } from './interfaces/TreeListHeaderCellProps.js';
|
|
15
|
+
import { TreeListSelectionCell, TreeListSelectionCellProps } from './cells/TreeListSelectionCell.js';
|
|
16
|
+
import { TreeListHeaderSelectionCell, TreeListHeaderSelectionCellProps } from './header/TreeListHeaderSelectionCell.js';
|
|
17
|
+
import { TreeListRow } from './rows/TreeListRow.js';
|
|
18
|
+
import { TreeListDraggableRow } from './rows/TreeListDraggableRow.js';
|
|
19
|
+
import { TreeListRowProps } from './interfaces/TreeListRowProps.js';
|
|
20
|
+
import { TreeListToolbar, TreeListToolbarHandle } from './TreeListToolbar.js';
|
|
21
|
+
import { TreeListToolbarProps } from './interfaces/TreeListToolbarProps.js';
|
|
22
|
+
import { TreeListNoRecords } from './TreeListNoRecords.js';
|
|
23
|
+
import { TreeListNoRecordsProps } from './interfaces/TreeListNoRecordsProps.js';
|
|
24
|
+
import { TreeListDataStateChangeEvent, TreeListFilterChangeEvent, TreeListSortChangeEvent, TreeListExpandChangeEvent, TreeListSelectionChangeEvent, TreeListItemChangeEvent, TreeListRowClickEvent, TreeListColumnResizeEvent, TreeListColumnReorderEvent, TreeListPageChangeEvent, TreeListRowDragEvent, TreeListColumnMenuFilterChangeEvent, TreeListHeaderSelectionChangeEvent, TreeListEvent, TreeListRowDoubleClickEvent, TreeListRowContextMenuEvent, TreeListDragSelectionReleaseEvent, TreeListKeyDownEvent } from './interfaces/events.js';
|
|
25
|
+
import { TreeListSortSettings, TreeListColumnSortSettings } from './interfaces/TreeListSortSettings.js';
|
|
26
|
+
import { TreeListTextFilter, TreeListTextFilterProps } from './cells/FilterCells/TreeListTextFilter.js';
|
|
27
|
+
import { TreeListNumericFilter, TreeListNumericFilterProps } from './cells/FilterCells/TreeListNumericFilter.js';
|
|
28
|
+
import { TreeListDateFilter, TreeListDateFilterProps } from './cells/FilterCells/TreeListDateFilter.js';
|
|
29
|
+
import { TreeListBooleanFilter, TreeListBooleanFilterProps } from './cells/FilterCells/TreeListBooleanFilter.js';
|
|
30
|
+
import { TreeListTextEditor, TreeListTextEditorProps } from './cells/EditCells/TreeListTextEditor.js';
|
|
31
|
+
import { TreeListNumericEditor, TreeListNumericEditorProps } from './cells/EditCells/TreeListNumericEditor.js';
|
|
32
|
+
import { TreeListBooleanEditor, TreeListBooleanEditorProps } from './cells/EditCells/TreeListBooleanEditor.js';
|
|
33
|
+
import { TreeListDateEditor, TreeListDateEditorProps } from './cells/EditCells/TreeListDateEditor.js';
|
|
34
|
+
import { mapTree, mapTreeItem, getNestedValue } from '@progress/kendo-react-common';
|
|
35
|
+
import { orderBy, filterBy, moveTreeItem, getItemPath, createDataTree, extendDataItem, removeItems, modifySubItems, treeToFlat, flatData, getSelectedState, getSelectedStateFromKeyDown, setSelectedState } from '@progress/kendo-react-data-tools';
|
|
36
|
+
import { DataItemWrapper } from './interfaces/DataItemWrapper.js';
|
|
37
|
+
import { setHeaderRowsTop, tableRowsVirtualization } from './utils/index.js';
|
|
38
|
+
import { TREELIST_COL_INDEX_ATTRIBUTE, TREELIST_ROW_INDEX_ATTRIBUTE, TREELIST_PREVENT_SELECTION_ELEMENT } from './constants/index.js';
|
|
39
|
+
import { TreeListSelectableMode, TreeListSelectableSettings } from './interfaces/TreeListSelectableSettings.js';
|
|
40
|
+
export { TreeList, TreeListProps, TreeListColumnProps, TreeListCell, TreeListCellProps, TreeListRow, TreeListDraggableRow, TreeListRowProps, TreeListHeaderCell, TreeListHeaderCellProps, TreeListSelectionCell, TreeListSelectionCellProps, TreeListHeaderSelectionCell, TreeListHeaderSelectionCellProps, TreeListToolbar, TreeListToolbarProps, TreeListToolbarHandle, TreeListNoRecords, TreeListNoRecordsProps, TreeListSortSettings, TreeListColumnSortSettings, TreeListTextFilter, TreeListTextFilterProps, TreeListNumericFilter, TreeListNumericFilterProps, TreeListDateFilter, TreeListDateFilterProps, TreeListBooleanFilter, TreeListBooleanFilterProps, TreeListTextEditor, TreeListTextEditorProps, TreeListNumericEditor, TreeListNumericEditorProps, TreeListBooleanEditor, TreeListBooleanEditorProps, TreeListDateEditor, TreeListDateEditorProps, TreeListDataStateChangeEvent, TreeListFilterChangeEvent, TreeListColumnMenuFilterChangeEvent, TreeListSortChangeEvent, TreeListExpandChangeEvent, TreeListSelectionChangeEvent, TreeListItemChangeEvent, TreeListHeaderSelectionChangeEvent, TreeListRowClickEvent, TreeListColumnResizeEvent, TreeListColumnReorderEvent, TreeListPageChangeEvent, TreeListRowDragEvent, TreeListEvent, TreeListRowDoubleClickEvent, TreeListRowContextMenuEvent, TreeListDragSelectionReleaseEvent, TreeListKeyDownEvent, orderBy, filterBy, mapTree, createDataTree, extendDataItem, mapTreeItem, moveTreeItem, getItemPath, removeItems, modifySubItems, treeToFlat, DataItemWrapper, flatData, getNestedValue, setHeaderRowsTop, tableRowsVirtualization, TREELIST_COL_INDEX_ATTRIBUTE, TREELIST_ROW_INDEX_ATTRIBUTE, TREELIST_PREVENT_SELECTION_ELEMENT, getSelectedState, getSelectedStateFromKeyDown, setSelectedState, TreeListSelectableSettings, TreeListSelectableMode };
|