Interface GridEventLookup

interface GridEventLookup {
    cellClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellDoubleClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellEditStart: {
        event: KeyboardEvent<HTMLElement> | MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellEditStartParams<any, any, any>;
    };
    cellEditStop: {
        event: MuiBaseEvent;
        params: GridCellEditStopParams<any, any, any>;
    };
    cellKeyDown: {
        event: KeyboardEvent<HTMLElement>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellKeyUp: {
        event: KeyboardEvent<HTMLElement>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellModesModelChange: {
        params: GridCellModesModel;
    };
    cellMouseDown: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellMouseOver: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    cellMouseUp: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridCellParams<any, unknown, unknown, GridTreeNode>;
    };
    clipboardCopy: {
        params: string;
    };
    columnGroupHeaderKeyDown: {
        event: KeyboardEvent<HTMLElement>;
        params: GridColumnGroupHeaderParams;
    };
    columnHeaderClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridColumnHeaderParams<GridValidRowModel, any, any>;
    };
    columnHeaderContextMenu: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridColumnHeaderParams<GridValidRowModel, any, any>;
    };
    columnHeaderDoubleClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridColumnHeaderParams<GridValidRowModel, any, any>;
    };
    columnHeaderKeyDown: {
        event: KeyboardEvent<HTMLElement>;
        params: GridColumnHeaderParams<GridValidRowModel, any, any>;
    };
    columnOrderChange: {
        params: GridColumnOrderChangeParams;
    };
    columnResize: {
        event: MouseEvent;
        params: GridColumnResizeParams;
    };
    columnResizeStart: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: {
            field: string;
        };
    };
    columnResizeStop: {
        event: MouseEvent;
        params: null;
    };
    columnsChange: {
        params: string[];
    };
    columnVisibilityModelChange: {
        params: GridColumnVisibilityModel;
    };
    columnWidthChange: {
        event: {} | MouseEvent;
        params: GridColumnResizeParams;
    };
    debouncedResize: {
        params: ElementSize;
    };
    densityChange: {
        params: GridDensity;
    };
    filterModelChange: {
        params: GridFilterModel;
    };
    headerSelectionCheckboxChange: {
        params: GridHeaderSelectionCheckboxParams;
    };
    menuClose: {
        params: GridMenuParams;
    };
    menuOpen: {
        params: GridMenuParams;
    };
    paginationMetaChange: {
        params: GridPaginationMeta;
    };
    paginationModelChange: {
        params: GridPaginationModel;
    };
    preferencePanelClose: {
        params: GridPreferencePanelParams;
    };
    preferencePanelOpen: {
        params: GridPreferencePanelParams;
    };
    renderedRowsIntervalChange: {
        params: GridRenderContext;
    };
    resize: {
        params: ElementSize;
    };
    rootMount: {
        params: HTMLElement;
    };
    rowClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridRowParams<any>;
    };
    rowCountChange: {
        params: number;
    };
    rowDoubleClick: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridRowParams<any>;
    };
    rowEditStart: {
        event: KeyboardEvent<HTMLElement> | MouseEvent<HTMLElement, MouseEvent>;
        params: GridRowEditStartParams<any>;
    };
    rowEditStop: {
        event: MuiBaseEvent;
        params: GridRowEditStopParams<any>;
    };
    rowExpansionChange: {
        params: GridGroupNode;
    };
    rowModesModelChange: {
        params: GridRowModesModel;
    };
    rowMouseEnter: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridRowParams<any>;
    };
    rowMouseLeave: {
        event: MouseEvent<HTMLElement, MouseEvent>;
        params: GridRowParams<any>;
    };
    rowSelectionChange: {
        params: GridRowSelectionModel;
    };
    rowSelectionCheckboxChange: {
        event: ChangeEvent<HTMLElement>;
        params: GridRowSelectionCheckboxParams;
    };
    scrollPositionChange: {
        event: MuiBaseEvent | UIEvent<Element, UIEvent>;
        params: GridScrollParams;
    };
    sortModelChange: {
        params: GridSortModel;
    };
    stateChange: {
        params: any;
    };
    unmount: {};
    viewportInnerSizeChange: {
        params: ElementSize;
    };
}

Hierarchy (view full)

Properties

cellClick cellDoubleClick cellEditStart cellEditStop cellKeyDown cellKeyUp cellModesModelChange cellMouseDown cellMouseOver cellMouseUp clipboardCopy columnGroupHeaderKeyDown columnHeaderClick columnHeaderContextMenu columnHeaderDoubleClick columnHeaderKeyDown columnOrderChange columnResize columnResizeStart columnResizeStop columnsChange columnVisibilityModelChange columnWidthChange debouncedResize densityChange filterModelChange headerSelectionCheckboxChange menuClose menuOpen paginationMetaChange paginationModelChange preferencePanelClose preferencePanelOpen renderedRowsIntervalChange resize rootMount rowClick rowCountChange rowDoubleClick rowEditStart rowEditStop rowExpansionChange rowModesModelChange rowMouseEnter rowMouseLeave rowSelectionChange rowSelectionCheckboxChange scrollPositionChange sortModelChange stateChange unmount viewportInnerSizeChange

Properties

cellClick

cellClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a cell is clicked.

cellDoubleClick

cellDoubleClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a cell is double-clicked.

cellEditStart

cellEditStart: {
    event: KeyboardEvent<HTMLElement> | MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellEditStartParams<any, any, any>;
}

Fired when the cell turns to edit mode.

cellEditStop

cellEditStop: {
    event: MuiBaseEvent;
    params: GridCellEditStopParams<any, any, any>;
}

Fired when the cell turns back to view mode.

cellKeyDown

cellKeyDown: {
    event: KeyboardEvent<HTMLElement>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a keydown event happens in a cell.

cellKeyUp

cellKeyUp: {
    event: KeyboardEvent<HTMLElement>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a keyup event happens in a cell.

cellModesModelChange

cellModesModelChange: {
    params: GridCellModesModel;
}

Fired when the model that controls the cell modes changes.

cellMouseDown

cellMouseDown: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a mousedown event happens in a cell.

cellMouseOver

cellMouseOver: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a mouseover event happens in a cell.

cellMouseUp

cellMouseUp: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridCellParams<any, unknown, unknown, GridTreeNode>;
}

Fired when a mouseup event happens in a cell.

clipboardCopy

clipboardCopy: {
    params: string;
}

Fired when the data is copied to the clipboard.

columnGroupHeaderKeyDown

columnGroupHeaderKeyDown: {
    event: KeyboardEvent<HTMLElement>;
    params: GridColumnGroupHeaderParams;
}

Fired when a key is pressed in a column group header. It's mapped do the keydown DOM event.

columnHeaderClick

columnHeaderClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridColumnHeaderParams<GridValidRowModel, any, any>;
}

Fired when a column header is clicked

columnHeaderContextMenu

columnHeaderContextMenu: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridColumnHeaderParams<GridValidRowModel, any, any>;
}

Fired when the user attempts to open a context menu in the column header.

columnHeaderDoubleClick

columnHeaderDoubleClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridColumnHeaderParams<GridValidRowModel, any, any>;
}

Fired when a column header is double-clicked.

columnHeaderKeyDown

columnHeaderKeyDown: {
    event: KeyboardEvent<HTMLElement>;
    params: GridColumnHeaderParams<GridValidRowModel, any, any>;
}

Fired when a key is pressed in a column header. It's mapped do the keydown DOM event.

columnOrderChange

columnOrderChange: {
    params: GridColumnOrderChangeParams;
}

Fired when the user ends reordering a column.

columnResize

columnResize: {
    event: MouseEvent;
    params: GridColumnResizeParams;
}

Fired during the resizing of a column.

columnResizeStart

columnResizeStart: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: {
        field: string;
    };
}

Fired when the user starts resizing a column.

columnResizeStop

columnResizeStop: {
    event: MouseEvent;
    params: null;
}

Fired when the user stops resizing a column.

columnsChange

columnsChange: {
    params: string[];
}

Fired when the columns state is changed.

columnVisibilityModelChange

columnVisibilityModelChange: {
    params: GridColumnVisibilityModel;
}

Fired when the column visibility model changes.

columnWidthChange

columnWidthChange: {
    event: {} | MouseEvent;
    params: GridColumnResizeParams;
}

Fired when the width of a column is changed.

debouncedResize

debouncedResize: {
    params: ElementSize;
}

Fired when the grid is resized with a debounced time of 60ms.

densityChange

densityChange: {
    params: GridDensity;
}

Fired when the density changes.

filterModelChange

filterModelChange: {
    params: GridFilterModel;
}

Fired when the filter model changes.

headerSelectionCheckboxChange

headerSelectionCheckboxChange: {
    params: GridHeaderSelectionCheckboxParams;
}

Fired when the value of the selection checkbox of the header is changed.

menuClose

menuClose: {
    params: GridMenuParams;
}

Fired when the grid menu is closed.

menuOpen

menuOpen: {
    params: GridMenuParams;
}

Fired when the menu is opened.

paginationMetaChange

paginationMetaChange: {
    params: GridPaginationMeta;
}

Fired when the pagination meta change.

paginationModelChange

paginationModelChange: {
    params: GridPaginationModel;
}

Fired when the pagination model changes.

preferencePanelClose

preferencePanelClose: {
    params: GridPreferencePanelParams;
}

Fired when the preference panel is closed.

preferencePanelOpen

preferencePanelOpen: {
    params: GridPreferencePanelParams;
}

Fired when the preference panel is opened.

renderedRowsIntervalChange

renderedRowsIntervalChange: {
    params: GridRenderContext;
}

Fired when the rendered rows index interval changes. Called with a [[GridRenderContext]] object.

resize

resize: {
    params: ElementSize;
}

Fired when the grid is resized.

rootMount

rootMount: {
    params: HTMLElement;
}

Fired when rootElementRef.current becomes available.

rowClick

rowClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridRowParams<any>;
}

Fired when a row is clicked. Not fired if the cell clicked is from an interactive column (actions, checkbox, etc).

rowCountChange

rowCountChange: {
    params: number;
}

Fired when the row count change.

rowDoubleClick

rowDoubleClick: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridRowParams<any>;
}

Fired when a row is double-clicked.

rowEditStart

rowEditStart: {
    event: KeyboardEvent<HTMLElement> | MouseEvent<HTMLElement, MouseEvent>;
    params: GridRowEditStartParams<any>;
}

Fired when the row turns to edit mode.

rowEditStop

rowEditStop: {
    event: MuiBaseEvent;
    params: GridRowEditStopParams<any>;
}

Fired when the row turns back to view mode.

rowExpansionChange

rowExpansionChange: {
    params: GridGroupNode;
}

Fired when the expansion of a row is changed. Called with a [[GridGroupNode]] object.

rowModesModelChange

rowModesModelChange: {
    params: GridRowModesModel;
}

Fired when the model that controls the row modes changes.

rowMouseEnter

rowMouseEnter: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridRowParams<any>;
}

Fired when the mouse enters the row. Called with a [[GridRowParams]] object.

rowMouseLeave

rowMouseLeave: {
    event: MouseEvent<HTMLElement, MouseEvent>;
    params: GridRowParams<any>;
}

Fired when the mouse leaves the row. Called with a [[GridRowParams]] object.

rowSelectionChange

rowSelectionChange: {
    params: GridRowSelectionModel;
}

Fired when the selection state of one or multiple rows changes.

rowSelectionCheckboxChange

rowSelectionCheckboxChange: {
    event: ChangeEvent<HTMLElement>;
    params: GridRowSelectionCheckboxParams;
}

Fired when the value of the selection checkbox of a row is changed.

scrollPositionChange

scrollPositionChange: {
    event: MuiBaseEvent | UIEvent<Element, UIEvent>;
    params: GridScrollParams;
}

Fired during the scroll of the grid viewport.

sortModelChange

sortModelChange: {
    params: GridSortModel;
}

Fired when the sort model changes.

stateChange

stateChange: {
    params: any;
}

Fired when the state of the grid is updated.

unmount

unmount: {}

Fired when the grid is unmounted.

viewportInnerSizeChange

viewportInnerSizeChange: {
    params: ElementSize;
}

Fired when the inner size of the viewport changes. Called with an [[ElementSize]] object.

Settings

Member Visibility

On This Page

Properties
cellClickcellDoubleClickcellEditStartcellEditStopcellKeyDowncellKeyUpcellModesModelChangecellMouseDowncellMouseOvercellMouseUpclipboardCopycolumnGroupHeaderKeyDowncolumnHeaderClickcolumnHeaderContextMenucolumnHeaderDoubleClickcolumnHeaderKeyDowncolumnOrderChangecolumnResizecolumnResizeStartcolumnResizeStopcolumnsChangecolumnVisibilityModelChangecolumnWidthChangedebouncedResizedensityChangefilterModelChangeheaderSelectionCheckboxChangemenuClosemenuOpenpaginationMetaChangepaginationModelChangepreferencePanelClosepreferencePanelOpenrenderedRowsIntervalChangeresizerootMountrowClickrowCountChangerowDoubleClickrowEditStartrowEditStoprowExpansionChangerowModesModelChangerowMouseEnterrowMouseLeaverowSelectionChangerowSelectionCheckboxChangescrollPositionChangesortModelChangestateChangeunmountviewportInnerSizeChange