React Tooltip Component API
Tooltip API
Explore the API reference for theReact Tooltip component and discover how to effectively utilize its props for customization.
CTooltip#
import{CTooltip}from'@coreui/react'// orimportCTooltipfrom'@coreui/react/src/components/tooltip/CTooltip'
Property | Default | Type |
---|---|---|
animation#4.9.0+ | true | boolean |
Enables or disables the CSS fade transition for the React Tooltip. | ||
className# | - | string |
Adds a custom class name to the React Tooltip container. Useful for overriding default styles or applying additional design choices. | ||
container#4.11.0+ | document.body | Element ,DocumentFragment ,(() => Element | DocumentFragment) |
Appends the React Tooltip to a specific element instead of the default
| ||
content# | - | ReactNode |
Content to be displayed within the React Tooltip. Can be a string or any valid React node. | ||
delay#4.9.0+ | 0 | number ,{ show: number; hide: number; } |
The delay (in milliseconds) before showing or hiding the React Tooltip.
| ||
fallbackPlacements#4.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] |
Adjusts the offset of the React Tooltip relative to its target. Expects a tuple
| ||
onHide# | - | () => void |
Callback fired immediately after the React Tooltip is hidden. | ||
onShow# | - | () => void |
Callback fired immediately after the React Tooltip is shown. | ||
placement# | top | 'auto' ,'top' ,'bottom' ,'right' ,'left' |
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. | ||
popperConfig#5.5.0+ | - | Partial<Options> ,((defaultPopperConfig: Partial<Options>) => Partial<Options>) |
Customize the Popper.js configuration used to position the React Tooltip. Pass either an object or a function returning a modified config.Learn more
| ||
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 |
Controls the visibility of the React Tooltip.
|