Package Exports
- react-tooltip
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-tooltip) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-tooltip
Installation
npm install react-tooltip
Usage
1 . Require react-tooltip after installation
var ReactTooltip = require("react-tooltip")
2 . Add data-tip = "your placeholder" to your element
<p data-tip="hello world">Tooltip</p>
3 . Including react-tooltip component
<ReactTooltip />
Options
Every option has default value, You don't need to add option if default options are enough.
The options set to <ReactTooltip />
will affect all tootips in a same page and options set to specific element only affect the specific tooltip's behaviour.
Check example: React-tooltip Test
Place: String [ top, right, bottom, left ]
Specific element:
<p data-tip="tooltip" data-place="top"></p>
global:
<ReactTooltip place="top"/>
Type: String [ dark, success, warning, error, info, light ]
Specific element:
<p data-tip="tooltip" data-type="dark"></p>
global:
<ReactTooltip type="dark"/>
Effect: String [ float, solid ]
Specific element:
<p data-tip="tooltip" data-effect="float"></p>
global:
<ReactTooltip effect="float"/>
Position: Object [ top, right, bottom, left ]
Specific element:
<p data-tip="tooltip" data-position="{'top': 10, 'left': 10}"></p>
global:
<ReactTooltip type="float" position={{top: 10, left: 10}}/>
Multiline: Bool [ true, false ]
Specific element:
<p data-tip="tooltip<br>a<br />b" data-multiline={true}></p>
global:
<ReactTooltip multiline={true}/>
Extra Class: String
Specific element:
<p data-tip="tooltip" data-class="extra-class"></p>
global:
<ReactTooltip class="extra-class"/>
Insert HTML
Specific element:
<p data-tip="<p>HTML tooltip</p>" data-html={true}></p>
global:
<ReactTooltip html={true}/>
Using react component as tooltip
Check the example React-tooltip Test
Note:
- data-tip is necessary, because
<ReactTooltip />
find tooltip via this attribute - data-for correspond to the id of
<ReactTooltip />
- When using react component as tooltip, you can have many
<ReactTooltip />
in a page but they should have different id
Static method
ReactTooltip.hide()
for hide the tooltip manually
ReactTooltup.rebuild()
for re-bind tooltip to the corresponding element
I suggest always put <ReactTooltip />
in the Highest level or smart component of Redux, so you might need these static
method to control tooltip's behaviour in some situations
License
MIT