# @gluedigital/tooltip

> A customizable tooltip component

Latest version **1.0.2** (published 2020-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gluedigital/tooltip
pnpm add @gluedigital/tooltip
yarn add @gluedigital/tooltip
bun add @gluedigital/tooltip
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-08-06 |
| First published | 2020-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 233.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Glue.digital |
| Maintainers | alex_bf, csar, javibt, landesag, mancontr, pablo-psichalis, thedrumz |

## Links

- npm: https://www.npmjs.com/package/@gluedigital/tooltip
- npm.io page: https://npm.io/package/@gluedigital/tooltip

## Dependencies (1)

- [sass](https://npm.io/package/sass.md) ^1.26.10

## Recent versions

- 1.0.2 (latest) — 2020-08-06
- 1.0.1 — 2020-08-05
- 1.0.0 — 2020-07-29

## README

# @gluedigital/tooltip

[![NPM](https://img.shields.io/npm/v/tooltip.svg)](https://www.npmjs.com/package/tooltip) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

A customizable tooltip component.

## Install

```bash
yarn add @gluedigital/tooltip
```

## Usage

Simply wrap the `Tooltip` component around the element that will show a tooltip when hovered over.

You can customize the tooltip with the following props:
 - **content**: Tooltip's content. Can be a string or a JSX element.
 - **position**: Position of the tooltip with respect of the element. Can be `top`, `bottom`, `right` or `left`.
 - **className**: Additional styles to apply to the tooltip.

### Example

```jsx
import React from 'react'
import { Tooltip } from '@gluedigital/tooltip'

const App = () => {
  return (
    <Tooltip
      content='Tooltip content here'
      position='left'
      className='custom-css'
    >
      <div className='element-with-tooltip'>
        Hover over me to show a tooltip!
      </div>
    </Tooltip>
  )
}

export default App
```

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