mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-16 09:39:10 +08:00
e7edfa42d7
* docs: update overview img * chore: code clean * chore: code clean * chore: update * chore: code clean
61 lines
3.5 KiB
Markdown
61 lines
3.5 KiB
Markdown
---
|
|
category: Components
|
|
group: Data Display
|
|
title: Tooltip
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*3u9eSZO_4c0AAAAAAAAAAAAADrJ8AQ/original
|
|
demo:
|
|
cols: 2
|
|
---
|
|
|
|
A simple text popup tip.
|
|
|
|
## When To Use
|
|
|
|
- The tip is shown on mouse enter, and is hidden on mouse leave. The Tooltip doesn't support complex text or operations.
|
|
- To provide an explanation of a `button/text/operation`. It's often used instead of the html `title` attribute.
|
|
|
|
## Examples
|
|
|
|
<!-- prettier-ignore -->
|
|
<code src="./demo/basic.tsx">Basic</code>
|
|
<code src="./demo/placement.tsx">Placement</code>
|
|
<code src="./demo/arrow-point-at-center.tsx">Arrow pointing at the center</code>
|
|
<code src="./demo/auto-adjust-overflow.tsx" debug>Adjust placement automatically</code>
|
|
<code src="./demo/destroy-tooltip-on-hide.tsx" debug>Destroy tooltip when hidden</code>
|
|
<code src="./demo/colorful.tsx">Colorful Tooltip</code>
|
|
<code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code>
|
|
|
|
## API
|
|
|
|
| Property | Description | Type | Default |
|
|
| -------- | ----------------------------- | ---------------------------- | ------- |
|
|
| title | The text shown in the tooltip | ReactNode \| () => ReactNode | - |
|
|
|
|
### Common API
|
|
|
|
The following APIs are shared by Tooltip, Popconfirm, Popover.
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| align | This value will be merged into placement's config, please refer to the settings [rc-tooltip](https://github.com/react-component/tooltip) | object | - | |
|
|
| arrowPointAtCenter | Whether the arrow is pointed at the center of target | boolean | false | |
|
|
| autoAdjustOverflow | Whether to adjust popup placement automatically when popup is off screen | boolean | true | |
|
|
| color | The background color | string | - | 4.3.0 |
|
|
| defaultOpen | Whether the floating tooltip card is open by default | boolean | false | 4.23.0 |
|
|
| destroyTooltipOnHide | Whether destroy tooltip when hidden, parent container of tooltip will be destroyed when `keepParent` is false | boolean \| { keepParent?: boolean } | false | |
|
|
| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0.1 | |
|
|
| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 | |
|
|
| overlayClassName | Class name of the tooltip card | string | - | |
|
|
| overlayStyle | Style of the tooltip card | object | - | |
|
|
| overlayInnerStyle | Style of the tooltip inner content | object | - | |
|
|
| placement | The position of the tooltip relative to the target, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | `top` | |
|
|
| trigger | Tooltip trigger mode. Could be multiple by passing an array | `hover` \| `focus` \| `click` \| `contextMenu` \| Array<string> | `hover` | |
|
|
| open | Whether the floating tooltip card is open or not. Use `visible` under 4.23.0 ([why?](/docs/react/faq#why-open)) | boolean | false | 4.23.0 |
|
|
| zIndex | Config `z-index` of Tooltip | number | - | |
|
|
| onOpenChange | Callback executed when visibility of the tooltip card is changed | (open: boolean) => void | - | 4.23.0 |
|
|
|
|
## Note
|
|
|
|
Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.
|