@progress/kendo-react-grid
Version:
React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package
68 lines (67 loc) • 2.34 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 { SortDescriptor } from '@progress/kendo-data-query';
import { GridColumnMenuSortBaseProps } from '../interfaces/GridColumnMenuSortBaseProps.js';
import * as React from 'react';
/**
* Can be used to check if sorting is applied to a specific field ([see example](https://www.telerik.com/kendo-react-ui/components/grid/columns/column-menu#toc-styling-the-column-menu-icon)). Useful for creating active sort indicators.
*/
export declare const isColumnMenuSortActive: (field: string, sort?: SortDescriptor[]) => boolean;
/**
* The props of the GridColumnMenuSort component.
*/
export interface GridColumnMenuSortProps extends GridColumnMenuSortBaseProps {
}
/**
* @example
* ```jsx-no-run
* const ColumnMenu = (props) => {
* return (
* <div>
* <GridColumnMenuSort {...props} />
* </div>
* );
* };
*
* const initialState = {
* take: 10,
* skip: 0
* };
*
* const App = () => {
* const [dataState, setDataState] = useState(initialState);
* const [result, setResult] = useState(process(products.slice(0), initialState));
*
* const dataStateChange = (event) => {
* setDataState(event.dataState);
* setResult(process(products.slice(0), event.dataState));
* };
*
* return (
* <div>
* <div>
* <Grid
* data={result}
* {...dataState}
* onDataStateChange={dataStateChange}
* sortable={true}
* pageable={true}
* >
* <Column field="ProductID" title="Product ID" columnMenu={ColumnMenu} />
* <Column field="ProductName" />
* </Grid>
* <br />
* </div>
* </div>
* );
* };
*
* export default App;
* ```
*/
export declare const GridColumnMenuSort: (props: GridColumnMenuSortProps) => React.JSX.Element;