logoAnt Design

⌘ K
  • 设计
  • 研发
  • 组件
  • 博客
  • 资源
  • 国内镜像
5.22.5
  • 组件总览
  • 通用
    • Button
      按钮
    • FloatButton
      悬浮按钮
      5.0.0
    • Icon
      图标
    • Typography
      排版
  • 布局
    • Divider
      分割线
    • Flex
      弹性布局
      5.10.0
    • Grid
      栅格
    • Layout
      布局
    • Space
      间距
    • Splitter
      分隔面板
      5.21.0
  • 导航
    • Anchor
      锚点
    • Breadcrumb
      面包屑
    • Dropdown
      下拉菜单
    • Menu
      导航菜单
    • Pagination
      分页
    • Steps
      步骤条
  • 数据录入
    • AutoComplete
      自动完成
    • Cascader
      级联选择
    • Checkbox
      多选框
    • ColorPicker
      颜色选择器
      5.5.0
    • DatePicker
      日期选择框
    • Form
      表单
    • Input
      输入框
    • InputNumber
      数字输入框
    • Mentions
      提及
    • Radio
      单选框
    • Rate
      评分
    • Select
      选择器
    • Slider
      滑动输入条
    • Switch
      开关
    • TimePicker
      时间选择框
    • Transfer
      穿梭框
    • TreeSelect
      树选择
    • Upload
      上传
  • 数据展示
    • Avatar
      头像
    • Badge
      徽标数
    • Calendar
      日历
    • Card
      卡片
    • Carousel
      走马灯
    • Collapse
      折叠面板
    • Descriptions
      描述列表
    • Empty
      空状态
    • Image
      图片
    • List
      列表
    • Popover
      气泡卡片
    • QRCode
      二维码
      5.1.0
    • Segmented
      分段控制器
    • Statistic
      统计数值
    • Table
      表格
    • Tabs
      标签页
    • Tag
      标签
    • Timeline
      时间轴
    • Tooltip
      文字提示
    • Tour
      漫游式引导
      5.0.0
    • Tree
      树形控件
  • 反馈
    • Alert
      警告提示
    • Drawer
      抽屉
    • Message
      全局提示
    • Modal
      对话框
    • Notification
      通知提醒框
    • Popconfirm
      气泡确认框
    • Progress
      进度条
    • Result
      结果
    • Skeleton
      骨架屏
    • Spin
      加载中
    • Watermark
      水印
      5.1.0
  • 其他
    • Affix
      固钉
    • App
      包裹组件
      5.1.0
    • ConfigProvider
      全局化配置
    • Util
      工具类
      5.13.0

Tooltip
文字提示

简单的文字提示气泡框。
使用import{ Tooltip }from"antd";
源码components/tooltip
文档
编辑此页更新日志

相关资源

Ant Design X
Ant Design Charts
Ant Design Pro
Pro Components
Ant Design Mobile
Ant Design Mini
Ant Design Web3
Ant Design Landing-首页模板集
Scaffolds-脚手架市场
Umi-React 应用开发框架
dumi-组件/文档研发工具
qiankun-微前端框架
Ant Motion-设计动效
国内镜像站点 🇨🇳

社区

Awesome Ant Design
Medium
Twitter
yuque logoAnt Design 语雀专栏
Ant Design 知乎专栏
体验科技专栏
seeconf logoSEE Conf-蚂蚁体验科技大会
加入我们

帮助

GitHub
更新日志
常见问题
报告 Bug
议题
讨论区
StackOverflow
SegmentFault

Ant XTech logo更多产品

yuque logo语雀-构建你的数字花园
AntV logoAntV-数据可视化解决方案
Egg logoEgg-企业级 Node.js 框架
Kitchen logoKitchen-Sketch 工具集
Galacean logoGalacean-互动图形解决方案
xtech logo蚂蚁体验科技
主题编辑器
Made with ❤ by
蚂蚁集团和 Ant Design 开源社区
loading

何时使用

鼠标移入则显示提示，移出消失，气泡浮层不承载复杂文本和操作。

可用来代替系统默认的 title 提示，提供一个 按钮/文字/操作 的文案解释。

代码演示

Tooltip will show on mouse enter.
基本

最简单的用法。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
箭头展示

支持显示、隐藏以及将箭头保持居中定位。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
With `getPopupContainer`
Without `getPopupContainer`
自动调整位置

气泡框不可见时自动调整位置。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Presets
Custom
多彩文字提示

我们添加了多种预设色彩的文字提示样式，用作不同场景使用。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Debug

Debug 用例。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
禁用子元素

Disabled 子元素。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
位置

位置有 12 个方向。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
贴边偏移

当 Tooltip 贴边时，自动偏移并且调整箭头位置。当超出过多时，则一同滚出屏幕。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Tooltip will destroy when hidden.
隐藏后销毁

通过 destroyTooltipOnHide 控制提示关闭时是否销毁 dom 节点。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Hello, Pink Pure Panel!
Hello, Customize Color Pure Panel!
Hello, Pure Panel!
_InternalPanelDoNotUseOrYouWillBeFired

调试用组件，请勿直接使用。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Tooltip will show on mouse enter.
禁用

通过设置 title="" 可以禁用 Tooltip。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

API

通用属性参考：通用属性

参数说明类型默认值
title提示文字ReactNode | () => ReactNode-

共同的 API

以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
参数说明类型默认值版本
align该值将合并到 placement 的配置中，设置参考 dom-alignobject-
arrow修改箭头的显示状态以及修改箭头是否指向目标元素中心boolean | { pointAtCenter: boolean }true5.2.0
autoAdjustOverflow气泡被遮挡时自动调整位置booleantrue
color背景颜色string-4.3.0
defaultOpen默认是否显隐booleanfalse4.23.0
destroyTooltipOnHide关闭后是否销毁 Tooltipbooleanfalse
fresh默认情况下，Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新booleanfalse5.10.0
getPopupContainer浮层渲染父节点，默认渲染到 body 上(triggerNode: HTMLElement) => HTMLElement() => document.body
mouseEnterDelay鼠标移入后延时多少才显示 Tooltip，单位：秒number0.1
mouseLeaveDelay鼠标移出后延时多少才隐藏 Tooltip，单位：秒number0.1
overlayClassName卡片类名string-
overlayStyle卡片样式React.CSSProperties-
overlayInnerStyle卡片内容区域的样式对象React.CSSProperties-
placement气泡框位置，可选 top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottomstringtop
trigger触发行为，可选 hover | focus | click | contextMenu，可使用数组设置多个触发行为string | string[]hover
open用于手动控制浮层显隐，小于 4.23.0 使用 visible（为什么?）booleanfalse4.23.0
zIndex设置 Tooltip 的 z-indexnumber-
onOpenChange显示隐藏的回调(open: boolean) => void-4.23.0

主题变量（Design Token）

组件 Token如何定制？

Token 名称描述类型默认值
zIndexPopup文字提示 z-indexnumber1070

全局 Token如何定制？

FAQ

为何在严格模式中有时候会出现 findDOMNode is deprecated 这个警告？

这是由于 rc-trigger 的实现方式导致的，rc-trigger 强制要求 children 能够接受 ref，否则就会 fallback 到 findDOMNode，所以 children 需要是原生 html 标签，如果不是，则需要使用 React.forwardRef 把 ref 透传到原生 html 标签。

  • findDOMNode is deprecated 重现：https://codesandbox.io/p/sandbox/finddomnode-c5hy96
  • 使用 forwardRef 消除警告：https://codesandbox.io/p/sandbox/no-finddomnode-warning-forked-gdxczs

为何有时候 HOC 组件无法生效？

请确保 Tooltip 的子元素能接受 onMouseEnter、onMouseLeave、onPointerEnter、onPointerLeave、onFocus、onClick 事件。

placement 的行为逻辑是什么？

当屏幕空间足够时，会按照 placement 的设置进行弹层。当空间不足时则会取反向位置进行弹层（例如 top 不够时，会改为 bottom，topLeft 不够时会改为 bottomLeft）。单一方向如 top bottom left right 当贴边时进行自动位移：

shift

当设置为边缘对齐方向如 topLeft bottomRight 等，则会仅做翻转而不做位移。

为何 Tooltip 的内容在关闭时不会更新？

Tooltip 默认在关闭时会缓存内容，以防止内容更新时出现闪烁：

// `title` 不会因为 `user` 置空而闪烁置空
<Tooltip open={user} title={user?.name} />
no blink

如果需要在关闭时也更新内容，可以设置 fresh 属性（例如 #44830 中的场景）：

<Tooltip open={user} title={user?.name} fresh />
no blink