@trellixio/roaster-coffee/lib/components/Tooltip/Tooltip.d.ts

Beans' product component library

import * as React from 'react';
import { Placement } from '@floating-ui/react';
export declare type FloatingSide = Placement;
export interface TooltipProps extends React.ComponentPropsWithoutRef<'sub'> {
    /** The content that will have the tooltip. */
    children: React.ReactNode;
    /** The position of the tooltip relative to the content. */
    position?: FloatingSide;
    /** The prop to use as a ref to measure the size of the content. */
    refProp?: string;
    /** The label to display in the tooltip. */
    label: React.ReactNode;
    /** The width of the tooltip. */
    width?: number | 'auto';
    /** The z-index of the tooltip. */
    zIndex?: React.CSSProperties['zIndex'];
    /** Whether the tooltip is open or closed. */
    opened?: boolean;
    /** The offset of the tooltip from the content. */
    offset?: number;
    /** The events that will trigger the opening and closing of the tooltip. */
    events?: {
        hover: boolean;
        focus: boolean;
        touch: boolean;
    };
    /** Whether the tooltip should be displayed inline. */
    inline?: boolean;
}
export declare const Tooltip: React.ForwardRefExoticComponent<TooltipProps & React.RefAttributes<HTMLElement>>;
//# sourceMappingURL=Tooltip.d.ts.map