React Tooltip

react tooltip component

Tooltip

ReactTooltip/react-tooltip reacttooltip.github.io/react-tooltip/react-tooltip

README

react-tooltip

[![npm download][download-image]][download-url]

[download-image]: https://img.shields.io/npm/dm/react-tooltip.svg?style=flat-square

[download-url]: https://npmjs.org/package/react-tooltip

Demo

Or see it on Github Page.

Installation

```sh
npm install react-tooltip
```

```sh
yarn add react-tooltip
```

Usage

Using NPM

1 . Require react-tooltip after installation

``` js
import ReactTooltip from 'react-tooltip';
```

2 . Add data-tip = "your placeholder" to your element

``` js
<p data-tip="hello world">Tooltip</p>
```

3 . Include react-tooltip component

``` js
<ReactTooltip />
```

Standalone

You can import node_modules/react-tooltip/dist/index.js into your page. Please make sure that you have already imported react and react-dom into your page.

Options

Notes:

- The tooltip sets type: dark place: top effect: float as default attributes. You don't have to add these options if you don't want to change the defaults

- The option you set on `` component will be implemented on every tooltip in a same page: ``- The option you set on a specific element, for example: `` will only affect this specific tooltip

| :------------------- | :-------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| offset | data-offset | Object | { top?: number, right?: number, bottom?: number, left?: number } | data-offset="{'top': 10, 'left': 10}" for specific and offset={{top: 10, left: 10}} for global |

` or ``, but see [Security Note](#security-note) below.
When using JSX, see [this note](#jsx-note) below. || delayHide | data-delay-hide | Number | | `

` or `` || delayShow | data-delay-show | Number | | `

` or `` || delayUpdate | data-delay-update | Number | | `

` or `` Sets a delay in calling getContent if the tooltip is already shown and you mouse over another target |

| getContent | null | Func or Array | (dataTip) => {}, [(dataTip) => {}, Interval] | Generate the tip content dynamically |

| afterShow | null | Func | (evt) => {} | Function that will be called after tooltip show, with event that triggered show |

| afterHide | null | Func | (evt) => {} | Function that will be called after tooltip hide, with event that triggered hide |

| overridePosition | null | Func | ({left:number, top: number}, currentEvent, currentTarget, node, place, desiredPlace, effect, offset) => ({left: number, top: number}) | Function that will replace tooltip position with custom one |

Security Note

The html option allows a tooltip to directly display raw HTML. This is a security risk if any of that content is supplied by the user. Any user-supplied content must be sanitized, using a package like sanitize-html. We chose not to include sanitization after discovering it increased our package size too much - we don't want to penalize people who don't use thehtml option.

JSX Note

You can use React's [renderToStaticMarkup-function](https://reactjs.org/docs/react-dom-server.html#rendertostaticmarkup) to use JSX instead of HTML. You still need to set data-html={true}.

Example:

``` js
import ReactDOMServer from 'react-dom/server';
[...]
<p data-html={true} data-tip={ReactDOMServer.renderToString(<div>I am <b>JSX</b> contentdiv>)}>
Hover me
</p>
```

Note

1. **data-tip** is necessary, because `` finds the tooltip via this attribute2. **data-for** corresponds to the **id** of ``3. When using react component as tooltip, you can have many `` in a page but they should have different **id**s

Static Methods

ReactTooltip.hide(target)

Hide the tooltip manually, the target is optional, if no target passed in, all existing tooltips will be hidden

``` js
import ReactTooltip from 'react-tooltip'
<p ref={ref => this.fooRef = ref} data-tip='tooltip'></p>
<button onClick={() => { ReactTooltip.hide(this.fooRef) }}></button>
<ReactTooltip />
```

ReactTooltip.rebuild()

Rebinding all tooltips

ReactTooltip.show(target)

Show specific tooltip manually, for example:

``` js
import ReactTooltip from 'react-tooltip'
<p ref={ref => this.fooRef = ref} data-tip='tooltip'></p>
<button onClick={() => { ReactTooltip.show(this.fooRef) }}></button>
<ReactTooltip />
```

Troubleshooting

1. Using tooltip within the modal (e.g. react-modal)

The component was designed to set `` once and then use tooltip everywhere, but a lot of people get stuck when using this component in a modal. You can read the discussion [here](https://github.com/wwayne/react-tooltip/issues/130). To solve this problem:

1. Place `` outside of the ``

2. Use ReactTooltip.rebuild() when opening the modal

3. If your modal's z-index happens to be higher than the tooltip's, use the attribute className to custom your tooltip's z-index

I suggest always putting <ReactTooltip /> in the Highest level or smart component of Redux, so you might need these static

method to control tooltip's behaviour in some situations

2. Hide tooltip when getContent returns undefined

When you set getContent={() => { return }} you will find the tooltip will display true. That's because React will set the value of data-\* to be 'true' automatically if there is no value to be set. So you have to set data-tip='' in this situation.

``` js
<p data-tip='' data-for='test'></p>
<ReactTooltip id='test' getContent={() => { return null }}/>
```

Same for empty children, if you don't want show the tooltip when the children is empty

``` js
<p data-tip='' data-for='test'></p>
<ReactTooltip id='test'>{}</ReactTooltip>
```

3. Tooltip not binding to dynamic content

When you render `` ahead of dynamic content, and are using `data-for={id}` attributes

on new dynamic content, the tooltip will not register its event listener.

For example, you render a generic tooltip in the root of your app, then load a list of content async.

Elements in the list use the data-for={id} attribute to bind the tooltip on hover.

Since the tooltip has already scanned for data-tip these new elements will not trigger.

One workaround for this is to trigger ReactTooltip.rebuild() after the data load to scan for the attribute again,

to allow event wireup.

Example

``` js
<app>
<ReactTooltip id="foo" />
<list />
</app>
```

``` js
const dynamicList = (props) => {
useEffect(() => {
ReactTooltip.rebuild();
});
return(
<list>
{data.map((item)=> {
<span data-for="foo">My late bound tooltip triggered data</span>
});}
</list>
);
};
```

Article

How I insert sass into react component

Maintainers

danielbarion Casual maintainer - accepting PRs and doing minor testing/development.

alexgurr Casual maintainer - accepting PRs and doing minor testing/development.

pdeszynski Casual maintainer - accepting PRs and doing minor testing/development.

aronhelser Passive maintainer - accepting PRs and doing minor testing, but not fixing issues or doing active development.

roggervalf (inactive).

huumanoid (inactive)

We would gladly accept a new maintainer to help out!

Contributing

We welcome your contribution! Fork the repo, make some changes, submit a pull-request! Our contributing doc has some details.

License

MIT