@progress/kendo-react-grid
Version:
React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package
90 lines (89 loc) • 2.75 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 { SVGIcon } from '@progress/kendo-react-common';
import * as React from 'react';
export interface GridToolbarCheckboxFilterProps {
/**
* Sets the items collection that will be rendered by the GridToolbarCheckboxFilter component.
*/
data: Array<string | object>;
/**
* Defines the icon rendered in the GridToolbarCheckboxFilter tool ([see example](https://www.telerik.com/kendo-react-ui/components/common/icon)).
*
* @example
* ```jsx
* <GridToolbarCheckboxFilter icon="home" />
* ```
*/
icon?: string;
/**
* Defines the SVG icon rendered in the GridToolbarCheckboxFilter tool ([see example](https://www.telerik.com/kendo-react-ui/components/common/svgicon)).
*
* @example
* ```jsx
* import { gearIcon } from '@progress/kendo-svg-icons';
*
* <GridToolbarCheckboxFilter svgIcon={gearIcon} />
* ```
*/
svgIcon?: SVGIcon;
/**
* Defines the component that will be rendered as a search box.
*
*/
searchBox?: React.ComponentType<any>;
/**
* Defines the filter operator that will be used to filter the values via the search box.
* "startswith"
* "endswith"
* "contains"
* "doesnotcontain"
* "isempty"
* "isnotempty"
* "eq" (equal to)
* "eq" (equal to)
* "neq" (not equal to)
* "isnull" (is equal to null)
* "isnotnull" (is not equal to null)
*/
searchBoxFilterOperator?: string | Function;
/**
* Determines if the data in the component will be unique. By default the property is set to true.
*
* @example
* ```jsx
* <GridToolbarCheckboxFilter uniqueData={true} />
* ```
*/
uniqueData?: boolean;
/**
* Specifies if the popup will be displayed.
*
* @example
* ```jsx
* <GridToolbarCheckboxFilter show={true} />
* ```
*/
show?: boolean;
/**
* The method that will be called to close the column menu.
*
* @example
* ```jsx
* <GridToolbarCheckboxFilter onCloseMenu={() => console.log('close menu');} />
* ```
*/
onCloseMenu?: Function;
}
/**
* Represents the GridToolbarCheckboxFilter component.
*/
export declare const GridToolbarCheckboxFilter: {
(props: GridToolbarCheckboxFilterProps): React.JSX.Element;
displayName: string;
};