Tooltip 文字提示
简单的文字提示气泡框。
何时使用
鼠标移入则显示提示,移出消失,气泡浮层不承载复杂文本和操作。
可用来代替系统默认的 title
提示,提供一个按钮/文字/操作
的文案解释。
代码演示
基本
最简单的用法。
import React from 'react';
import ReactDOM from 'react-dom';
import { Tooltip } from 'choerodon-ui';
ReactDOM.render(
<Tooltip title="prompt text">
<span>Tooltip will show when mouse enter.</span>
</Tooltip>,
document.getElementById('container'));
位置
位置有 12 个方向。
import React from 'react';
import ReactDOM from 'react-dom';
import { Tooltip, Button } from 'choerodon-ui';
const text = <span>prompt text</span>;
const buttonWidth = 70;
ReactDOM.render(
<div className="demo">
<div style={{ marginLeft: buttonWidth, whiteSpace: 'nowrap' }}>
<Tooltip placement="topLeft" title={text}>
<Button style={{ marginRight: '4px' }}>TL</Button>
</Tooltip>
<Tooltip placement="top" title={text}>
<Button style={{ marginRight: '4px' }}>Top</Button>
</Tooltip>
<Tooltip placement="topRight" title={text}>
<Button style={{ marginRight: '4px' }}>TR</Button>
</Tooltip>
</div>
<div style={{ width: buttonWidth, float: 'left' }}>
<Tooltip placement="leftTop" title={text}>
<Button style={{ marginTop: '4px' }}>LT</Button>
</Tooltip>
<Tooltip placement="left" title={text}>
<Button style={{ marginTop: '4px' }}>Left</Button>
</Tooltip>
<Tooltip placement="leftBottom" title={text}>
<Button style={{ marginTop: '4px' }}>LB</Button>
</Tooltip>
</div>
<div style={{ width: buttonWidth, marginLeft: buttonWidth * 4 }}>
<Tooltip placement="rightTop" title={text}>
<Button style={{ marginTop: '4px' }}>RT</Button>
</Tooltip>
<Tooltip placement="right" title={text}>
箭头指向
设置了 arrowPointAtCenter
后,箭头将指向目标元素的中心。
import React from 'react';
import ReactDOM from 'react-dom';
import { Tooltip, Button } from 'choerodon-ui';
ReactDOM.render(
<div>
<Tooltip placement="topLeft" title="Prompt Text">
<Button style={{ marginRight: '4px' }}>Align edge / 边缘对齐</Button>
</Tooltip>
<Tooltip placement="topLeft" title="Prompt Text" arrowPointAtCenter>
<Button style={{ marginRight: '4px' }}>
Arrow points to center / 箭头指向中心
</Button>
</Tooltip>
</div>,
document.getElementById('container'),
);
API
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
title | 提示文字 | string|ReactNode|() => ReactNode | 无 |
共同的 API
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
arrowPointAtCenter | 箭头是否指向目标元素中心 | boolean | false |
autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true |
defaultVisible | 默认是否显隐 | boolean | false |
getPopupContainer | 浮层渲染父节点,默认渲染到 body 上。2.5.2 之前请使用 getTooltipContainer | Function(triggerNode) | () => document.body |
mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0 |
mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 |
overlayClassName | 卡片类名 | string | 无 |
overlayStyle | 卡片样式 | object | 无 |
placement | 气泡框位置,可选 top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottom | string | top |
trigger | 触发行为,可选 hover/focus/click/contextMenu | string | hover |
visible | 用于手动控制浮层显隐 | boolean | false |
onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 |
注意
请确保 Tooltip
的子元素能接受 onMouseEnter
、onMouseLeave
、onFocus
、onClick
事件。
当前内容版权归 Choerodon UI 或其关联方所有,如需对内容或内容相关联开源项目进行关注与资助,请访问 Choerodon UI .