# react-balloon.css

> A react styled-components implementation of kazzkiq's balloon.css

Latest version **2.0.0** (published 2017-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-balloon.css
pnpm add react-balloon.css
yarn add react-balloon.css
bun add react-balloon.css
```

## 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 | 2.0.0 |
| Published | 2017-11-29 |
| First published | 2017-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | 2017+ Reme Le Hane |
| Maintainers | remejuan |
| Keywords | react, reactjs, tooltip, styled component, styled tooltip |

## Links

- npm: https://www.npmjs.com/package/react-balloon.css
- Repository: https://github.com/RemeJuan/react-balloon.css
- Homepage: http://react-balloon.css-demo.surge.sh
- Issues: https://github.com/RemeJuan/react-balloon.css/issues
- npm.io page: https://npm.io/package/react-balloon.css

## 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

- 2.0.0 (latest) — 2017-11-29
- 1.0.2 — 2017-08-25
- 1.0.1 — 2017-08-25
- 1.0.0 — 2017-08-24

## README

<!-- TITLE/ -->

<h1>React Balloon.css</h1>

<!-- /TITLE -->


<!-- DESCRIPTION/ -->

A react styled-components implementation of kazzkiq's balloon.css

<!-- /DESCRIPTION -->


<!-- BADGES/ -->

<span class="badge-nodeico"><a href="https://www.npmjs.com/package/react-balloon.css" title="Nodei.co badge"><img src="https://nodei.co/npm/react-balloon.css.png" alt="Nodei.co badge" /></a></span>
<br class="badge-separator" />
<span class="badge-travisci"><a href="http://travis-ci.org/RemeJuan/react-balloon.css" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/RemeJuan/react-balloon.css/master.svg" alt="Travis CI Build Status" /></a></span>
<span class="badge-npmversion"><a href="https://npmjs.org/package/react-balloon.css" title="View this project on NPM"><img src="https://img.shields.io/npm/v/react-balloon.css.svg" alt="NPM version" /></a></span>
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/react-balloon.css" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/react-balloon.css.svg" alt="NPM downloads" /></a></span>
<span class="badge-daviddm"><a href="https://david-dm.org/RemeJuan/react-balloon.css" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/RemeJuan/react-balloon.css.svg" alt="Dependency Status" /></a></span>

<!-- /BADGES -->


[Demo](http://react-balloon.css-demo.surge.sh)

# Usage

Simply install using `npm install react-balloon.css` or `yarn add react-balloon.css`

You can then wrap it around any component passing at least the `message` prop through.

## Example

```javascript
import Tooltip from 'react-balloon.css';

...
<Tooltip message={'Tooltip message'}>
  <ButtonComponent />
<Tooltip>
...

```

## Available props

```javascript
message[undefined]: String;
length[fit]: String (small|medium|large|xlarge|fit)
blockChild[false]: Boolean (when wrapping around block element eg: h1)
always[false]: Boolean (Always display)
position[top]: String (top|bottom|left|right)
```

# Contributing
1. Clone repo: `https://github.com/RemeJuan/react-balloon.css`
2. Run `yarn install`
3. Make changes in `lib/index.js`
4. Run tests: `yarn test` / `yarn test:watch`
5. Create PR

# Credits
* Original Balloon.css: [kazzkiq](https://github.com/kazzkiq/balloon.css)
* [Styled Components](http://styled-components.com)
* [Styled-Tools](https://github.com/diegohaz/styled-tools)

<!-- HISTORY/ -->

<h2>History</h2>

<a href="https://github.com/RemeJuan/react-balloon.css/releases">Discover the release history by heading on over to the releases page.</a>

<!-- /HISTORY -->


<!-- LICENSE/ -->

<h2>License</h2>

Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2017+ <a href="http://www.remelehane.me">Reme Le Hane</a></li></ul>

and licensed under:

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>

<!-- /LICENSE -->

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