@progress/kendo-vue-grid
Version:
103 lines (102 loc) • 3.31 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 { CompositeFilterDescriptor } from '@progress/kendo-data-query';
import { GridColumnMenuFilterBaseProps } from '../interfaces/GridColumnMenuFilterBaseProps';
import { PropType } from 'vue';
/**
* The props of the GridColumnMenuFilter component.
*/
export interface GridColumnMenuCheckboxFilterProps extends GridColumnMenuFilterBaseProps {
/**
* Controls the expand state of the filter component.
*/
expanded?: boolean;
/**
* Sets the items collection that will be rendered by the GridColumnMenuCheckboxFilter component.
*/
dataItems: Array<string | object>;
/**
* Triggered on each subsequent expand state of the filter component.
*/
expandchange?: (nextExpandState: boolean) => void;
/**
* Defines the component that will be rendered as a search box.
*/
searchBox?: any;
/**
* Determines if the data in the component will be unique. By default the property is set to true.
*/
uniqueData?: boolean;
}
/**
* @hidden
*/
export interface GridColumnMenuFilterStateProps {
expanded: boolean;
value: string;
dataItems: Array<string | object>;
dataFromProps: Array<string | object>;
currentFilter: CompositeFilterDescriptor;
}
/**
* @hidden
*/
declare const GridColumnMenuCheckboxFilter: {
name: string;
props: {
column: PropType<import('../interfaces/GridColumnMenuColumnProps').GridColumnMenuColumnProps>;
filter: PropType<CompositeFilterDescriptor>;
filterable: PropType<boolean>;
filterOperators: PropType<import('../interfaces/GridFilterOperators').GridFilterOperators>;
checkAllItem: PropType<string | boolean | object | Function>;
item: PropType<string | boolean | object | Function>;
expanded: {
type: PropType<boolean>;
default: any;
};
dataItems: PropType<(string | object)[]>;
searchBox: {
type: PropType<any>;
default: boolean;
};
uniqueData: {
type: PropType<boolean>;
default: boolean;
};
};
data(): {
currentExpanded: boolean;
currentValue: string;
dataRef: any;
dataFromProps: any;
currentFilter: any;
};
created(): void;
updated(): void;
inject: {
kendoLocalizationService: {
default: any;
};
};
setup(): {
kendoLocalizationService: {};
};
render(): import("vue/jsx-runtime").JSX.Element;
methods: {
defaultFilter(): any;
parseData(originalData: any, isUnique: any): any;
getFilterIndex(): any;
onFilterExpand(): void;
handleSearchChange(e: any): void;
clear(e: any): void;
submit(e: any): void;
handleCheckBoxChange(e: any, value: any): void;
isAllSelected(): boolean;
};
};
export { GridColumnMenuCheckboxFilter };