@gridui/tooltip

中文文档
1.0.2发布于 2026/11/01UNLICENSEDTypeScriptES Module

GridUI React tooltip

原始使用文档

@gridui/tooltip

Core family. Public API: Tooltip, TooltipContent, TooltipContentProps, TooltipProps, TooltipProvider, TooltipProviderProps, TooltipTrigger, TooltipTriggerProps.

Import components from @gridui/tooltip and load @gridui/tooltip/styles.css after Theme. Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.

See component ownership and release history.

Tooltips

The Tooltip family owns composable primitives for supplemental button and link hints. This family owns timing, controlled state, native trigger composition, portal styling, positioning, accessibility, and content limits. Applications own clipboard state and localized labels.

Implementation and lifecycle

Use TooltipProvider around a related action group, then compose Tooltip, TooltipTrigger, and TooltipContent. The provider defaults to a 300ms hover delay; keyboard focus opens immediately. Native Radix provider/root props expose shared timing and controlled or uncontrolled state. TooltipTrigger defaults to asChild, preserving a single native button or link, its ref, and event handlers. Keep the trigger's accessible name even when a tooltip repeats it.

TooltipContent forwards native content props and refs, defaults to an 8px side offset and 16px collision padding, and portals into document.body. The portal avoids clipping and uses the document theme's semantic palette. Use container when a different portal host is required, and className, style, side, or align for local presentation. Entry/exit motion respects reduced motion. With forceMount, Overlay retains the content through React Activity while closed content stays hidden, its refs are detached, and its effects are suspended. This lifecycle does not rely on exit animation, including under reduced motion. Radix owns description association, hoverable content, Escape dismissal, and viewport collisions. Content is supplemental, noninteractive text; use a popover for interactive content. Disabled native controls do not receive focus; essential instructions must also be available outside the tooltip. Consumers own copy, localization, and business state.

<TooltipProvider>
    <Tooltip>
        <TooltipTrigger>
            <Button aria-label="Copy prompt">Copy</Button>
        </TooltipTrigger>
        <TooltipContent>Copy prompt</TooltipContent>
    </Tooltip>
</TooltipProvider>

Surface motion uses @gridui/overlay; load @gridui/overlay/styles.css after Theme and before this family.

版本与发布记录

@gridui/tooltip 共发布 4 个版本,首次发布于 2026/10/31;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.0.2latest2026/11/012 天前
1.0.02026/10/313 天前
0.0.02026/10/313 天前
0.0.0-stage2026/10/313 天前

关于 @gridui/tooltip 的常见问题

@gridui/tooltip 是什么?

GridUI React工具提示

如何安装 @gridui/tooltip?

在项目目录运行 npm install @gridui/tooltip,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.2.0)、react-dom(^19.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gridui/tooltip 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gridui/tooltip 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gridui/tooltip 可以商用吗?

@gridui/tooltip 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@gridui/tooltip 还在维护吗?

最新版本 1.0.2 发布于 2026/11/01(2 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/10/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。