React Tooltip Component API

Tooltip API

Explore the API reference for the React Tooltip component and discover how to effectively utilize its props for customization.

On this page

CTooltip

jsx
import { CTooltip } from '@coreui/react-pro'
PropertyDefaultType
animation4.9.0+trueboolean, undefined

Enables or disables the CSS fade transition for the React Tooltip.

className-string, undefined

Adds a custom class name to the React Tooltip container. Useful for overriding default styles or applying additional design choices.

container4.11.0+document.bodyElement, DocumentFragment, (() => Element | DocumentFragment | null), null, undefined

Appends the React Tooltip to a specific element instead of the default document.body. You may pass: - A DOM element (HTMLElement or DocumentFragment) - A function that returns a single element - null

content-ReactNode

Content to be displayed within the React Tooltip. Can be a string or any valid React node.

delay4.9.0+-number, { show: number; hide: number; }, undefined

The delay (in milliseconds) before showing or hiding the React Tooltip. - If provided as a number, the delay is applied to both "show" and "hide". - If provided as an object, it should have distinct "show" and "hide" values.

fallbackPlacements4.9.0+['top', 'right', 'bottom', 'left']'top', 'right', 'bottom', 'left', ('top', 'right', 'bottom', 'left')[]

Array of fallback placements for the React Tooltip to use when the preferred placement cannot be achieved. These placements are tried in order.

offset[0, 6][number, number], undefined

Adjusts the offset of the React Tooltip relative to its target. Expects a tuple [x-axis, y-axis].

onHide-(() => void), undefined

Callback fired immediately after the React Tooltip is hidden.

onShow-(() => void), undefined

Callback fired immediately after the React Tooltip is shown.

placementtop'auto', 'top', 'bottom', 'right', 'left', undefined

Initial placement of the React Tooltip. Note that Popper.js modifiers may alter this placement automatically if there's insufficient space in the chosen position.

popperConfig5.5.0+-Partial<Options>, ((defaultPopperConfig: Partial<Options>) => Partial<Options>), undefined

Customize the Popper.js configuration used to position the React Tooltip. Pass either an object or a function returning a modified config. [Learn more](https://popper.js.org/docs/v2/constructors/#options)

trigger['hover', 'focus']'hover', 'focus', 'click', ('hover' | 'focus' | 'click')[]

Determines the events that toggle the visibility of the React Tooltip. Can be a single trigger or an array of triggers.

visible-boolean, undefined

Controls the visibility of the React Tooltip. - true to show the tooltip. - false to hide the tooltip.