0.3.5 • Published 6 years ago
jsweetman-react-tooltip v0.3.5
React Tooltip
A tooltip component for React apps utilizing the excellent popper.js library.
Installation
npm install --save @cypress/react-tooltipUsage
import Tooltip from '@cypress/react-tooltip'
<Tooltip title="Hello World">
<button>Click me</button>
</Tooltip>The tooltip will automatically appear when mousing over the button and disappear when mousing out from the button.
Options
| option | default | description | supported values |
|---|---|---|---|
| title | null | Required. The tooltip text | Any non-empty string |
| placement | 'top' | The placement of the tooltip | Placements supported by popper.js |
| visible | null | Whether to show the tooltip when rendered. This overrides the default showing/hiding on mouse-over/mouse-out | true or false |
| className | 'tooltip' | Class applied to the tooltip | |
| wrapperClassName | '' | Class applied to the <span> that wraps the children of <Tooltip> |
Development
# watches JS and SCSS for changes and compiles
# runs tests for associated
npm start
# run all tests
npm testChangelog
0.2.2 - (03/10/17)
- Add customizable tooltip border
0.2.1 - (03/10/17)
- Fix issues with class names
0.2.0 - (03/10/17)
- Allow specifying tooltip class name and wrapper class name
0.1.4 - (03/10/17)
- Upgrade popper.js to 1.x.x
0.1.1 - (09/29/16)
- Guard against updating popper state when unmounted
0.1.0 - (09/28/16)
- Initial release