# vdux-tooltip

> Simple tooltip component

Latest version **1.2.4** (published 2016-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install vdux-tooltip
pnpm add vdux-tooltip
yarn add vdux-tooltip
bun add vdux-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.2.4 |
| Published | 2016-05-10 |
| First published | 2016-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | ashaffer88 |

## Links

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

## Dependencies (4)

- [vdux-ui](https://npm.io/package/vdux-ui.md) ^1.2.0
- [vdux-containers](https://npm.io/package/vdux-containers.md) ^1.1.0
- [@f/create-action](https://npm.io/package/@f/create-action.md) ^1.1.1
- [@f/handle-actions](https://npm.io/package/@f/handle-actions.md) ^1.1.1

## Recent versions

- 1.2.4 (latest) — 2016-05-10
- 1.2.3 — 2016-05-06
- 1.2.2 — 2016-05-06
- 1.2.1 — 2016-04-12
- 1.2.0 — 2016-04-12
- 1.1.0 — 2016-04-01
- 1.0.4 — 2016-03-11
- 1.0.3 — 2016-03-04
- 1.0.1 — 2016-02-26
- 1.0.0 — 2016-02-26

## README

# tooltip

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

Simple tooltip component

## Installation

    $ npm install vdux-tooltip

## Usage

Renders your `message` as a tooltip over `children` when the user [lingers](https://github.com/vdux-components/css-emulator#linger-state) over `children`.

```javascript
import Tooltip from 'vdux-tooltip'

function render () {
  return (
    <Tooltip message='Signup today!' delay={400}>
      <button>Register</button>
    </Tooltip>
  )
}
```

## API - props

  * `ui` - Optional, defaults to vdux-ui's Tooltip component. This is the UI element used to render your tooltip component
  * `message` - The content of the tooltip. This may be just a string or it may be JSX elements.
  * `placement` - Defaults to `left`. One of `top/right/bottom/left`. Specifies where the tooltip should appear relative to the container.
  * `space` - Optional. Defaults to 0. Add extra padding away from the element when the tooltip is positioned.
  * `...rest` - Any other props will be forwarded to the tooltip UI component.

## API - children

The children of the tooltip are what the tooltip is for. They are rendered normally as if the tooltip wasn't there.

## License

MIT

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