tooltip

React tooltip focused on simplicity and performance

Jun 16, 2019
React tooltip focused on simplicity and performance

React tooltip-lite

A lightweight and responsive tooltip. Feel free to Post an issue if you're looking to support more use cases.

View Demo View Github

Getting started

1. Install with NPM

$ npm install react-tooltip-lite

2. Import into your react Component

import Tooltip from 'react-tooltip-lite';

3. Wrap any element with the Tooltip component to make it a target

<Tooltip content="Go to google"> <a href="http://google.com"> edge</a> </Tooltip>

styling

By default you need to style react-tooltip-lite with CSS, this allows for psuedo elements and some cool border tricks, as well as using css/sass/less variables and such to keep your colors consistent. (Note: as of version 1.2.0 you can also pass the "useDefaultStyles" prop which will allow you to use react-tooltip-lite without a stylesheet.)

Since the tooltip's arrow is created using the css border rule (https://css-tricks.com/snippets/css/css-triangle/), you'll want to specify the border-color for the arrow to set it's color.

Here's an example stylesheet:

.react-tooltip-lite { background: #333; color: white; } .react-tooltip-lite-arrow { border-color: #333; }

Props

You can pass in props to define tip direction, styling, etc. Content is the only required prop.

NameTypeDescription
contentnode (text or html)the contents of your hover target
tagNamestringhtml tag used for className
directionstringthe tip direction, defaults to up. Possible values are "up", "down", "left", "right" with optional modifer for alignment of "start" and "end". e.g. "left-start" will attempt tooltip on left and align it with the start of the target. If alignment modifier is not specified the default behavior is to align "middle".
forceDirectionbooleanTells the tip to allow itself to render out of view if there's not room for the specified direction. If undefined or false, the tip will change direction as needed to render within the confines of the window.
classNamestringcss class added to the rendered wrapper (and the tooltip if tooltipClassName is undefined) NOTE: in future versions className will only be applied to the wrapper element and not the tooltip
tipContentClassNamestringcss class added to the tooltip
tipContentHoverbooleandefines whether you should be able to hover over the tip contents for links and copying content, defaults to false.
backgroundstringbackground color for the tooltip contents and arrow
colorstringtext color for the tooltip contents
paddingstringpadding amount for the tooltip contents (defaults to '10px')
stylesobjectstyle overrides for the target wrapper
eventOnstringfull name of supported react event to show the tooltip, e.g.: 'onClick'
eventOffstringfull name of supported react event to hide the tooltip, e.g.: 'onClick'
eventTogglestringfull name of supported react event to toggle the tooltip, e.g.: 'onClick', default hover toggling is disabled when using this option
useHoverbooleanwhether to use hover to show/hide the tip, defaults to true
useDefaultStylesbooleanuses default colors for the tooltip, so you don't need to write any CSS for it
isOpenbooleanforces open/close state from a prop, overrides hover or click state
hoverDelaynumberthe number of milliseconds to determine hover intent, defaults to 200
arrowbooleanWhether or not to have an arrow on the tooltip, defaults to true
arrowSizenumberNumber in pixels of the size of the arrow, defaults to 10
distancenumberThe distance from the tooltip to the target, defaults to 10px with an arrow and 3px without an arrow

Here's an example using more of the props:

<Tooltip content={( <div> <h4 className="tip-heading">An unordered list to demo some html content</h4> <ul className="tip-list"> <li>One</li> <li>Two</li> <li>Three</li> <li>Four</li> <li>Five</li> </ul> </div> )} direction="right" tagName="span" className="target" > Target content for big html tip </Tooltip>

To see more usage examples, take look at the /example folder in the source.

GitHub

Recommended