<Tooltip> Component

<Tooltip> represents advisory information related to the element it belongs.

Here the demo:

Preview

Installing <Tooltip> Component

There are 2 ways to install <Tooltip> component into your react app project:

  • Install the Specific Package of <Tooltip> Component
  • Install the Whole Reusable-UI Component Pack, including the <Tooltip> Component

expanded Property

Expands/Collapses the <Tooltip>.

The possible values are:

  • undefined
  • true
  • false

Here the preview:

Preview

<Tooltip expanded={true}> 

Show code

expandDelay Property

Defines the minimum duration (in milliseconds) of the user for hovering/focusing of the corresponding component to show the <Tooltip>.

collapseDelay Property

Defines the minimum duration (in milliseconds) of the user for leaving/un-focusing of the corresponding component to hide the <Tooltip>.

lazy Property

Determines whenever the <Tooltip>'s children should be rendered or not when the <Tooltip expanded={false}>.

The possible values are:

  • undefined
  • false
  • true

Floating Properties

Determines how the <Tooltip> should be floating on the target DOM reference.

floatingOn Property

Determines the target DOM reference where the <Tooltip> should be floating on.
If not set (undefined), the <Tooltip> becomes a normal element flow.

Here the preview:

Preview

Show code

floatingPlacement Property

Determines the location where the <Tooltip> should be floating on the target DOM reference.

Here the preview:

floatingPlacement='top'

floatingStrategy Property

Determines the technical strategy how the <Tooltip> can float.
In most cases, you should not worry about the detail mechanism how the <Tooltip> can float.

The possible values are:

  • undefined
  • 'absolute'
  • 'fixed'

floatingAutoFlip Property

Automatically flips the floatingPlacement to opposite direction when the <Tooltip> is about to be clipped.

The possible values are:

  • undefined
  • true
  • false

Here the preview:

Preview

Show code

floatingAutoShift Property

Automatically shifts the floatingPlacement to nearest safe position when the <Tooltip> is about to be clipped.

The possible values are:

  • undefined
  • true
  • false

Here the preview:

Preview

Show code

floatingOffset Property

The distance (in pixel) between the <Tooltip> and the target DOM reference.

The possible values are:

  • undefined
  • 0
  • positive number
  • negative number

Here the preview:

Preview

<Tooltip floatingOffset={0}>

Show code

floatingShift Property

The distance (in pixel) between the <Tooltip> and the default floatingPlacement location.

The possible values are:

  • undefined
  • 0
  • positive number
  • negative number

Here the preview:

Preview

<Tooltip floatingShift={0}>

Show code

onFloatingUpdate Property

Sets a callback function to be called when the <Tooltip> updates the position relative to the target DOM reference.

The callback function parameters:

  • event: FloatingPosition

Variant Properties

The alternative appearances of the <Tooltip> layout without changing the <Tooltip>'s functionality.

size Property

Defines the alternative size of the <Tooltip>.

The possible values are:

  • undefined
  • 'sm'
  • 'md'
  • 'lg'

Here the preview:

Preview

Show code

theme Property

Defines the contextual theme of the <Tooltip>.

The possible values are:

  • undefined
  • 'primary'
  • 'secondary'
  • 'success'
  • 'info'
  • 'warning'
  • 'danger'
  • 'light'
  • 'dark'

Here the preview:

Preview

Show code

gradient Property

Activates a 3D mode of the <Tooltip>.

The possible values are:

  • undefined
  • 'inherit'
  • true
  • false

Here the preview:

Preview

Show code

outlined Property

Activates an outlined mode (background-less, contrast foreground, and contrast border) of the <Tooltip>.

The possible values are:

  • undefined
  • 'inherit'
  • true
  • false

Here the preview:

Preview

Show code

mild Property

Activates a mild mode (mild background, contrast foreground, and contrast border) of the <Tooltip>.

The possible values are:

  • undefined
  • 'inherit'
  • true
  • false

Here the preview:

Preview

Show code

nude Property

Activates an nude mode (background-less, padding-less, and border-less) of the <Tooltip>.

The possible values are:

  • undefined
  • true
  • false

Here the preview:

Preview

Show code

Component Properties

Overwrites the internal (sub) components used as the composition of <Tooltip> component.

arrowComponent Property

Overwrites the internal <Generic> component used as the arrow of <Tooltip> component.

<Tooltip arrowComponent={
    <MyCustomArrow />
} />

arrowRef Property

Gets the DOM reference of the internal <Generic> component used as the arrow of <Tooltip> component.

<Tooltip arrowRef={fooArrowRef} />
is equivalent to:
<Tooltip arrowComponent={
    <Generic elmRef={fooArrowRef} />
} />

Variables

There are several variables of <Tooltip> you can customize. Changing the variables affects all <Tooltip> instance and other components that depend on <Tooltip>.

Here the exposed variables:

  • Backgrounds, Foregrounds, Borders, & Rings
  • Animations
  • Typos
  • Arrows

The example of accessing, modifying, & adding variables:

Show code