mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-29 21:59:41 +08:00
Code Issues Actions 33 Packages Projects Releases Wiki Activity
e91f4f2335
ant-design/components/tooltip/index.en-US.md
Benjy Cui 114016dd4e chore: add alias for getTooltipContainer
2016-12-22 12:08:17 +08:00

1.8 KiB
Raw Blame History

category type title
Components Data Display Tooltip

A simple text popup tip.

When To Use

  • The tip shows while mouse enter, and hides while mouse leave. The ToolTip doesn't support complex text and operation.
  • It can provide an explanation of button/text/operation that can cover the usage of the default system title.

API

Property Description Type Default
title prompt text string/React.Element -

Common API

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

Property Description Type Default
placement to set the position, which can be one of top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottom string top
getPopupContainer to set the container of the tip, while the default is to create a div element in body. Use getTooltipContainer if you are using antd@<2.5.2 Function(triggerNode) () => document.body
arrowPointAtCenter whether arrow pointed at the center of target, supported after antd@1.11+ Boolean false
visible make the float card visible or not boolean false
onVisibleChange callback of the visible attribute changed (visible) => void none
trigger triggering mode: can be hover, focus, or click. string hover
overlayClassName class name of the card string none
overlayStyle style of the card object none