tippy.js/README.md

Highly customizable tooltip and popover library

<div align="center">
  <img alt="Tippy.js logo" src="https://github.com/atomiks/tippyjs/raw/master/logo.png" height="117" />
</div>

<div align="center">
  <h1>Tippy.js</h1>
  <p>A highly customizable tooltip and popover library powered by Popper.js.</p>
  <a href="https://www.npmjs.com/package/tippy.js">
   <img src="https://img.shields.io/npm/dm/tippy.js.svg?color=%235599ff&style=for-the-badge" alt="npm Downloads per Month">
  <a>
  <a href="https://github.com/atomiks/tippyjs/blob/master/LICENSE">
    <img src="https://img.shields.io/npm/l/tippy.js.svg?color=%23c677cf&style=for-the-badge" alt="MIT License">
  </a>
  <br>
  <br>
</div>

## Demo and Documentation

➡️ **[View the latest demo & docs here](https://atomiks.github.io/tippyjs/)**

[View migration guide from v4 to v5](https://github.com/atomiks/tippyjs/blob/master/MIGRATION_GUIDE.md)

[4.x docs](https://github.com/atomiks/tippyjs/tree/623e8416fbb314741db603c997081512105c0d96/website/src/pages)

## Installation

### Package Managers

```bash
# npm
npm i tippy.js

# Yarn
yarn add tippy.js
```

Import the `tippy` constructor and the core CSS:

```js
import tippy from 'tippy.js';
import 'tippy.js/dist/tippy.css';
```

### CDN

```html
<script src="https://unpkg.com/popper.js@1"></script>
<script src="https://unpkg.com/tippy.js@5"></script>
```

The core CSS comes bundled with the default unpkg import.

## Usage

For detailed usage information, [visit the docs](https://atomiks.github.io/tippyjs/creating-tooltips/).

## Component Wrappers

React: [@tippy.js/react](https://github.com/atomiks/tippy.js-react)

## License

MIT