tippyjs README

The project's README from github.com/atomiks/tippyjs. As one markdown file: README.md.

Tippy.js logo

Tippy.js

The complete tooltip, popover, dropdown, and menu solution for the web

npm Downloads per Month MIT License

Demo and Documentation

➡️ View the latest demo & docs here

Migration Guide

Installation

Package Managers

# npm
npm i tippy.js

# Yarn
yarn add tippy.js

Import the tippy constructor and the core CSS:

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

CDN

<script src="https://unpkg.com/@popperjs/core@2"></script>
<script src="https://unpkg.com/tippy.js@6"></script>

The core CSS comes bundled with the default unpkg import.

Usage

For detailed usage information, visit the docs.

Component Wrappers

License

MIT

tippyjs (atomiks/tippyjs)

tooltip
Searching Database…

12.2K ·GitHub
archived
What is this?Tippy.js is a complete tooltip, popover, dropdown, and menu library for the web, handling positioning and interactions for all of these UI elements with one core engine.
Is this a plain JavaScript library, or do I need a specific framework?It's a framework-agnostic vanilla JS library at its core, but it ships with an official React wrapper and a community-maintained Ember wrapper for those ecosystems.
How do I add it to my project?Install it through a package manager and import the tippy constructor plus the core CSS, or skip the build step entirely and load it from the unpkg CDN, which already bundles that CSS.
Does it rely on another library under the hood?Yes, tippy.js is built on top of @popperjs/core, which handles the actual positioning math for tooltips and menus.
Is tippy.js still actively maintained?No, the repository is archived, so it's effectively frozen: no new features, bug fixes, or security patches are expected going forward.
What UI elements can tippy.js build besides basic tooltips?The same engine also powers popovers, dropdowns, menus, and combobox-style widgets, all sharing the core positioning and interaction logic.
Does it come with ready-made styling, or do I need to write my own CSS?It ships with a core CSS file you import alongside the JS, and the unpkg CDN build already bundles that CSS for you automatically.
Is there help for upgrading between tippy.js versions?Yes, the README links out to a dedicated Migration Guide for moving between major versions.
Can I use tippy.js with React or Ember specifically?Yes, there's an official @tippyjs/react wrapper plus an unofficial community-built ember-tippy wrapper for Ember apps.
Creator
atomiks
Size
17 MB
Stars
12.2K
Age
9y
Commits · 90 Days