Tooltip

Tooltip(props: ): ReactElement<WithOptionalTheme<
Tooltip<AsC,FAsC>(props: StyledComponentPropsWithAs<AsC, any, , never, AsC, FAsC>): ReactElement<StyledComponentPropsWithAs<AsC, any, , never, AsC, FAsC>, string | JSXElementConstructor<any>>

Parameters

(Mandatory parameters are in bold)

Parameters	Type	Description
props
as	undefined
as	undefined
children	ReactNode
children	ReactNode
children	ReactNode
children	ReactNode
className	string
className	string
className	string
className	string
closeOnOutsideClick	boolean	If true, a click outside the trigger element closes the tooltip
closeOnOutsideClick	boolean	If true, a click outside the trigger element closes the tooltip
closeOnOutsideClick	boolean	If true, a click outside the trigger element closes the tooltip
closeOnOutsideClick	boolean	If true, a click outside the trigger element closes the tooltip
closeOnTriggerHidden	boolean	Whether to close the tooltip when its trigger is out of boundary
closeOnTriggerHidden	boolean	Whether to close the tooltip when its trigger is out of boundary
closeOnTriggerHidden	boolean	Whether to close the tooltip when its trigger is out of boundary
closeOnTriggerHidden	boolean	Whether to close the tooltip when its trigger is out of boundary
content	ReactNode
content	ReactNode
content	ReactNode
content	ReactNode
defaultVisible	boolean	Whether tooltip is shown by default
defaultVisible	boolean	Whether tooltip is shown by default
defaultVisible	boolean	Whether tooltip is shown by default
defaultVisible	boolean	Whether tooltip is shown by default
delayHide	number
delayHide	number
delayHide	number
delayHide	number
delayShow	number	Delay in showing the tooltip (ms)
delayShow	number	Delay in showing the tooltip (ms)
delayShow	number	Delay in showing the tooltip (ms)
delayShow	number	Delay in showing the tooltip (ms)
followCursor	boolean	Whether to make the tooltip spawn at cursor position
followCursor	boolean	Whether to make the tooltip spawn at cursor position
followCursor	boolean	Whether to make the tooltip spawn at cursor position
followCursor	boolean	Whether to make the tooltip spawn at cursor position
forwardedAs	undefined
forwardedAs	undefined
interactive	boolean	If true, hovering the tooltip will keep it open. Normally tooltip closes when the mouse cursor moves out of the trigger element. If it moves to the tooltip element, the tooltip stays open.
interactive	boolean	If true, hovering the tooltip will keep it open. Normally tooltip closes when the mouse cursor moves out of the trigger element. If it moves to the tooltip element, the tooltip stays open.
interactive	boolean	If true, hovering the tooltip will keep it open. Normally tooltip closes when the mouse cursor moves out of the trigger element. If it moves to the tooltip element, the tooltip stays open.
interactive	boolean	If true, hovering the tooltip will keep it open. Normally tooltip closes when the mouse cursor moves out of the trigger element. If it moves to the tooltip element, the tooltip stays open.
kind	background | lighter | success | black | blue | green | indigo | lightblue | lightgreen | lightpink | lightyellow | orange | pink | purple | red | teal | white | yellow | dark | light | warning | info | lightest | darker | darkest | danger | primary | secondary | lightred | lightpurple | lightindigo | lightteal | lightorange
kind	background | lighter | success | black | blue | green | indigo | lightblue | lightgreen | lightpink | lightyellow | orange | pink | purple | red | teal | white | yellow | dark | light | warning | info | lightest | darker | darkest | danger | primary | secondary | lightred | lightpurple | lightindigo | lightteal | lightorange
kind	background | lighter | success | black | blue | green | indigo | lightblue | lightgreen | lightpink | lightyellow | orange | pink | purple | red | teal | white | yellow | dark | light | warning | info | lightest | darker | darkest | danger | primary | secondary | lightred | lightpurple | lightindigo | lightteal | lightorange
kind	background | lighter | success | black | blue | green | indigo | lightblue | lightgreen | lightpink | lightyellow | orange | pink | purple | red | teal | white | yellow | dark | light | warning | info | lightest | darker | darkest | danger | primary | secondary | lightred | lightpurple | lightindigo | lightteal | lightorange
mutationObserverOptions	null | MutationObserverInit	Options to MutationObserver, used internally for updating tooltip position based on its DOM changes
mutationObserverOptions	null | MutationObserverInit	Options to MutationObserver, used internally for updating tooltip position based on its DOM changes
mutationObserverOptions	null | MutationObserverInit	Options to MutationObserver, used internally for updating tooltip position based on its DOM changes
mutationObserverOptions	null | MutationObserverInit	Options to MutationObserver, used internally for updating tooltip position based on its DOM changes
offset		Shorthand for popper.js offset modifier, see https://popper.js.org/docs/v2/modifiers/offset/
offset		Shorthand for popper.js offset modifier, see https://popper.js.org/docs/v2/modifiers/offset/
offset		Shorthand for popper.js offset modifier, see https://popper.js.org/docs/v2/modifiers/offset/
offset		Shorthand for popper.js offset modifier, see https://popper.js.org/docs/v2/modifiers/offset/
onVisibleChange
onVisibleChange
onVisibleChange
onVisibleChange
placement	Placement	Alias for popper.js placement, see https://popper.js.org/docs/v2/constructors/#placement
placement	Placement	Alias for popper.js placement, see https://popper.js.org/docs/v2/constructors/#placement
placement	Placement	Alias for popper.js placement, see https://popper.js.org/docs/v2/constructors/#placement
placement	Placement	Alias for popper.js placement, see https://popper.js.org/docs/v2/constructors/#placement
popperOptions	PopperOptions
popperOptions	PopperOptions
popperOptions	PopperOptions
popperOptions	PopperOptions
theme	any
theme	any
trigger	null | TriggerType |	Event or events that trigger the tooltip
trigger	null | TriggerType |	Event or events that trigger the tooltip
trigger	null | TriggerType |	Event or events that trigger the tooltip
trigger	null | TriggerType |	Event or events that trigger the tooltip
visible	boolean	Used to create controlled tooltip
visible	booleanPartial<>, any>, string | JSXElementConstructor<any>>	Used to create controlled tooltip
visible	boolean	Used to create controlled tooltip
visible	booleanPartial<>, any>, string | JSXElementConstructor<any>>	Used to create controlled tooltip

Return

The return is of type ReactElement<WithOptionalTheme<