@progress/kendo-vue-grid
Version:
210 lines (209 loc) • 9.07 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { PropType } from 'vue';
declare const gridProps: {
id: PropType<string>;
autoProcessData: PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
topCacheCount: {
type: PropType<number>;
default: number;
};
collapsedGroups: {
type: PropType<any[][]>;
default: () => any[];
};
uniqueField: PropType<string>;
totalGroupedHeight: PropType<number>;
allGroupedItems: PropType<import('@progress/kendo-data-query').DataResult>;
alternatePerGroup: PropType<boolean>;
columns: PropType<import('.').GridColumnProps[]>;
columnsState: {
type: PropType<import('.').GridColumnState[]>;
default: () => any;
};
cells: PropType<import('.').GridCellsSettings>;
contextMenu: PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
rows: PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
defaultColumnsState: {
type: PropType<import('.').GridColumnState[]>;
default: () => any;
};
columnVirtualization: PropType<boolean>;
dataItems: PropType<any[] | import('@progress/kendo-data-query').DataResult>;
sortable: PropType<import('.').GridSortSettings>;
defaultSort: PropType<import('@progress/kendo-data-query').SortDescriptor[]>;
sort: PropType<import('@progress/kendo-data-query').SortDescriptor[]>;
filterable: PropType<boolean>;
filterOperators: PropType<import('./interfaces/GridFilterOperators').GridFilterOperators>;
filterCellRender: PropType<any>;
headerCellRender: PropType<any>;
showLoader: {
type: PropType<boolean>;
default: any;
};
loader: PropType<string | Object | Function>;
lockGroups: PropType<boolean>;
pinnable: PropType<boolean>;
defaultPinnedTopRows: PropType<any[]>;
defaultPinnedBottomRows: PropType<any[]>;
pinnedTopRows: PropType<any[]>;
pinnedBottomRows: PropType<any[]>;
defaultFilter: PropType<import('@progress/kendo-data-query').CompositeFilterDescriptor>;
filter: PropType<import('@progress/kendo-data-query').CompositeFilterDescriptor>;
defaultSearch: PropType<import('@progress/kendo-data-query').CompositeFilterDescriptor>;
search: PropType<import('@progress/kendo-data-query').CompositeFilterDescriptor>;
searchFields: PropType<(string | import('@progress/kendo-vue-data-tools').SearchField)[]>;
highlight: PropType<{
[id: string]: boolean | {
[id: string]: boolean;
};
}>;
pageable: PropType<any>;
pageSize: PropType<number>;
total: PropType<number>;
fixedScroll: PropType<boolean>;
skip: PropType<number>;
defaultSkip: PropType<number>;
take: PropType<number>;
defaultTake: PropType<number>;
expandField: PropType<string>;
expandColumn: PropType<import('.').GridColumnProps>;
selectedField: PropType<string>;
cellRender: PropType<string | boolean | ((h: any, defaultRendering: any, props: import('.').GridCellProps, listeners: any) => any)>;
rowRender: PropType<string | boolean | ((h: any, defaultRendering: any, defaultSlots: any, props: any, listeners: any) => any)>;
rowSpannable: PropType<boolean | import('./interfaces/GridRowSpannableSettings').GridRowSpannableSettings>;
resizable: PropType<boolean>;
reorderable: PropType<boolean>;
group: PropType<import('@progress/kendo-data-query').GroupDescriptor[]>;
defaultGroup: PropType<import('@progress/kendo-data-query').GroupDescriptor[]>;
groupable: PropType<boolean | import('.').GridGroupableSettings>;
groupExpand: PropType<import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[]>;
defaultGroupExpand: PropType<import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[]>;
detailExpand: PropType<import('@progress/kendo-vue-data-tools').DetailExpandDescriptor>;
defaultDetailExpand: PropType<import('@progress/kendo-vue-data-tools').DetailExpandDescriptor>;
editField: PropType<string>;
rowClass: PropType<Function>;
select: PropType<import('@progress/kendo-vue-data-tools').SelectDescriptor>;
defaultSelect: PropType<import('@progress/kendo-vue-data-tools').SelectDescriptor>;
selectable: PropType<boolean | import('./interfaces/GridSelectableSettings').GridSelectableSettings>;
scrollable: {
type: PropType<string>;
default: string;
};
size: {
type: PropType<string>;
default: string;
validator: (value: string) => any;
};
dir: PropType<string>;
pager: PropType<string | boolean | Object | Function>;
rowHeight: PropType<number>;
detailRowHeight: PropType<number>;
detail: PropType<any>;
columnMenu: PropType<any>;
columnMenuAnimate: {
type: PropType<boolean | import('@progress/kendo-vue-popup').PopupAnimation>;
default: () => boolean;
};
columnMenuIcon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
name: StringConstructor;
icon: ObjectConstructor;
themeColor: {
type: StringConstructor;
};
size: {
type: StringConstructor;
};
flip: {
type: StringConstructor;
};
fillMode: {
type: StringConstructor;
};
variant: {
type: StringConstructor;
};
id: StringConstructor;
ariaLabel: StringConstructor;
title: StringConstructor;
viewBox: {
type: StringConstructor;
default: string;
};
tabIndex: NumberConstructor;
svgClassName: StringConstructor;
svgStyle: ObjectConstructor;
}>, {}, {}, {
wrapperClass(this: import('@progress/kendo-vue-common').SvgIconAll): {
[x: string]: any;
[x: number]: any;
'k-icon': boolean;
'k-svg-icon': boolean;
'k-flip-h': boolean;
'k-flip-v': boolean;
};
}, {
handleClick(e: any): void;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
click: any;
}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
name: StringConstructor;
icon: ObjectConstructor;
themeColor: {
type: StringConstructor;
};
size: {
type: StringConstructor;
};
flip: {
type: StringConstructor;
};
fillMode: {
type: StringConstructor;
};
variant: {
type: StringConstructor;
};
id: StringConstructor;
ariaLabel: StringConstructor;
title: StringConstructor;
viewBox: {
type: StringConstructor;
default: string;
};
tabIndex: NumberConstructor;
svgClassName: StringConstructor;
svgStyle: ObjectConstructor;
}>> & Readonly<{
onClick?: (...args: any[] | unknown[]) => any;
}>, {
viewBox: string;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
dataItemKey: StringConstructor;
navigatable: {
type: PropType<boolean>;
default: boolean;
};
onItemchange: PropType<(event: import('.').GridItemChangeEvent) => void>;
onExpandchange: PropType<(event: import('.').GridExpandChangeEvent) => void>;
onDatastatechange: PropType<(event: import('.').GridDataStateChangeEvent) => void>;
onPagechange: PropType<(event: import('.').GridPageChangeEvent) => void>;
onSortchange: PropType<(event: import('.').GridSortChangeEvent) => void>;
onFilterchange: PropType<(event: import('.').GridFilterChangeEvent) => void>;
onGroupchange: PropType<(event: import('.').GridGroupChangeEvent) => void>;
onSearchchange: PropType<(event: import('.').GridSearchChangeEvent) => void>;
onGroupexpandchange: PropType<(event: import('.').GridGroupExpandChangeEvent) => void>;
onDetailexpandchange: PropType<(event: import('.').GridDetailExpandChangeEvent) => void>;
onContextmenu: PropType<(event: import('.').GridContextMenuEvent) => void>;
onContextmenuitemclick: PropType<(event: import('.').GridContextMenuItemClickEvent) => void>;
clipboard: PropType<boolean | import('@progress/kendo-vue-data-tools').ClipboardSettings>;
onClipboard: PropType<(event: import('@progress/kendo-vue-data-tools').GridClipboardEvent) => void>;
csv: PropType<boolean | import('./interfaces/GridProps').GridCSVExportOptions>;
onCsvexport: PropType<(data: any[]) => any[]>;
};
export { gridProps };