mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-01 14:59:35 +08:00
Code Issues Actions 34 Packages Projects Releases Wiki Activity
862cbbceec
ant-design/components/tooltip/index.en-US.md
Wendell 889a9ba9fd
fix: fix tooltip trigger type (#22043) 
* fix: fix tooltip trigger type

* fix: use extends over duck type

* update rc-tooltip deps

* fix rate ts define

Co-authored-by: 二货机器人 <smith3816@gmail.com>
2020-03-11 21:10:40 +08:00

2.4 KiB
Raw Blame History

category type title
Components Data Display Tooltip

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.

API

Property Description Type Default
title The text shown in the tooltip string|ReactNode|() => ReactNode -

Common API

The following APIs are shared by Tooltip, Popconfirm, Popover.

Property Description Type Default
arrowPointAtCenter Whether the arrow is pointed at the center of target, supported after antd@1.11+ boolean false
autoAdjustOverflow Whether to adjust popup placement automatically when popup is off screen boolean true
defaultVisible Whether the floating tooltip card is visible by default boolean false
getPopupContainer The DOM container of the tip, the default behavior is to create a div element in body Function(triggerNode) () => 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 -
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
visible Whether the floating tooltip card is visible or not boolean false
onVisibleChange Callback executed when visibility of the tooltip card is changed (visible) => void -
align this value will be merged into placement's config, please refer to the settings rc-tooltip Object -

Note

Please ensure that the child node of Tooltip accepts onMouseEnter, onMouseLeave, onFocus, onClick events.