# @gridui/tooltip 中文文档

规范地址：https://npmcn.com/package/%40gridui/tooltip/

版本：1\.0\.2
npm 元数据更新时间：2026-11-01T02:49:27.368Z
中文译文更新时间：2026-11-01T07:46:39.938Z
软件包许可：UNLICENSED

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gridui/tooltip
原文对照：https://npmcn.com/package/%40gridui/tooltip/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15.4 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：react ^19\.2\.0，react-dom ^19\.2\.0
- 首次发布：2026-10-31T02:44:31.394Z
- 最新版本发布：2026-11-01T02:49:27.205Z
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

GridUI React工具提示

## 安装

```sh
npm install @gridui/tooltip
```

也可以使用：`pnpm add @gridui/tooltip`、`yarn add @gridui/tooltip`、`bun add @gridui/tooltip`

## README

# @gridui /工具提示

核心家庭。公共API: `Tooltip`， `TooltipContent`， `TooltipContentProps`， `TooltipProps`， `TooltipProvider`， `TooltipProviderProps`， `TooltipTrigger`， `TooltipTriggerProps`.

从 `@gridui/tooltip` 和负载 `@gridui/tooltip/styles.css` 后的主题。 此家族使用的任何组合依赖项的加载样式。应用程序拥有自己的路由、标签、状态持久化和品牌。

看到 [组件所有权](https://npmcn.com/package/docs/component-ownership.md) 和 [版本历史](https://npmcn.com/package/%40gridui/tooltip/.changeset/history/).

## 工具提示

Tooltip家族拥有用于补充按钮和链接的可组合原语 提示。这个家族掌握着时机 受控状态，本地触发器组合，门户样式，定位， 可访问性和内容限制。应用程序拥有自己的剪贴板状态和本地化标签。

## 实现和生命周期

使用 `TooltipProvider` 围绕一个相关的行动组，然后撰写 `Tooltip`， `TooltipTrigger`, `TooltipContent`． 提供程序的默认悬停时间为300ms 延迟;键盘焦点立即打开。原生基数提供程序/根道具暴露 共享定时和受控或不受控状态。 `TooltipTrigger` 默认为 `asChild`，保留单个本机按钮或链接、其ref和事件处理程序。 即使工具提示重复，也要保留触发器的可访问名称。

`TooltipContent` 转发原生内容道具和refs，默认为8px的边 偏移和16px碰撞填充，并进入 `document.body`． 门户 避免裁剪并使用文档主题的语义调色板。使用 `container` 当需要不同的门户主机时，和 `className`， `style`， `side`，或者 `align` 本地展示。进入/退出运动尊重减少运动。 与 `forceMount`， Overlay通过React Activity保留内容 封闭的内容保持隐藏，其引用被分离，其效果被暂停。这个生命周期 不依赖退出动画，包括减少运动。 基数具有描述关联、悬停内容、免解雇、和 视窗碰撞。内容是补充的、非交互式的文本；使用弹出窗口 用于交互式内容。禁用的本机控件不接收焦点；至关重要的 说明也必须在工具提示之外可用。消费者拥有拷贝， 本地化和业务状态。

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

地表运动用途 `@gridui/overlay`;负载 `@gridui/overlay/styles.css` 在主题之后，在这个家庭之前。

## 常见问题

### @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 和提交记录判断。