@leafygreen-ui/tooltip

Tooltip

View on Storybook

Installation

Yarn

yarn add @leafygreen-ui/tooltip

NPM

npm install @leafygreen-ui/tooltip

Example

import Tooltip from '@leafygreen-ui/tooltip';

<Tooltip
  align="top"
  justify="start"
  trigger={<button>trigger</button>}
  triggerEvent="hover"
  darkMode={true}
>
  I am an uncontrolled Tooltip!
</Tooltip>;

Output HTML

<button aria-describedby="tooltip-6">
  trigger
  <div class="leafygreen-ui-1hyfx7x"></div>
</button>
<div>
  <div class="leafygreen-ui-63ea86">
    <div role="tooltip" id="tooltip-6" class="leafygreen-ui-a17v6a">
      <div class="leafygreen-ui-11wlmto">
        <div class="leafygreen-ui-ry7wu4"></div>
      </div>
      I am an uncontrolled Tooltip!
    </div>
  </div>
</div>

Properties

Prop	Type	Description	Default
open	boolean	Controls the component, and determines whether or not the <Tooltip /> will appear open or closed.	false
setOpen	function	If controlling the component, pass state handling function to setOpen prop. This will keep the consuming application's state in-sync with LeafyGreen's state, while the <Tooltip /> component responds to events such as backdrop clicks and a user pressing the Escape key.	(boolean) => boolean
shouldClose	function	Callback that should return a boolean that determines whether or not the <Tooltip /> should close when a user tries to close it.	() => true
align	'top', 'bottom', 'left', 'right'	Determines the preferred alignment of the <Tooltip /> component relative to the element passed to the trigger prop. If no trigger is passed, the Tooltip will be positioned against its nearest parent element.	'top'
justify	'start', 'middle', 'end', 'fit'	Determines the preferred justification of the <Tooltip /> component (based on the alignment) relative to the element passed to the trigger prop. If no trigger is passed, the Tooltip will be positioned against its nearest parent element.	'start'
trigger	HTMLElement or ReactNode	An HTMLElement or ReactNode against which the <Tooltip /> will be positioned, and what will be used to trigger the opening and closing of the Tooltip component, when the Tooltip is uncontrolled. If no trigger is passed, the Tooltip will be positioned against its nearest parent element. If using a ReactNode or inline function, trigger signature is: ({children, ...rest}) => (<button {...rest}>trigger {children}). When using a function, you must pass children as an argument in order for the tooltip to render.
triggerEvent	'hover' or 'click'	DOM event that triggers opening/closing of <Tooltip /> component	'hover'
darkMode	boolean	Determines if the <Tooltip /> will appear in dark mode.	false
id	string	id applied to <Tooltip /> component
className	string	Applies a className to Tooltip container
children	node	Content that will be rendered inside of <Tooltip />
usePortal	boolean	Determines whether or not the Tooltip will be Portaled	true
enabled	boolean	Enables Tooltip to trigger based on the event specified by triggerEvent.	true

Any other properties will be spread on the Tooltip div container