easy-tooltip v1.0.0

easy-tooltip

Very easy to use tooltip. Highly customisable. There are a lot of pretty complex tooltip libraries. In my opinion tooltips shouldn't be more than a little DOM change. Let me know if there is anything you miss, or when you run into issues.

Properties

• tip: (string | HTML)
• tipPosition: "top" | "right" | "bottom" | "left", default "top"
• arrowPosition: "start" | "center" | "end", default "center"
• backgroundColor: any web color, default #000000bd
• textColor: any web color, default #ffffff
• maxWidth: parent | length | percentage, default none
• animated: boolean, default false

How to use

Use in plain HTML

The properties are matched by the use of data attributes on your HTML element. Usage of a <span> is recommended.

<p>This is an <span data-tip="Hello world">example</span> text with a tooltip</p>

Or with HTML:

<p>This is an <span data-tip="Hello<br>world<br>This<br>would<br>have<br>line-breaks">example</span> text with a tooltip</p>

Other data attributes:

• data-tip
• data-tip-position
• data-tip-arrow-position
• data-tip-bg-color
• data-tip-text-color
• data-tip-max-width
• data-animated

Only one required is of course data-tip. All others are optional to add styling of your choice.

Use in React

Import the javascript and css files in the root app. And run in useEffect to only run once.

import EasyTooltip from 'easy-tooltip';
import 'easy-tooltip/dist/easy-tooltip.min.css';

useEffect(() => {
  EasyTooltip();
});

Then you can create a React component to simplify things, for example:

import React from 'react';

export function Tip({
        children,
        tip,
        position,
        bgColor,
        color,
        arrowPosition,
        width,
    }) {
    return (
        <span
            data-tip={tip}
            data-tip-position={position}
            data-tip-bg-color={bgColor}
            data-tip-text-color={color}
            data-tip-arrow-position={arrowPosition}
            data-tip-max-width={width}
        >
            {children}
        </span>
    );
}

And use that component everywhere you want.

<Tip tip="Hello world" position="left" bgColor="#ff0000bd">
   save
</Tip>