# react-a11y-tooltip

> An accessible, configurable React tooltip component

Latest version **0.4.0** (published 2018-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-a11y-tooltip
pnpm add react-a11y-tooltip
yarn add react-a11y-tooltip
bun add react-a11y-tooltip
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2018-07-12 |
| First published | 2018-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Fotis Papadogeorgopoulos |
| Maintainers | fpapado |
| Keywords | react, a11y, accessibility, tooltip, aria |

## Links

- npm: https://www.npmjs.com/package/react-a11y-tooltip
- Repository: https://github.com/fpapado/react-a11y-tooltip
- Homepage: https://github.com/fpapado/react-a11y-tooltip#readme
- Issues: https://github.com/fpapado/react-a11y-tooltip/issues
- npm.io page: https://npm.io/package/react-a11y-tooltip

## Dependencies (2)

- [@types/react](https://npm.io/package/@types/react.md) ^16.4.6
- [react-faux-button](https://npm.io/package/react-faux-button.md) ^0.3.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.4.0 (latest) — 2018-07-12
- 0.3.0 — 2018-07-12
- 0.2.0 — 2018-07-12
- 0.1.0 — 2018-07-12
- 0.0.1-security — 2018-07-11

## README

# React A11y Tooltip

> Accessible React Tooltip component

## Table of Contents

* [Features](#features)
* [Install](#install)
* [Motivation](#motivation)
* [Usage](#usage)

## Features

* Full presentational control for the caller (render props).
* Easy to understand source code. You should be able to fork and do your thing if desired.
* Ample documentation to help you understand the problem, in addition to the solutions.

What it does not do by itself:

* Style the tooltip. That is up to you :)

## Install

This package is distributed via [npm](https://www.npmjs.com/get-npm).

```shell
$ npm install --save react-a11y-tooltip
# or
$ yarn add react-a11y-tooltip
```

Then import according to your modules model and bundler, such as [Rollup](https://rollupjs.org/guide/en) and [Webpack](https://webpack.js.org/):

```js
// ES Modules
import { Tooltip } from "react-a11y-tooltip";

/// CommonJS modules
const { Tooltip } = require("react-a11y-tooltip");
```

A [UMD](https://github.com/umdjs/umd) version is also available on [unpkg](https://unpkg.com/):

```html
<script src="https://unpkg.com/react-a11y-tooltip/dist/react-a11y-tooltip.umd.js"></script>
```

## Motivation
:construction: WIP :construction

## Usage
### Quick Start

If you want to just dive in, do this:

```jsx
import { Tooltip } from "react-a11y-tooltip";

// NOTE: Styles are important for this to work.
// You can also copy or overwrite them.
import "react-a11y-tooltip/dist/react-a11y-tooltip.css";

function App() {
  return (
    <div className="App">
      <p>
        The team had a great{" "}
        <Tooltip purpose="descriptive" renderTooltip="Games Played">
          GP
        </Tooltip>/
        <Tooltip purpose="descriptive" renderTooltip="Games Won">
          GW
        </Tooltip>{" "}
        ratio this season.
      </p>
    </div>
  );
}

```

---
_Source: https://npm.io/package/react-a11y-tooltip · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._