Back to Ant Design

SharedProps.En US

components/tooltip/shared/sharedProps.en-US.md

6.4.43.3 KB
Original Source

<Antd component="Alert" title="The following APIs are shared by Tooltip, Popconfirm, Popover." type="info" banner="true"></Antd>

<!-- prettier-ignore -->
PropertyDescriptionTypeDefaultVersionGlobal Config
alignPlease refer to the settings dom-alignobject-×
arrowChange arrow's visible state and change whether the arrow is pointed at the center of target.boolean | { pointAtCenter: boolean }true5.2.0Tooltip: 6.0.0, Popover: 6.0.0, Popconfirm: 6.0.0
autoAdjustOverflowWhether to adjust popup placement automatically when popup is off screenbooleantrue×
colorThe background colorstring-4.3.0×
classNamesCustomize class for each semantic structure inside the component. Supports object or function.Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-5.23.0Tooltip: 5.23.0, Popover: 5.23.0, Popconfirm: 5.23.0
defaultOpenWhether the floating tooltip card is open by defaultbooleanfalse4.23.0×
destroyTooltipOnHideWhether destroy dom when closebooleanfalse×
destroyOnHiddenWhether destroy dom when closebooleanfalse5.25.0×
freshTooltip will cache content when it is closed by default. Setting this property will always keep updatingbooleanfalse5.10.0×
getPopupContainerThe DOM container of the tip, the default behavior is to create a div element in body(triggerNode: HTMLElement) => HTMLElement() => document.body×
mouseEnterDelayDelay in seconds, before tooltip is shown on mouse enternumber0.1×
mouseLeaveDelayDelay in seconds, before tooltip is hidden on mouse leavenumber0.1×
overlayClassNameClass name of the tooltip card, please use classNames.root insteadstring-×
overlayStyleStyle of the tooltip card, please use styles.rootReact.CSSProperties-×
overlayInnerStyleStyle of the tooltip inner content, please use styles.container insteadReact.CSSProperties-×
placementThe position of the tooltip relative to the target, which can be one of top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottomstringtop×
stylesCustomize inline style for each semantic structure inside the component. Supports object or function.Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-5.23.0Tooltip: 5.23.0, Popover: 5.23.0, Popconfirm: 5.23.0
triggerTooltip trigger mode. Could be multiple by passing an arrayhover | focus | click | contextMenu | Array<string>hoverTooltip: 6.1.0, Popover: 6.1.0, Popconfirm: 6.1.0
openWhether the floating tooltip card is open or not. Use visible under 4.23.0 (why?)booleanfalse4.23.0×
zIndexConfig z-index of Tooltipnumber-×
onOpenChangeCallback executed when visibility of the tooltip card is changed(open: boolean) => void-4.23.0×