# react-glamorous-tooltip

> react tooltip component

Latest version **1.0.5** (published 2017-08-22) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2017-08-22 |
| First published | 2017-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | anchen.li |
| Maintainers | mzbac |
| Keywords | react, tooltip, glamorous |

## Links

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

## Dependencies (2)

- [glamor](https://npm.io/package/glamor.md) ^2.20.40
- [glamorous](https://npm.io/package/glamorous.md) ^4.2.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

- 1.0.5 (latest) — 2017-08-22
- 1.0.4 — 2017-08-22
- 1.0.2 — 2017-08-21
- 1.0.1 — 2017-08-18
- 1.0.0 — 2017-08-18

## README

# react-glamorous-tooltip

## Installation
```sh
npm install react-glamorous-tooltip
```
## Usage
**Using NPM**

1 . Require react-glamorous-tooltip after installation

```js
import Tooltip from 'react-glamorous-tooltip'
```
2 . Include react-glamorous-tooltip component
```js
<Tooltip visible targetElm={this.self} position="bottom" arrow="center" >

</Tooltip>
```
3 . Using react-glamorous-tooltip component wrap up your tooltip content
```js
<Tooltip visible targetElm={this.self} position="bottom" arrow="center" >
     <p>your Tooltip content</p>
</Tooltip>
```
## Demo

[![Edit ym07mzlxnx](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/ym07mzlxnx)

## Props

| Name | Description | Type | Required |
| --- | --- | :---: | :---: |
| `visible` | Defines if the Tooltip is visible or not. <br> *Default: false.* | Boolean |  |
| `targetElm` | target element which you want tooltip to point to| element | ✅ |
| `position` | where to position your tooltip. | string, PropTypes.oneOf(['top', 'right', 'bottom', 'left']) |  |
| `fallbackPosition` | fallback position of your tooltip when it's offscreen. | string, PropTypes.oneOf(['top', 'right', 'bottom', 'left'])  |  |
| `arrow` |where to position the arrow of your tooltip. | PropTypes.oneOf([null, 'center', 'top', 'right', 'bottom', 'left']) | |
| `fallbackArrow` |fallback arrow position when tooltip is offscreen. | PropTypes.oneOf([null, 'center', 'top', 'right', 'bottom', 'left']) | |
| `style` |styles apply to your tooltip  | object, { style: {}, arrowStyle: {} }  | |
| `positionMargin` |positionMargin apply to your tooltip bewteen target element and tooltip  | number  | |
| `transition` |transition apply to your tooltip  | string, Default: 'all'.    | |
| `children` | child react element | element | ✅ |

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