@stanfordspezi/spezi-web-design-system
Version:
Stanford Biodesign Digital Health Spezi Web Design System
38 lines (37 loc) • 1.67 kB
TypeScript
import { Tooltip as TooltipPrimitive } from 'radix-ui';
import { ComponentProps, ReactNode } from 'react';
export declare const TooltipProvider: import('react').FC<TooltipPrimitive.TooltipProviderProps>;
export declare const TooltipRoot: import('react').FC<TooltipPrimitive.TooltipProps>;
export declare const TooltipTrigger: import('react').ForwardRefExoticComponent<TooltipPrimitive.TooltipTriggerProps & import('react').RefAttributes<HTMLButtonElement>>;
/**
* Main content container for Tooltip.
* Contains Tooltip's inner content.
*
* @example
* <TooltipContent>
* Tooltip text
* </TooltipContent>
*/
export declare const TooltipContent: ({ className, sideOffset, ...props }: ComponentProps<typeof TooltipPrimitive.Content>) => import("react").JSX.Element;
export interface TooltipProps extends Omit<ComponentProps<typeof TooltipPrimitive.Root>, "children">, Pick<ComponentProps<typeof TooltipPrimitive.Content>, "sideOffset" | "className" | "side"> {
/**
* Slot for the main content that should trigger the Tooltip.
*/
children?: ReactNode;
/**
* Tooltip's content.
*/
tooltip?: ReactNode;
}
/**
* A component that displays additional information when hovering over an element.
* Built on top of [radix-ui Tooltip](https://www.radix-ui.com/primitives/docs/components/tooltip).
*
* For interactive tooltips, see [Popover](src/components/Popover/Popover.tsx)
*
* @example
* <Tooltip tooltip="Click to save">
* <Button>Save</Button>
* </Tooltip>
*/
export declare const Tooltip: ({ children, tooltip, className, sideOffset, side, delayDuration, ...rootProps }: TooltipProps) => import("react").JSX.Element;