@accelint/design-toolkit
Version:
An open-source component library to serve as part of the entire ecosystem of UX for Accelint.
54 lines (51 loc) • 1.7 kB
TypeScript
import * as react_jsx_runtime from 'react/jsx-runtime';
import * as react from 'react';
import { ContextValue } from 'react-aria-components';
import { TooltipProps, TooltipTriggerProps } from './types.js';
declare const TooltipContext: react.Context<ContextValue<TooltipTriggerProps, HTMLDivElement>>;
/**
* Tooltip - A contextual popup component for providing additional information
*
* Displays helpful information when users hover over or focus on an element.
* Provides accessible tooltip functionality with proper positioning, keyboard
* navigation, and screen reader support for enhanced user experience.
*
* @example
* // Basic tooltip
* <Tooltip.Trigger>
* <Button>Hover me</Button>
* <Tooltip>
* This is helpful information
* </Tooltip>
* </Tooltip.Trigger>
*
* @example
* // Tooltip with custom positioning
* <Tooltip.Trigger>
* <Button>Hover for info</Button>
* <Tooltip placement="top" offset={10}>
* Positioned above with custom offset
* </Tooltip>
* </Tooltip.Trigger>
*
* @example
* // Icon with tooltip
* <Tooltip.Trigger>
* <Button variant="icon">
* <Icon><Info /></Icon>
* </Button>
* <Tooltip>
* Additional context for this action
* </Tooltip>
* </Tooltip.Trigger>
*/
declare function TooltipTrigger({ ref, ...props }: TooltipTriggerProps): react_jsx_runtime.JSX.Element;
declare namespace TooltipTrigger {
var displayName: string;
}
declare function Tooltip({ children, parentRef, className, offset, placement, ...props }: TooltipProps): react_jsx_runtime.JSX.Element;
declare namespace Tooltip {
var displayName: string;
var Trigger: typeof TooltipTrigger;
}
export { Tooltip, TooltipContext };