1 | <div align="center">
|
2 | <img alt="Tippy.js logo" src="https://github.com/atomiks/tippyjs/raw/master/logo.png" height="117" />
|
3 | </div>
|
4 |
|
5 | <div align="center">
|
6 | <h1>Tippy.js</h1>
|
7 | <p>A highly customizable tooltip and popover library powered by Popper.js.</p>
|
8 | <a href="https://travis-ci.org/atomiks/tippyjs">
|
9 | <img src="https://img.shields.io/travis/atomiks/tippyjs.svg?color=%2325c879&style=for-the-badge" alt="Build">
|
10 | </a>
|
11 | <a href="https://www.npmjs.com/package/tippy.js">
|
12 | <img src="https://img.shields.io/npm/dm/tippy.js.svg?color=%235599ff&style=for-the-badge" alt="npm Downloads per Month">
|
13 | <a>
|
14 | <a href="https://github.com/atomiks/tippyjs/blob/master/LICENSE">
|
15 | <img src="https://img.shields.io/npm/l/tippy.js.svg?color=%23c677cf&style=for-the-badge" alt="MIT License">
|
16 | </a>
|
17 | <br>
|
18 | <br>
|
19 | </div>
|
20 |
|
21 | ## Demo and Documentation
|
22 |
|
23 | https://atomiks.github.io/tippyjs/
|
24 |
|
25 | ## Installation
|
26 |
|
27 | ### Package Managers
|
28 |
|
29 | ```bash
|
30 | # npm
|
31 | npm i tippy.js
|
32 |
|
33 | # Yarn
|
34 | yarn add tippy.js
|
35 | ```
|
36 |
|
37 | ### CDN
|
38 |
|
39 | ```html
|
40 | <script src="https://unpkg.com/popper.js@1"></script>
|
41 | <script src="https://unpkg.com/tippy.js@4"></script>
|
42 | ```
|
43 |
|
44 | ### Modern ES modules in the browser
|
45 |
|
46 | ```html
|
47 | <script type="module">
|
48 | // Uses latest popper.js (unminified code)
|
49 | import tippy from 'https://unpkg.com/tippy.js@4?module'
|
50 | </script>
|
51 | ```
|
52 |
|
53 | ## Component Wrappers
|
54 |
|
55 | - [React component](https://github.com/atomiks/tippy.js-react)
|
56 |
|
57 | ## License
|
58 |
|
59 | MIT
|