Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TooltipProps
    • TooltipProps

Index

Properties

Optional PopperComponent

PopperComponent: React.ComponentType<PopperProps>

The component used for the popper.

Optional PopperProps

PopperProps: Partial<PopperProps>

Props applied to the Popper element.

Optional TransitionComponent

TransitionComponent: React.ComponentType<TransitionProps & { children?: React.ReactElement<any, any> }>

The component used for the transition. Follow this guide to learn more about the requirements for this component.

Optional TransitionProps

TransitionProps: TransitionProps

Props applied to the Transition element.

Optional arrow

arrow: undefined | false | true

If true, adds an arrow to the tooltip.

children

children: ReactElement<any, any>

Tooltip reference element.

Optional classes

classes: Partial<ClassNameMap<HTMLAttributes<HTMLDivElement>>>

Override or extend the styles applied to the component.

Optional customclasses

customclasses: string | string[]

Custom CSS classes to pass to the tooltip

Optional data-qa

data-qa: undefined | string

Data-qa tag to apply to the tooltip

Optional disableFocusListener

disableFocusListener: undefined | false | true

Do not respond to focus events.

Optional disableHoverListener

disableHoverListener: undefined | false | true

Do not respond to hover events.

Optional disableTouchListener

disableTouchListener: undefined | false | true

Do not respond to long press touch events.

Optional enterDelay

enterDelay: undefined | number

The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay).

Optional enterNextDelay

enterNextDelay: undefined | number

The number of milliseconds to wait before showing the tooltip when one was already recently opened.

Optional enterTouchDelay

enterTouchDelay: undefined | number

The number of milliseconds a user must touch the element before showing the tooltip.

Optional id

id: undefined | string

This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.

Optional innerRef

innerRef: React.Ref<any>

Optional interactive

interactive: undefined | false | true

Makes a tooltip interactive, i.e. will not close when the user hovers over the tooltip before the leaveDelay is expired.

Optional leaveDelay

leaveDelay: undefined | number

The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).

Optional leaveTouchDelay

leaveTouchDelay: undefined | number

The number of milliseconds after the user stops touching an element before hiding the tooltip.

Optional onClose

onClose: undefined | ((event: ChangeEvent<{}>) => void)

Callback fired when the component requests to be closed.

param

The event source of the callback.

Optional onOpen

onOpen: undefined | ((event: ChangeEvent<{}>) => void)

Callback fired when the component requests to be open.

param

The event source of the callback.

Optional open

open: undefined | false | true

If true, the tooltip is shown.

Optional placement

placement: "bottom-end" | "bottom-start" | "bottom" | "left-end" | "left-start" | "left" | "right-end" | "right-start" | "right" | "top-end" | "top-start" | "top"

Tooltip placement.

Optional style

style: CSSProperties

Any additional CSSProperties to pass to the component

title

title: NonNullable<React.ReactNode>

Tooltip title. Zero-length titles string are never displayed.

Generated using TypeDoc