react-konva-grid/dist/hooks/useTooltip.d.ts

Declarative React Canvas Grid primitive for Data table, Pivot table, Excel Worksheets

import React from "react";
import { CellInterface, GridRef } from "../Grid";
export interface TooltipOptions {
    /**
     * Tooltip component
     */
    component?: React.FC<TooltipProps> | React.ComponentClass<TooltipProps>;
    /**
     * Grid references
     */
    gridRef: React.MutableRefObject<GridRef>;
    /**
     * Tooltip value getter of a cell
     */
    getValue: (cell: CellInterface) => any;
}
export interface TooltipResults {
    /**
     * Tooltip component to inject into the page
     */
    tooltipComponent: React.ReactElement | null;
    /**
     * Mousemove listener to align tooltip
     */
    onMouseMove: (e: React.MouseEvent<HTMLInputElement>) => void;
    /**
     * Mouse leave listener to hide tooltip
     */
    onMouseLeave: (e: React.MouseEvent<HTMLInputElement>) => void;
}
export interface TooltipProps {
    /**
     * Tooltip content
     */
    content: string;
    /**
     * Tooltip x position
     */
    x: number;
    /**
     * Tooltip y position
     */
    y: number;
}
declare const useTooltip: ({ getValue, gridRef, component: Component, }: TooltipOptions) => TooltipResults;
export default useTooltip;