react-balloon.css
v2.0.0
Published
A react styled-components implementation of kazzkiq's balloon.css
Downloads
10
Maintainers
Readme
A react styled-components implementation of kazzkiq's balloon.css
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
import Tooltip from 'react-balloon.css';
...
<Tooltip message={'Tooltip message'}>
<ButtonComponent />
<Tooltip>
...
Available props
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
- Clone repo:
https://github.com/RemeJuan/react-balloon.css
- Run
yarn install
- Make changes in
lib/index.js
- Run tests:
yarn test
/yarn test:watch
- Create PR
Credits
- Original Balloon.css: kazzkiq
- Styled Components
- Styled-Tools
Discover the release history by heading on over to the releases page.
Unless stated otherwise all works are:
and licensed under: