@deephaven/grid 0.7.3-beta.8 → 0.8.0

package/dist/Grid.d.ts

@@ -1,4 +1,64 @@
-export default Grid;
+import React, { PureComponent, ReactNode } from 'react';
+import GridMetricCalculator, { GridMetricState } from './GridMetricCalculator';
+import GridModel from './GridModel';
+import GridMouseHandler, { GridMouseEvent, GridMouseHandlerFunctionName } from './GridMouseHandler';
+import { GridTheme as GridThemeType } from './GridTheme';
+import GridRange, { GridRangeIndex, SELECTION_DIRECTION } from './GridRange';
+import GridRenderer, { EditingCell, EditingCellTextSelectionRange } from './GridRenderer';
+import { GridPoint } from './GridUtils';
+import './Grid.scss';
+import KeyHandler, { GridKeyboardEvent } from './KeyHandler';
+import GridMetrics, { Coordinate, ModelIndex, MoveOperation, VisibleIndex } from './GridMetrics';
+export declare type GridProps = typeof Grid.defaultProps & {
+    canvasOptions?: CanvasRenderingContext2DSettings;
+    isStickyBottom?: boolean;
+    isStickyRight?: boolean;
+    metricCalculator?: GridMetricCalculator;
+    model: GridModel;
+    keyHandlers?: KeyHandler[];
+    mouseHandlers?: GridMouseHandler[];
+    movedColumns?: MoveOperation[];
+    movedRows?: MoveOperation[];
+    onError?: (e: Error) => void;
+    onSelectionChanged?: (ranges: GridRange[]) => void;
+    onMovedColumnsChanged?: (movedColumns: MoveOperation[]) => void;
+    onMovedRowsChanged?: (movedRows: MoveOperation[]) => void;
+    onMoveColumnComplete?: (movedColumns: MoveOperation[]) => void;
+    onMoveRowComplete?: (movedRows: MoveOperation[]) => void;
+    onViewChanged?: (metrics: GridMetrics) => void;
+    renderer?: GridRenderer;
+    stateOverride?: Record<string, unknown>;
+    theme?: GridThemeType;
+};
+export declare type GridState = {
+    top: VisibleIndex;
+    left: VisibleIndex;
+    topOffset: number;
+    leftOffset: number;
+    draggingColumn: VisibleIndex | null;
+    draggingRow: VisibleIndex | null;
+    draggingColumnOffset: number | null;
+    draggingRowOffset: number | null;
+    draggingColumnSeparator: VisibleIndex | null;
+    draggingRowSeparator: VisibleIndex | null;
+    isDraggingHorizontalScrollBar: boolean;
+    isDraggingVerticalScrollBar: boolean;
+    isDragging: boolean;
+    mouseX: number | null;
+    mouseY: number | null;
+    movedColumns: MoveOperation[];
+    movedRows: MoveOperation[];
+    cursorRow: VisibleIndex | null;
+    cursorColumn: VisibleIndex | null;
+    selectionStartRow: VisibleIndex | null;
+    selectionStartColumn: VisibleIndex | null;
+    selectionEndRow: VisibleIndex | null;
+    selectionEndColumn: VisibleIndex | null;
+    selectedRanges: GridRange[];
+    lastSelectedRanges: GridRange[];
+    cursor: string | null;
+    editingCell: EditingCell | null;
+};
 /**
  * High performance, extendible, themeable grid component.
  * Architectured to be fast and handle billions of rows/columns by default.
@@ -13,131 +73,123 @@ export default Grid;
  * Add an onViewChanged callback to page in/out data as user moves around the grid
  * Can also add onClick and onContextMenu handlers to add custom functionality and menus.
  */
-declare class Grid extends React.PureComponent<any, any, any> {
+declare class Grid extends PureComponent<GridProps, GridState> {
+    static defaultProps: {
+        canvasOptions: CanvasRenderingContext2DSettings;
+        isStickyBottom: boolean;
+        isStickyRight: boolean;
+        keyHandlers: KeyHandler[];
+        mouseHandlers: GridMouseHandler[];
+        movedColumns: MoveOperation[];
+        movedRows: MoveOperation[];
+        onError: () => void;
+        onSelectionChanged: () => void;
+        onMovedColumnsChanged: () => void;
+        onMoveColumnComplete: () => void;
+        onMovedRowsChanged: () => void;
+        onMoveRowComplete: () => void;
+        onViewChanged: () => void;
+        stateOverride: Record<string, unknown>;
+        theme: GridThemeType;
+    };
     static pixelsPerLine: number;
     static dragTimeout: number;
     static getTheme: (this: any, userTheme: any) => any;
-    static getScale(context: any): number;
-    static getCursorClassName(cursor: any): string | null;
-    constructor(props: any);
-    handleClick(event: any): void;
-    handleContextMenu(event: any): void;
-    handleEditCellCancel(): void;
-    handleEditCellChange(value: any): void;
-    handleEditCellCommit(value: any, { direction, fillRange }?: {
-        direction?: import("./GridRange").SELECTION_DIRECTION | undefined;
-        fillRange?: boolean | undefined;
-    }): void;
-    handleDoubleClick(event: any): void;
-    handleKeyDown(e: any): void;
-    handleMouseDown(event: any): void;
-    handleMouseDrag(event: any): void;
-    handleMouseMove(event: any): void;
-    handleMouseLeave(event: any): void;
-    handleMouseUp(event: any): void;
-    handleResize(): void;
-    handleWheel(e: any): void;
-    renderer: any;
-    metricCalculator: any;
+    /**
+     * On some devices there may be different scaling required for high DPI. Get the scale required for the canvas.
+     * @param context The canvas context
+     * @returns The scale to use
+     */
+    static getScale(context: CanvasRenderingContext2D): number;
+    /**
+     * Get the class name from the cursor provided
+     * @param cursor The grid cursor to use
+     * @returns Class name with the grid-cursor prefix or null if no cursor provided
+     */
+    static getCursorClassName(cursor: string | null): string | null;
+    renderer: GridRenderer;
+    metricCalculator: GridMetricCalculator;
     canvas: HTMLCanvasElement | null;
-    canvasContext: RenderingContext | null;
-    animationFrame: any;
-    prevMetrics: any;
-    metrics: any;
+    canvasContext: CanvasRenderingContext2D | null;
+    animationFrame: number | null;
+    prevMetrics: GridMetrics | null;
+    metrics: GridMetrics | null;
     isStuckToBottom: boolean;
     isStuckToRight: boolean;
     documentCursor: string | null;
-    dragTimer: NodeJS.Timeout | null;
-    keyHandlers: (SelectionKeyHandler | TreeKeyHandler | EditKeyHandler | PasteKeyHandler)[];
-    mouseHandlers: (EditMouseHandler | GridSelectionMouseHandler | GridColumnMoveMouseHandler | GridColumnSeparatorMouseHandler | GridHorizontalScrollBarMouseHandler | GridRowMoveMouseHandler | GridRowSeparatorMouseHandler | GridRowTreeMouseHandler | GridScrollBarCornerMouseHandler | GridVerticalScrollBarMouseHandler)[];
-    getTheme(): any;
-    getGridPointFromEvent(event: any): import("./GridUtils").GridPoint;
-    getGridPointFromXY(x: any, y: any): import("./GridUtils").GridPoint;
-    getMetricState(state?: {
-        top: number;
-        left: number;
-        topOffset: number;
-        leftOffset: number;
-        draggingColumn: null;
-        draggingRow: null;
-        draggingColumnOffset: null;
-        draggingRowOffset: null;
-        draggingColumnSeparator: null;
-        draggingRowSeparator: null;
-        isDraggingHorizontalScrollBar: boolean;
-        isDraggingVerticalScrollBar: boolean;
-        isDragging: boolean;
-        mouseX: null;
-        mouseY: null;
-        movedColumns: any;
-        movedRows: any;
-        cursorRow: null;
-        cursorColumn: null;
-        selectionStartRow: null;
-        selectionStartColumn: null;
-        selectionEndRow: null;
-        selectionEndColumn: null;
-        selectedRanges: never[];
-        lastSelectedRanges: never[];
-        cursor: null;
-        editingCell: null;
-    }): any;
-    getCachedKeyHandlers: (this: any, keyHandlers: any) => any[];
-    getKeyHandlers(): any[];
-    getCachedMouseHandlers: (this: any, mouseHandlers: any) => any[];
-    getMouseHandlers(): any[];
-    getModelColumn(columnIndex: any): any;
-    getModelRow(rowIndex: any): any;
-    toggleRowExpanded(row: any): void;
-    /** Allows the selected range to be set programatically */
-    setSelectedRanges(gridRanges: any): void;
+    dragTimer: ReturnType<typeof setTimeout> | null;
+    keyHandlers: KeyHandler[];
+    mouseHandlers: GridMouseHandler[];
+    constructor(props: GridProps);
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: GridProps, prevState: GridState): void;
+    componentWillUnmount(): void;
+    getTheme(): GridThemeType;
+    getGridPointFromEvent(event: GridMouseEvent): GridPoint;
+    getGridPointFromXY(x: Coordinate, y: Coordinate): GridPoint;
+    getMetricState(state?: Readonly<GridState>): GridMetricState;
+    getCachedKeyHandlers: (keyHandlers: KeyHandler[]) => KeyHandler[];
+    getKeyHandlers(): KeyHandler[];
+    getCachedMouseHandlers: (mouseHandlers: GridMouseHandler[]) => GridMouseHandler[];
+    getMouseHandlers(): GridMouseHandler[];
+    /**
+     * Translate from the provided visible index to the model index
+     * @param columnIndex The column index to get the model for
+     * @returns The model index
+     */
+    getModelColumn(columnIndex: VisibleIndex): ModelIndex;
+    /**
+     * Translate from the provided visible index to the model index
+     * @param rowIndex The row index to get the model for
+     * @returns The model index
+     */
+    getModelRow(rowIndex: VisibleIndex): ModelIndex;
+    /**
+     * Toggle a row between expanded and collapsed states
+     * @param row The row to toggle expansion for
+     */
+    toggleRowExpanded(row: VisibleIndex): void;
+    /**
+     * Allows the selected ranges to be set programatically
+     * Will update the cursor and selection start/end based on the new ranges
+     * @param gridRanges The new selected ranges to set
+     */
+    setSelectedRanges(gridRanges: GridRange[]): void;
     initContext(): void;
     requestUpdateCanvas(): void;
-    updateCanvas(metrics?: any): void;
+    updateCanvas(metrics?: GridMetrics): void;
     updateCanvasScale(): void;
-    updateMetrics(state?: {
-        top: number;
-        left: number;
-        topOffset: number;
-        leftOffset: number;
-        draggingColumn: null;
-        draggingRow: null;
-        draggingColumnOffset: null;
-        draggingRowOffset: null;
-        draggingColumnSeparator: null;
-        draggingRowSeparator: null;
-        isDraggingHorizontalScrollBar: boolean;
-        isDraggingVerticalScrollBar: boolean;
-        isDragging: boolean;
-        mouseX: null;
-        mouseY: null;
-        movedColumns: any;
-        movedRows: any;
-        cursorRow: null;
-        cursorColumn: null;
-        selectionStartRow: null;
-        selectionStartColumn: null;
-        selectionEndRow: null;
-        selectionEndColumn: null;
-        selectedRanges: never[];
-        lastSelectedRanges: never[];
-        cursor: null;
-        editingCell: null;
-    }): any;
-    checkSelectionChange(prevState: any): void;
+    updateMetrics(state?: Readonly<GridState>): GridMetrics;
+    /**
+     * Check if the selection state has changed, and call the onSelectionChanged callback if they have
+     * @param prevState The previous grid state
+     */
+    checkSelectionChange(prevState: GridState): void;
+    /**
+     * Validate the current selection, and reset if it is invalid
+     * @returns True if the selection is valid, false if the selection was invalid and has been reset
+     */
     validateSelection(): boolean;
+    /**
+     * Clears all selected ranges
+     */
     clearSelectedRanges(): void;
     /** Clears all but the last selected range */
     trimSelectedRanges(): void;
-    beginSelection(column: any, row: any): void;
+    /**
+     * Begin a selection operation at the provided location
+     * @param column Column where the selection is beginning
+     * @param row Row where the selection is beginning
+     */
+    beginSelection(column: GridRangeIndex, row: GridRangeIndex): void;
     /**
      * Moves the selection to the cell specified
-     * @param {number} column The column index to move the cursor to
-     * @param {number} row The row index to move the cursor to
-     * @param {boolean} extendSelection Whether to extend the current selection (eg. holding Shift)
-     * @param {boolean} maximizePreviousRange When true, maximize/add to the previous range only, ignoring where the selection was started.
+     * @param column The column index to move the cursor to
+     * @param row The row index to move the cursor to
+     * @param extendSelection Whether to extend the current selection (eg. holding Shift)
+     * @param maximizePreviousRange When true, maximize/add to the previous range only, ignoring where the selection was started.
      */
-    moveSelection(column: number, row: number, extendSelection?: boolean, maximizePreviousRange?: boolean): void;
+    moveSelection(column: GridRangeIndex, row: GridRangeIndex, extendSelection?: boolean, maximizePreviousRange?: boolean): void;
     /**
      * Commits the last selected range to the selected ranges.
      * First checks if the last range is completely contained within another range, and if it
@@ -145,166 +197,163 @@ declare class Grid extends React.PureComponent<any, any, any> {
      * Then it consolidates all the selected ranges, reducing them.
      */
     commitSelection(): void;
+    /**
+     * Set the selection to the entire grid
+     */
     selectAll(): void;
-    moveCursor(deltaColumn: any, deltaRow: any, extendSelection: any): void;
+    /**
+     * Move the cursor in relation to the current cursor position
+     * @param deltaColumn Number of columns to move the cursor
+     * @param deltaRow Number of rows to move the cursor
+     * @param extendSelection True if the current selection should be extended, false to start a new selection
+     */
+    moveCursor(deltaColumn: number, deltaRow: number, extendSelection: boolean): void;
     /**
      * Move the cursor in the provided selection direction
-     * @param {string} direction The direction to move the cursor in
+     * @param direction The direction to move the cursor in
      */
-    moveCursorInDirection(direction?: string): void;
+    moveCursorInDirection(direction?: SELECTION_DIRECTION): void;
     /**
      * Move a cursor to the specified position in the grid.
-     * @param {number|null} column The column index to move the cursor to
-     * @param {number|null} row The row index to move the cursor to
-     * @param {boolean} extendSelection Whether to extend the current selection (eg. holding Shift)
-     * @param {boolean} keepCursorInView Whether to move the viewport so that the cursor is in view
-     * @param {boolean} maximizePreviousRange With this and `extendSelection` true, it will maximize/add to the previous range only, ignoring where the selection was started
+     * @param column The column index to move the cursor to
+     * @param row The row index to move the cursor to
+     * @param extendSelection Whether to extend the current selection (eg. holding Shift)
+     * @param keepCursorInView Whether to move the viewport so that the cursor is in view
+     * @param maximizePreviousRange With this and `extendSelection` true, it will maximize/add to the previous range only, ignoring where the selection was started
      */
-    moveCursorToPosition(column: number | null, row: number | null, extendSelection?: boolean, keepCursorInView?: boolean, maximizePreviousRange?: boolean): void;
+    moveCursorToPosition(column: GridRangeIndex, row: GridRangeIndex, extendSelection?: boolean, keepCursorInView?: boolean, maximizePreviousRange?: boolean): void;
     /**
      * Moves the view to make the specified cell visible
      *
-     * @param {number|null} column The column index to bring into view
-     * @param {number|null} row The row index to bring into view
+     * @param column The column index to bring into view
+     * @param row The row index to bring into view
      */
-    moveViewToCell(column: number | null, row: number | null): void;
+    moveViewToCell(column: GridRangeIndex, row: GridRangeIndex): void;
     /**
      * Checks the `top` and `left` properties that are set and updates the isStuckToBottom/Right properties
      * Should be called when user interaction occurs
-     * @param {object} viewState New state properties to set.
-     * @param {boolean} forceUpdate Whether to force an update.
+     * @param viewState New state properties to set.
+     * @param forceUpdate Whether to force an update.
      */
-    setViewState(viewState: object, forceUpdate?: boolean): void;
+    setViewState(viewState: Partial<GridState>, forceUpdate?: boolean): void;
     /**
      * Start editing the data at the given index
      *
-     * @param {number} column The visible column index to start editing
-     * @param {number} row The visible row index to start editing
-     * @param {boolean} isQuickEdit If this is a quick edit (the arrow keys can commit)
-     * @param {number[]|null} selectionRange The tuple [start,end] text selection range of the value to select when editing
-     * @param {string?} value The value to start with in the edit field. Leave undefined to use the current value.
+     * @param column The visible column index to start editing
+     * @param row The visible row index to start editing
+     * @param isQuickEdit If this is a quick edit (the arrow keys can commit)
+     * @param selectionRange The tuple [start,end] text selection range of the value to select when editing
+     * @param value The value to start with in the edit field. Leave undefined to use the current value.
      */
-    startEditing(column: number, row: number, isQuickEdit?: boolean, selectionRange?: number[] | null, value?: string | null): void;
-    isValidForCell(column: any, row: any, value: any): any;
+    startEditing(column: VisibleIndex, row: VisibleIndex, isQuickEdit?: boolean, selectionRange?: EditingCellTextSelectionRange, value?: string): void;
+    /**
+     * Check if a value is valid for a specific cell
+     * @param column Column index of the cell to check
+     * @param row Row index of the cell to check
+     * @param value Value to check
+     * @returns True if the value is valid for the provided cell, false otherwise
+     */
+    isValidForCell(column: VisibleIndex, row: VisibleIndex, value: string): boolean;
     /**
      * Paste a value with the current selection
      * It first needs to validate that the pasted table is valid for the given selection.
      * Also may update selection if single cells are selected and a table is pasted.
-     * @param {string[][] | string} value Table or a string that is being pasted
+     * @param value Table or a string that is being pasted
      */
     pasteValue(value: string[][] | string): Promise<void>;
-    setValueForCell(column: any, row: any, value: any): void;
-    setValueForRanges(ranges: any, value: any): void;
-    isSelected(row: any, column: any): boolean;
-    addDocumentCursor(cursor?: any): void;
+    /**
+     * Set a value to a specific cell. If the value is not valid for that cell, do not set it
+     * @param column Column index to set the value for
+     * @param row Row index to set the value for
+     * @param value Value to set at that cell
+     * @returns true If the value was valid and attempted to be set, false is it was not valid
+     */
+    setValueForCell(column: VisibleIndex, row: VisibleIndex, value: string): boolean;
+    /**
+     * Set a value on all the ranges provided
+     * @param ranges Ranges to set
+     * @param value The value to set on all the ranges
+     */
+    setValueForRanges(ranges: GridRange[], value: string): void;
+    /**
+     * Check if a given cell is within the current selection
+     * @param row Row to check
+     * @param column Column to check
+     * @returns True if the cell is in the current selection, false otherwise
+     */
+    isSelected(row: VisibleIndex, column: VisibleIndex): boolean;
+    addDocumentCursor(cursor?: string | null): void;
     removeDocumentCursor(): void;
-    startDragTimer(event: any): void;
+    startDragTimer(event: React.MouseEvent): void;
     stopDragTimer(): void;
     /**
+     * Draw the grid with the metrics provided
      * When scrolling you've have to re-draw the whole canvas. As a consequence, all these drawing methods
      * must be very quick.
+     * @param metrics Metrics to use for rendering the grid
+     */
+    drawCanvas(metrics?: GridMetrics): void;
+    /**
+     * Set focus to this grid element
      */
-    drawCanvas(metrics?: any): void;
     focus(): void;
+    /**
+     * Check if this grid is currently focused
+     * @returns True if the active element is this grid
+     */
     isFocused(): boolean;
+    /**
+     * Handle a mouse click event. Pass the event to the registered mouse handlers until one handles it.
+     * Focuses the grid after the click.
+     * @param event The mouse event
+     */
+    handleClick(event: React.MouseEvent): void;
+    /**
+     * Handle a mouse context menu event. Pass the event to the registered mouse handlers until one handles it.
+     * @param event The mouse event triggering the context menu
+     */
+    handleContextMenu(event: React.MouseEvent): void;
+    /**
+     * Handle a key down event from the keyboard. Pass the event to the registered keyboard handlers until one handles it.
+     * @param event Keyboard event
+     */
+    handleKeyDown(event: GridKeyboardEvent): void;
     /**
      * Notify all of the mouse handlers for this grid of a mouse event.
-     * @param {String} functionName The name of the function in the mouse handler to call
-     * @param {MouseEvent} event The mouse event to notify
-     * @param {Boolean} updateCoordinates Whether to update the mouse coordinates
-     * @param {Boolean} addCursorToDocument Whether to add a cursor overlay or not (for dragging)
+     * @param functionName The name of the function in the mouse handler to call
+     * @param event The mouse event to notify
+     * @param updateCoordinates Whether to update the mouse coordinates
+     * @param addCursorToDocument Whether to add a cursor overlay or not (for dragging)
      */
-    notifyMouseHandlers(functionName: string, event: MouseEvent, updateCoordinates?: boolean, addCursorToDocument?: boolean): void;
-    renderInputField(): JSX.Element | null;
-}
-declare namespace Grid {
-    namespace propTypes {
-        const canvasOptions: PropTypes.Requireable<PropTypes.InferProps<{}>>;
-        const isStickyBottom: PropTypes.Requireable<boolean>;
-        const isStickyRight: PropTypes.Requireable<boolean>;
-        const metricCalculator: PropTypes.Requireable<GridMetricCalculator>;
-        const model: PropTypes.Validator<GridModel>;
-        const keyHandlers: PropTypes.Requireable<(KeyHandler | null | undefined)[]>;
-        const mouseHandlers: PropTypes.Requireable<(GridMouseHandler | null | undefined)[]>;
-        const movedColumns: PropTypes.Requireable<(PropTypes.InferProps<{
-            from: PropTypes.Validator<number>;
-            to: PropTypes.Validator<number>;
-        }> | null | undefined)[]>;
-        const movedRows: PropTypes.Requireable<(PropTypes.InferProps<{
-            from: PropTypes.Validator<number>;
-            to: PropTypes.Validator<number>;
-        }> | null | undefined)[]>;
-        const onError: PropTypes.Requireable<(...args: any[]) => any>;
-        const onSelectionChanged: PropTypes.Requireable<(...args: any[]) => any>;
-        const onMovedColumnsChanged: PropTypes.Requireable<(...args: any[]) => any>;
-        const onMoveColumnComplete: PropTypes.Requireable<(...args: any[]) => any>;
-        const onViewChanged: PropTypes.Requireable<(...args: any[]) => any>;
-        const renderer: PropTypes.Requireable<GridRenderer>;
-        const stateOverride: PropTypes.Requireable<PropTypes.InferProps<{}>>;
-        const theme: PropTypes.Requireable<PropTypes.InferProps<{
-            autoSelectColumn: PropTypes.Requireable<boolean>;
-            autoSelectRow: PropTypes.Requireable<boolean>;
-        }>>;
-    }
-    namespace defaultProps {
-        export namespace canvasOptions_1 {
-            const alpha: boolean;
-        }
-        export { canvasOptions_1 as canvasOptions };
-        const isStickyBottom_1: boolean;
-        export { isStickyBottom_1 as isStickyBottom };
-        const isStickyRight_1: boolean;
-        export { isStickyRight_1 as isStickyRight };
-        const metricCalculator_1: null;
-        export { metricCalculator_1 as metricCalculator };
-        const keyHandlers_1: never[];
-        export { keyHandlers_1 as keyHandlers };
-        const mouseHandlers_1: never[];
-        export { mouseHandlers_1 as mouseHandlers };
-        const movedColumns_1: never[];
-        export { movedColumns_1 as movedColumns };
-        const movedRows_1: never[];
-        export { movedRows_1 as movedRows };
-        export function onError_1(): void;
-        export { onError_1 as onError };
-        export function onSelectionChanged_1(): void;
-        export { onSelectionChanged_1 as onSelectionChanged };
-        export function onMovedColumnsChanged_1(): void;
-        export { onMovedColumnsChanged_1 as onMovedColumnsChanged };
-        export function onMoveColumnComplete_1(): void;
-        export { onMoveColumnComplete_1 as onMoveColumnComplete };
-        export function onViewChanged_1(): void;
-        export { onViewChanged_1 as onViewChanged };
-        const renderer_1: null;
-        export { renderer_1 as renderer };
-        const stateOverride_1: {};
-        export { stateOverride_1 as stateOverride };
-        export namespace theme_1 {
-            const autoSelectColumn: boolean;
-            const autoSelectRow: boolean;
-        }
-        export { theme_1 as theme };
-    }
+    notifyMouseHandlers(functionName: GridMouseHandlerFunctionName, event: GridMouseEvent, updateCoordinates?: boolean, addCursorToDocument?: boolean): void;
+    handleMouseDown(event: React.MouseEvent): void;
+    handleDoubleClick(event: React.MouseEvent): void;
+    handleMouseMove(event: React.MouseEvent): void;
+    handleMouseLeave(event: React.MouseEvent): void;
+    handleMouseDrag(event: MouseEvent): void;
+    handleMouseUp(event: MouseEvent): void;
+    handleResize(): void;
+    handleWheel(event: WheelEvent): void;
+    /**
+     * Handle cancelling the cell edit action
+     */
+    handleEditCellCancel(): void;
+    /**
+     * Handle a change in the value in an editing cell
+     * @param value New value set
+     */
+    handleEditCellChange(value: string): void;
+    /**
+     * Commit an edit for the currently editing cell
+     * @param value Value that was committed
+     * @param options Options for committing
+     */
+    handleEditCellCommit(value: string, { direction, fillRange, }?: {
+        direction?: SELECTION_DIRECTION | null;
+        fillRange?: boolean;
+    }): void;
+    renderInputField(): ReactNode;
+    render(): ReactNode;
 }
-import React from "react";
-import { SelectionKeyHandler } from "./key-handlers";
-import { TreeKeyHandler } from "./key-handlers";
-import { EditKeyHandler } from "./key-handlers";
-import { PasteKeyHandler } from "./key-handlers";
-import { EditMouseHandler } from "./mouse-handlers";
-import { GridSelectionMouseHandler } from "./mouse-handlers";
-import { GridColumnMoveMouseHandler } from "./mouse-handlers";
-import { GridColumnSeparatorMouseHandler } from "./mouse-handlers";
-import { GridHorizontalScrollBarMouseHandler } from "./mouse-handlers";
-import { GridRowMoveMouseHandler } from "./mouse-handlers";
-import { GridRowSeparatorMouseHandler } from "./mouse-handlers";
-import { GridRowTreeMouseHandler } from "./mouse-handlers";
-import { GridScrollBarCornerMouseHandler } from "./mouse-handlers";
-import { GridVerticalScrollBarMouseHandler } from "./mouse-handlers";
-import PropTypes from "prop-types";
-import GridMetricCalculator from "./GridMetricCalculator";
-import GridModel from "./GridModel";
-import KeyHandler from "./KeyHandler";
-import GridMouseHandler from "./GridMouseHandler";
-import GridRenderer from "./GridRenderer";
+export default Grid;
 //# sourceMappingURL=Grid.d.ts.map

package/dist/Grid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Grid.d.ts","sourceRoot":"","sources":["../src/Grid.jsx"],"names":[],"mappings":";AAoCA;;;;;;;;;;;;;GAaG;AACH;IAGE,6BAA+B;IAE/B,2BAA0B;IAE1B,oDAAyE;IAEzE,sCAUC;IAED,sDAEC;IAED,wBAsHC;IA29BD,8BAcC;IAED,oCAYC;IA0QD,6BAGC;IAED,uCAIC;IAED;;;aA2BC;IAxOD,oCAKC;IA3ED,4BAWC;IA8CD,kCAWC;IAsBD,kCAUC;IAvBD,kCAEC;IAED,mCAOC;IAcD,gCAaC;IAED,qBAWC;IAED,0BAoIC;IAj2CC,cAA8C;IAC9C,sBAAsE;IAEtE,iCAAkB;IAClB,uCAAyB;IACzB,oBAA0B;IAE1B,iBAAuB;IACvB,aAAmB;IAEnB,yBAA4B;IAC5B,wBAA2B;IAM3B,8BAA0B;IAE1B,iCAAqB;IAGrB,yFAKC;IACD,8TAWC;IAgMH,gBAGC;IAED,mEAKC;IAED,oEAEC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCC;IAED,6DAEE;IAEF,wBAGC;IAED,iEAEE;IAEF,0BAGC;IAED,sCAEC;IAED,gCAEC;IAED,kCAiBC;IAED,0DAA0D;IAC1D,yCA6BC;IAED,oBAKC;IAED,4BAUC;IAED,kCAOC;IAED,0BAaC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAQC;IAED,2CAQC;IAED,6BAiBC;IAED,4BAGC;IAED,6CAA6C;IAC7C,2BAOC;IAED,4CASC;IAED;;;;;;OAMG;IACH,sBALW,MAAM,OACN,MAAM,oBACN,OAAO,0BACP,OAAO,QAmFjB;IAED;;;;;OAKG;IACH,wBAkEC;IAED,kBASC;IAED,wEAoBC;IAED;;;OAGG;IACH,kCAFW,MAAM,QA6ChB;IAED;;;;;;;OAOG;IACH,6BANW,MAAM,GAAC,IAAI,OACX,MAAM,GAAC,IAAI,oBACX,OAAO,qBACP,OAAO,0BACP,OAAO,QAkBjB;IAED;;;;;OAKG;IACH,uBAHW,MAAM,GAAC,IAAI,OACX,MAAM,GAAC,IAAI,QAkCrB;IAED;;;;;OAKG;IACH,wBAHW,MAAM,gBACN,OAAO,QAiBjB;IAED;;;;;;;;OAQG;IACH,qBANW,MAAM,OACN,MAAM,gBACN,OAAO,mBACP,MAAM,EAAE,GAAC,IAAI,UACb,MAAM,eAyBhB;IAED,uDAMC;IAED;;;;;OAKG;IACH,kBAFW,MAAM,EAAE,EAAE,GAAG,MAAM,iBAwF7B;IAED,yDAQC;IAED,iDAUC;IAED,2CAkBC;IAED,sCAMC;IAED,6BAMC;IAED,iCAQC;IAED,sBAKC;IAED;;;OAGG;IACH,gCA0DC;IAED,cAEC;IAED,qBAEC;IA6CD;;;;;;OAMG;IACH,iDAJW,UAAU,oEAuCpB;IAyPD,uCA4DC;CA2BF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA4CU,kCAAQ;;QACG,6CAAQ;;QACL,gDAAQ;;QACT,+CAAQ;;QACf,wCAAQ"}
+{"version":3,"file":"Grid.d.ts","sourceRoot":"","sources":["../src/Grid.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAiB,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIvE,OAAO,oBAAoB,EAAE,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,gBAAgB,EAAE,EACvB,cAAc,EACd,4BAA4B,EAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAkB,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,SAAS,EAAE,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,YAAY,EAAE,EACnB,WAAW,EACX,6BAA6B,EAC9B,MAAM,gBAAgB,CAAC;AACxB,OAAkB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAanD,OAAO,aAAa,CAAC;AACrB,OAAO,UAAU,EAAE,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAS7D,OAAO,WAAW,EAAE,EAClB,UAAU,EACV,UAAU,EACV,aAAa,EACb,YAAY,EACb,MAAM,eAAe,CAAC;AAkBvB,oBAAY,SAAS,GAAG,OAAO,IAAI,CAAC,YAAY,GAAG;IAEjD,aAAa,CAAC,EAAE,gCAAgC,CAAC;IAIjD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IAGxB,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IAGxC,KAAK,EAAE,SAAS,CAAC;IAGjB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAGnC,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAG5B,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IAG7B,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,IAAI,CAAC;IAGnD,qBAAqB,CAAC,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,KAAK,IAAI,CAAC;IAChE,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,IAAI,CAAC;IAG1D,oBAAoB,CAAC,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,KAAK,IAAI,CAAC;IAC/D,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,IAAI,CAAC;IAGzD,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;IAG/C,QAAQ,CAAC,EAAE,YAAY,CAAC;IAIxB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,oBAAY,SAAS,GAAG;IAEtB,GAAG,EAAE,YAAY,CAAC;IAClB,IAAI,EAAE,YAAY,CAAC;IAGnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IAGnB,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;IACpC,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IAGjC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAGjC,uBAAuB,EAAE,YAAY,GAAG,IAAI,CAAC;IAC7C,oBAAoB,EAAE,YAAY,GAAG,IAAI,CAAC;IAG1C,6BAA6B,EAAE,OAAO,CAAC;IACvC,2BAA2B,EAAE,OAAO,CAAC;IAGrC,UAAU,EAAE,OAAO,CAAC;IAGpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAGtB,YAAY,EAAE,aAAa,EAAE,CAAC;IAC9B,SAAS,EAAE,aAAa,EAAE,CAAC;IAG3B,SAAS,EAAE,YAAY,GAAG,IAAI,CAAC;IAC/B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,iBAAiB,EAAE,YAAY,GAAG,IAAI,CAAC;IACvC,oBAAoB,EAAE,YAAY,GAAG,IAAI,CAAC;IAC1C,eAAe,EAAE,YAAY,GAAG,IAAI,CAAC;IACrC,kBAAkB,EAAE,YAAY,GAAG,IAAI,CAAC;IAKxC,cAAc,EAAE,SAAS,EAAE,CAAC;IAC5B,kBAAkB,EAAE,SAAS,EAAE,CAAC;IAGhC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAItB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,cAAM,IAAK,SAAQ,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC;IACpD,MAAM,CAAC,YAAY;;;;;;;;uBAQJ,IAAI;kCACO,IAAI;qCACD,IAAI;oCACL,IAAI;kCACN,IAAI;iCACL,IAAI;6BACR,IAAI;;;MAMvB;IAIF,MAAM,CAAC,aAAa,SAAW;IAE/B,MAAM,CAAC,WAAW,SAAQ;IAE1B,MAAM,CAAC,QAAQ,qCAA0D;IAEzE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,wBAAwB,GAAG,MAAM;IAe1D;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI;IAM/D,QAAQ,EAAE,YAAY,CAAC;IAEvB,gBAAgB,EAAE,oBAAoB,CAAC;IAEvC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEjC,aAAa,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAG/C,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAG9B,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAEhC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAG5B,eAAe,EAAE,OAAO,CAAC;IAEzB,cAAc,EAAE,OAAO,CAAC;IAMxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;IAEhD,WAAW,EAAE,UAAU,EAAE,CAAC;IAE1B,aAAa,EAAE,gBAAgB,EAAE,CAAC;gBAItB,KAAK,EAAE,SAAS;IAwH5B,iBAAiB,IAAI,IAAI;IAezB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI;IAqHpE,oBAAoB,IAAI,IAAI;IAsB5B,QAAQ,IAAI,aAAa;IAKzB,qBAAqB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IASvD,kBAAkB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,SAAS;IAM3D,cAAc,CAAC,KAAK,sBAAa,GAAG,eAAe;IAsCnD,oBAAoB,gBAAyB,UAAU,EAAE,kBAEvD;IAEF,cAAc,IAAI,UAAU,EAAE;IAK9B,sBAAsB,kBAA2B,gBAAgB,EAAE,wBAEjE;IAEF,gBAAgB,IAAI,gBAAgB,EAAE;IAKtC;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,YAAY,GAAG,UAAU;IAQrD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU;IAQ/C;;;OAGG;IACH,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAgB1C;;;;OAIG;IACH,iBAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI;IA+BhD,WAAW,IAAI,IAAI;IASnB,mBAAmB,IAAI,IAAI;IAc3B,YAAY,CAAC,OAAO,cAAuB,GAAG,IAAI;IASlD,iBAAiB,IAAI,IAAI;IAmBzB,aAAa,CAAC,KAAK,sBAAa,GAAG,WAAW;IAU9C;;;OAGG;IACH,oBAAoB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAUhD;;;OAGG;IACH,iBAAiB,IAAI,OAAO;IAmB5B;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAK3B,6CAA6C;IAC7C,kBAAkB,IAAI,IAAI;IAS1B;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAWjE;;;;;;OAMG;IACH,aAAa,CACX,MAAM,EAAE,cAAc,EACtB,GAAG,EAAE,cAAc,EACnB,eAAe,UAAQ,EACvB,qBAAqB,UAAQ,GAC5B,IAAI;IA8EP;;;;;OAKG;IACH,eAAe,IAAI,IAAI;IAyEvB;;OAEG;IACH,SAAS,IAAI,IAAI;IAWjB;;;;;OAKG;IACH,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,OAAO,GACvB,IAAI;IAsBP;;;OAGG;IACH,qBAAqB,CAAC,SAAS,sBAAqC,GAAG,IAAI;IA6C3E;;;;;;;OAOG;IACH,oBAAoB,CAClB,MAAM,EAAE,cAAc,EACtB,GAAG,EAAE,cAAc,EACnB,eAAe,UAAQ,EACvB,gBAAgB,UAAO,EACvB,qBAAqB,UAAQ,GAC5B,IAAI;IAYP;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAoCjE;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,WAAW,UAAQ,GAAG,IAAI;IAmBtE;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,YAAY,EACjB,WAAW,UAAQ,EACnB,cAAc,CAAC,EAAE,6BAA6B,EAC9C,KAAK,CAAC,EAAE,MAAM,GACb,IAAI;IAqBP;;;;;;OAMG;IACH,cAAc,CACZ,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,YAAY,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO;IAWV;;;;;OAKG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0F3D;;;;;;OAMG;IACH,eAAe,CACb,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,YAAY,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO;IAaV;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAc3D;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO;IAoB5D,iBAAiB,CAAC,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAYrD,oBAAoB,IAAI,IAAI;IAQ5B,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAU7C,aAAa,IAAI,IAAI;IAOrB;;;;;OAKG;IACH,UAAU,CAAC,OAAO,cAAuB,GAAG,IAAI;IA+DhD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;OAGG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAgB1C;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAchD;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAc7C;;;;;;OAMG;IACH,mBAAmB,CACjB,YAAY,EAAE,4BAA4B,EAC1C,KAAK,EAAE,cAAc,EACrB,iBAAiB,UAAO,EACxB,mBAAmB,UAAQ,GAC1B,IAAI;IAiCP,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAa9C,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAIhD,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAI9C,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAK/C,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAOxC,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAetC,YAAY,IAAI,IAAI;IAapB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAwIpC;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAK5B;;;OAGG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAiBzC;;;;OAIG;IACH,oBAAoB,CAClB,KAAK,EAAE,MAAM,EACb,EACE,SAAoC,EACpC,SAAiB,GAClB,GAAE;QAAE,SAAS,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAO,GACtE,IAAI;IA6BP,gBAAgB,IAAI,SAAS;IA8D7B,MAAM,IAAI,SAAS;CAyBpB;AAED,eAAe,IAAI,CAAC"}