@progress/kendo-react-grid 7.2.4-develop.3 → 7.2.4-develop.4

package/interfaces/GridProps.d.ts

@@ -1,333 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { ComponentType } from 'react';
-import { DataResult, SortDescriptor, CompositeFilterDescriptor, GroupDescriptor } from '@progress/kendo-data-query';
-import { GridGroupableSettings } from './GridGroupableSettings';
-import { GridSortChangeEvent, GridFilterChangeEvent, GridPageChangeEvent, GridExpandChangeEvent, GridSelectionChangeEvent, GridHeaderSelectionChangeEvent, GridRowClickEvent, GridItemChangeEvent, GridDataStateChangeEvent, GridColumnResizeEvent, GridColumnReorderEvent, GridGroupChangeEvent, GridEvent, GridRowDoubleClickEvent, GridNavigationActionEvent, GridKeyDownEvent, GridContextMenuEvent } from './events';
-import { ScrollMode } from '../ScrollMode';
-import { GridCellProps } from './GridCellProps';
-import { GridFilterCellProps } from './GridFilterCellProps';
-import { GridSortSettings } from './GridSortSettings';
-import { GridPagerSettings } from '../paging/GridPagerSettings';
-import { GridRowProps } from '../interfaces/GridRowProps';
-import { GridHeaderCellProps } from '../interfaces/GridHeaderCellProps';
-import { GridDetailRowProps } from '../interfaces/GridDetailRowProps';
-import { GridColumnMenuProps } from '../interfaces/GridColumnMenuProps';
-import { GridFilterOperators } from './GridFilterOperators';
-import { GridSelectableSettings } from './GridSelectableSettings';
-import { ClipboardSettings, ClipboardDataEvent, PagerProps } from '@progress/kendo-react-data-tools';
-import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
-import { GridCellsSettings } from './GridCellsSettings';
-/**
- * Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
- */
-export interface GridProps extends KendoReactComponentBaseProps {
-    /**
-     * Sets the Grid row key prop to the value of this field in the dataItem.
-     * If not set, the dataItem index will be used for the row key, which might lead to row not updated during paging or scrolling.
-     */
-    dataItemKey?: string;
-    /**
-     * Sets a class of the Grid DOM element.
-     */
-    className?: string;
-    /**
-     * Sets a set of custom components that the Grid will render instead of the built-in cell.
-     */
-    cells?: GridCellsSettings;
-    /**
-     * Sets the data of the Grid ([see example]({% slug paging_grid %})). If you use paging, the `data` option has to contain only the items for the current page.
-     */
-    data?: any[] | DataResult | null;
-    /**
-     * Enables the sorting for the columns with their `field` option set ([see example]({% slug sorting_grid %})).
-     */
-    sortable?: GridSortSettings;
-    /**
-     * When set enables the clipboard copy, cut and paste manipulations. It takes values of type [ClipboardSettings]({% slug api_data-tools_clipboardsettings %}) or boolean.
-     */
-    clipboard?: ClipboardSettings | boolean;
-    /**
-     * Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [ClipboardDataEvent]({% slug api_data-tools_clipboarddataevent %}).
-     */
-    onClipboard?: (event: ClipboardDataEvent) => void;
-    /**
-     * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})). You have to handle the event yourself and sort the data.
-     */
-    onSortChange?: (event: GridSortChangeEvent) => void;
-    /**
-     * The descriptors by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
-     */
-    sort?: SortDescriptor[];
-    /**
-     * Enables the filtering of the columns with their `field` option set ([more information and examples]({% slug filtering_grid %})).
-     */
-    filterable?: boolean;
-    /**
-     * The descriptor by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
-     */
-    filter?: CompositeFilterDescriptor;
-    /**
-     * The filter operators for the Grid filters.
-     *
-     * @example
-     * ```jsx
-     * const customFilterOperators = {
-     *     'text': [
-     *         { text: 'grid.filterContainsOperator', operator: 'contains' }
-     *     ],
-     *     'numeric': [
-     *         { text: 'grid.filterGtOperator', operator: 'gt' }
-     *     ],
-     *     'date': [
-     *         { text: 'grid.filterAfterOperator', operator: 'gt' }
-     *     ]
-     * }
-     *
-     * class App extends React.Component {
-     *     constructor(props) {
-     *         super(props);
-     *         this.state = {
-     *             data: [
-     *                 { 'foo': 'A1', 'bar': 'B1' },
-     *                 { 'foo': 'A2', 'bar': 'B2' },
-     *                 { 'foo': 'A3', 'bar': 'B2' }
-     *             ]
-     *         };
-     *     }
-     *     render() {
-     *         return (
-     *             <div>
-     *                 <Grid
-     *                     data={this.state.data}
-     *                     reorderable={true}
-     *                     filterable
-     *                     filterOperators={customFilterOperators}
-     *                 >
-     *                     <GridColumn field="foo" />
-     *                     <GridColumn field="bar" />
-     *                 </Grid>
-     *             </div>
-     *         );
-     *     }
-     * }
-     * ReactDOM.render(<App />, document.querySelector('my-app'));
-     * ```
-     */
-    filterOperators?: GridFilterOperators;
-    /**
-     * Fires when the Grid filter is modified through the UI ([more information and examples]({% slug filtering_grid %})). You have to handle the event yourself and filter the data.
-     */
-    onFilterChange?: (event: GridFilterChangeEvent) => void;
-    /**
-     * Specifies a React element that will be cloned and rendered inside the column menu of the Grid. Can be overridden on column level.
-     */
-    columnMenu?: null | ComponentType<GridColumnMenuProps>;
-    /**
-     * The descriptors by which the data will be grouped
-     * ([more information and examples]({% slug groupingbasics_grid %})).
-     */
-    group?: GroupDescriptor[];
-    /**
-     * Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
-     * ([more information and examples]({% slug groupingbasics_grid %})).
-     */
-    onGroupChange?: (event: GridGroupChangeEvent) => void;
-    /**
-     * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
-     *
-     * The available options are:
-     * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed.
-     * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records.
-     * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values.
-     * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size.
-     * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons.
-     */
-    pageable?: GridPagerSettings | boolean;
-    /**
-     * Defines the page size that is used by the Grid pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
-     */
-    pageSize?: number;
-    /**
-     * The pager component that the Grid will render instead of the built-in pager.
-     */
-    pager?: null | ComponentType<PagerProps>;
-    /**
-     * Alias of `pageSize` property. If `take` is set, `pageSize` will be ignored.
-     */
-    take?: number;
-    /**
-     * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})). You have to handle the event yourself and page the data.
-     */
-    onPageChange?: (event: GridPageChangeEvent) => void;
-    /**
-     * Defines the total number of data items in all pages ([see example]({% slug paging_grid %})). Required by the paging functionality.
-     */
-    total?: number;
-    /**
-     * Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
-     */
-    skip?: number;
-    /**
-     * Determines if the scroll position will be updated after data change. If set to `true` the scroll will remain on the same position.
-     */
-    fixedScroll?: boolean;
-    /**
-     * Fires when the user tries to expand or collapse a row.
-     */
-    onExpandChange?: (event: GridExpandChangeEvent) => void;
-    /**
-     * Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
-     */
-    expandField?: string;
-    /**
-     * The Grid selectable settings.
-     */
-    selectable?: GridSelectableSettings;
-    /**
-     * Specifies the name of the field which will provide a:
-     * - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
-     * - String array of the selected columns of the item  for cell selection
-     */
-    selectedField?: string;
-    /**
-     * Fires when the user tries to select or deselect a row or cell.
-     */
-    onSelectionChange?: (event: GridSelectionChangeEvent) => void;
-    /**
-     * Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField` ([more information and example]({% slug selection_grid %})).
-     */
-    onHeaderSelectionChange?: (event: GridHeaderSelectionChangeEvent) => void;
-    /**
-     * Fires when the user clicks a row.
-     */
-    onRowClick?: (event: GridRowClickEvent) => void;
-    /**
-     * Fires when the user double clicks a row.
-     */
-    onRowDoubleClick?: (event: GridRowDoubleClickEvent) => void;
-    /**
-     * Fires when the user changes the values of the item. The event is not debounced and fires on every `onChange` event of the input in the current `EditCell` ([more information and examples]({% slug editing_inline_grid %})).
-     */
-    onItemChange?: (event: GridItemChangeEvent) => void;
-    /**
-     * Specifies the name of the field which will provide a Boolean representation of the edit state of the current item ([more information and examples]({% slug editing_inline_grid %})).
-     */
-    editField?: string;
-    /**
-     * Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmodes_grid %})).
-     *
-     * The available options are:
-     *  - `none`&mdash;Renders no scrollbar.
-     *  - `scrollable`&mdash;This is the default scroll mode. It requires the setting of the `height` option.
-     *  - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
-     */
-    scrollable?: ScrollMode;
-    /**
-     * Defines the row height and forces an equal height to all rows ([see example]({% slug scrollmodes_grid %})).
-     */
-    rowHeight?: number;
-    /**
-     * Defines the detail row height and forces an equal height to all detail rows.
-     */
-    detailRowHeight?: number;
-    /**
-     * Specifies a React element that will be cloned and rendered inside the detail rows of the currently expanded items ([see example]({% slug hierarchy_grid %})). An item will be rendered as expanded if the value of its `expandField` is `true`.
-     */
-    detail?: null | ComponentType<GridDetailRowProps>;
-    /**
-     * Represents the `style` HTML attribute.
-     */
-    style?: React.CSSProperties;
-    /**
-     * Fires when the data state of the Grid is changed ([more information]({% slug localoperations_grid %}) and [example]({% slug odataserveroperations_grid %})).
-     */
-    onDataStateChange?: (event: GridDataStateChangeEvent) => void;
-    /**
-     * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells ([see example]({% slug resizing_columns_grid %})).
-     */
-    resizable?: boolean;
-    /**
-     * If set to `true`, the user can reorder columns by dragging their header cells ([see example]({% slug reordering_columns_grid %})).
-     */
-    reorderable?: boolean;
-    /**
-     * Determines if grouping by dragging and dropping the column headers is allowed ([more information and examples]({% slug groupingbasics_grid %})).
-     */
-    groupable?: GridGroupableSettings | boolean;
-    /**
-     * Fires when a column is resized.
-     */
-    onColumnResize?: (event: GridColumnResizeEvent) => void;
-    /**
-     * Fires when the columns are reordered.
-     */
-    onColumnReorder?: (event: GridColumnReorderEvent) => void;
-    /**
-     * Fires when a row is about to be rendered. Overrides the default appearance of the row.
-     */
-    rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
-    /**
-     * Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
-     */
-    cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
-    /**
-     * Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
-     */
-    filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
-    /**
-     * Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
-     */
-    headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
-    /**
-     * Fires when Grid is scrolled.
-     */
-    onScroll?: (event: GridEvent) => void;
-    /**
-     * Enables virtualization of the columns. If virtualization is enabled, the columns outside the view are not rendered.
-     */
-    columnVirtualization?: boolean;
-    /**
-     * If set to `true`, the user can use dedicated shortcuts to interact with the Grid.
-     * By default, navigation is disabled and the Grid content is accessible in the normal tab sequence.
-     */
-    navigatable?: boolean;
-    /**
-     * Fires when Grid keyboard navigation position is changed.
-     */
-    onNavigationAction?: (event: GridNavigationActionEvent) => void;
-    /**
-     * Fires when the user press keyboard key.
-     */
-    onKeyDown?: (event: GridKeyDownEvent) => void;
-    /**
-     * The accessible label of the Grid.
-     */
-    ariaLabel?: string;
-    /**
-     * Defines if the group descriptor columns are locked (frozen or sticky).
-     * Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
-     * Defaults to `false`.
-     */
-    lockGroups?: boolean;
-    /**
-     * Configures the `size` of the Grid.
-     *
-     * The available options are:
-     * - small
-     * - medium
-     *
-     * @default `medium`
-     */
-    size?: 'small' | 'medium';
-    /**
-     * The event that is fired when the ContextMenu is activated.
-     */
-    onContextMenu?: (event: GridContextMenuEvent) => void;
-    /**
-     * Sets the `id` property of the top div element of the component.
-     */
-    id?: string;
-}

package/interfaces/GridRowProps.d.ts

@@ -1,67 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
-import { GridRowType } from './GridRowType';
-/**
- * The props that the Grid passes to the GridRow component when creating it. Accessible during the `rowRender` callback of the Grid.
- */
-export interface GridRowProps extends KendoReactComponentBaseProps {
-    /**
-     * The `data` object that represents the current row.
-     */
-    dataItem: any;
-    /**
-     * Indicates whether the row is an alternating row.
-     */
-    isAltRow: boolean;
-    /**
-     * Indicates whether the row has at least one edit cell.
-     */
-    isInEdit: boolean;
-    /**
-     * Indicates if the row is hidden. The hidden row is rendered above the visible area of the Grid. Occurs when the Grid uses virtualization and the row is on the current page. When `rowHeight` is set, `isHidden` is always `true`.
-     */
-    isHidden: boolean;
-    /**
-     * The event that is fired when the row is clicked.
-     */
-    onClick: any;
-    /**
-     * The event that is fired when the row is double clicked.
-     */
-    onDoubleClick: any;
-    /**
-     * The name of the field which will provide a Boolean representation of the selected state of the item.
-     */
-    selectedField?: string;
-    /**
-     * Sets the height of the row.
-     */
-    rowHeight?: number;
-    /**
-     * The type of the row.
-     */
-    rowType: GridRowType;
-    /**
-     * A function for overriding the default rendering of the row.
-     */
-    render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
-    /**
-     * The index to be applied to the `aria-rowindex` attribute.
-     */
-    ariaRowIndex?: number;
-    /**
-     * The index of the leaf dataItem in data. Used by selection.
-     */
-    dataIndex: number;
-    /**
-     * Indicates if the row is selected.
-     */
-    isSelected: boolean;
-    /**
-     * @hidden
-     */
-    absoluteRowIndex: number;
-}

package/interfaces/GridRowType.d.ts

@@ -1,13 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- * The type of the GridRow component.
- *
- * The available values are:
- * - `groupHeader`—The row is a group header.
- * - `groupFooter`—The row is a group footer.
- * - `data`—The row corresponds to an item from the `data` collection which is passed to the Grid.
- */
-export type GridRowType = 'groupFooter' | 'groupHeader' | 'data';

package/interfaces/GridSelectableSettings.d.ts

@@ -1,22 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { TableSelectableMode, TableSelectableSettings } from '@progress/kendo-react-data-tools';
-/**
- * Represents the available selection modes.
- */
-export type GridSelectableMode = TableSelectableMode;
-/**
- * Represents the Grid selectable settings.
- */
-export interface GridSelectableSettings extends TableSelectableSettings {
-    /**
-     * The available values are:
-     * * `single`
-     * * `multiple`
-     *
-     * @default "multiple"
-     */
-    mode?: GridSelectableMode;
-}

package/interfaces/GridSortSettings.d.ts

@@ -1,17 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { ColumnSortSettings, SortSettings } from '@progress/kendo-react-data-tools';
-/**
- * The settings for sorting the Grid columns.
- */
-export type GridColumnSortSettings = ColumnSortSettings;
-/**
- * The settings for sorting the Grid data.
- */
-export type GridSortSettings = SortSettings;
-/**
- * @hidden
- */
-export declare const normalize: (...settings: (GridSortSettings | GridColumnSortSettings)[]) => any;

package/interfaces/GridToolbarProps.d.ts

@@ -1,37 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- * The properties of the GridToolbar component.
- */
-export interface GridToolbarProps {
-    /**
-     * The React elements that will be rendered inside the toolbar of the Grid.
-     */
-    children?: React.ReactNode;
-    /**
-     * Specifies the name of the CSS class which is set to the GridToolbar.
-     */
-    className?: string;
-    /**
-     * Configures the `size` of the Toolbar.
-     *
-     * The available options are:
-     * - small
-     * - medium
-     * - large
-     * - null—Does not set a size `className`.
-     *
-     * @default `medium`
-     */
-    size?: null | 'small' | 'medium' | 'large';
-    /**
-     * The accessible label of the GridToolbar component.
-     */
-    ariaLabel?: string;
-    /**
-     * @hidden
-     */
-    ariaControls?: string;
-}

package/interfaces/VirtualScrollInterface.d.ts

@@ -1,31 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { Page } from '../paging/Page';
-import { SyntheticEvent, RefObject } from 'react';
-import { RowHeightService } from '../VirtualScrollFixed';
-/**
- * @hidden
- */
-export interface VirtualScrollInterface {
-    get container(): HTMLDivElement | null;
-    askedSkip: number | undefined;
-    total: number;
-    reset: () => void;
-    table: HTMLTableElement | null;
-    tableBodyRef: RefObject<HTMLTableSectionElement>;
-    fixedScroll: boolean;
-    PageChange: ((event: Page, syntheticEvent: SyntheticEvent<any>) => void) | null;
-    realSkip: number;
-    pageSize: number;
-    scrollableVirtual: boolean;
-    propsSkip: number;
-    topCacheCount: number;
-    attendedSkip: number;
-    containerHeight: number;
-    containerRef: RefObject<HTMLDivElement>;
-    scrollHandler(e: SyntheticEvent<HTMLDivElement>): void;
-    rowHeightService?: RowHeightService;
-    tableTransform: string;
-}