@progress/kendo-react-grid
Version:
React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package
73 lines (72 loc) • 2.59 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 { CompositeFilterDescriptor } from '@progress/kendo-data-query';
import { GridColumnMenuFilterUIProps } from '../interfaces/GridColumnMenuFilterUIProps.js';
import { ComponentType } from 'react';
import * as React from 'react';
export interface GridToolbarFilterProps {
/**
* Defines the icon rendered in the GridToolbarFilter tool ([see example](https://www.telerik.com/kendo-react-ui/components/common/icon)).
*
* @example
* ```jsx
* <GridToolbarFilter icon="home" />
* ```
*/
icon?: string;
/**
* Defines the SVG icon rendered in the GridToolbarFilter tool ([see example](https://www.telerik.com/kendo-react-ui/components/common/svgicon)).
*
* @example
* ```jsx
* import { gearIcon } from '@progress/kendo-svg-icons';
*
* <GridToolbarFilter svgIcon={gearIcon} />
* ```
*/
svgIcon?: SVGIcon;
/**
* If set to `false`, the second filter operator and the input will be hidden.
*/
hideSecondFilter?: boolean;
/**
* Specifies a React element that will be cloned and rendered inside the UI of the column-menu filter component
* ([see example](https://www.telerik.com/kendo-react-ui/components/grid/columns/column-menu#toc-customizing-the-filter-component)).
*/
filterUI?: ComponentType<GridColumnMenuFilterUIProps>;
/**
* Specifies if the popup will be displayed.
*
* @example
* ```jsx
* <GridToolbarFilter show={true} />
* ```
*/
show?: boolean;
/**
* The method that will be called to close the column menu.
*
* @example
* ```jsx
* <GridToolbarFilter onCloseMenu={() => console.log('close menu');} />
* ```
*/
onCloseMenu?: Function;
/**
* The method that will be called to notify the parent Grid about a filter change.
*/
onFilterChange?: (filter: CompositeFilterDescriptor | null, syntheticEvent: React.SyntheticEvent<any>) => any;
}
/**
* Represents the GridToolbarFilter component.
*/
export declare const GridToolbarFilter: {
(props: GridToolbarFilterProps): React.JSX.Element;
displayName: string;
};