Skip to content

Latest commit

 

History

History
191 lines (164 loc) · 5.34 KB

README.md

File metadata and controls

191 lines (164 loc) · 5.34 KB

rc-tooltip


React Tooltip

NPM version build status Test coverage gemnasium deps node version npm download

Screenshots

Feature

  • support ie8,ie8+,chrome,firefox,safari

install

rc-tooltip

Usage

var Tooltip = require('rc-tooltip');
var React = require('react');
var ReactDOM = require('react-dom')
ReactDOM.render(<Tooltip placement="left" trigger={['click']} overlay={<span>tooltip</span>}><a href='#'>hover</a></Tooltip>, container);

Example

http://localhost:8007/examples

online example: http://react-component.github.io/tooltip/examples/

API

props

name type default description
overlayClassName string additional className added to popup overlay
trigger string[] ['hover'] which actions cause tooltip shown. enum of 'hover','click','focus'
mouseEnterDelay number 0 delay time to show when mouse enter.unit: s.
mouseLeaveDelay number 0.1 delay time to hide when mouse leave.unit: s.
overlayStyle Object additional style of overlay node
prefixCls String rc-tooltip prefix class name
transitionName String same as https://github.com/react-component/css-transition-group
onVisibleChange Function call when visible is changed
visible boolean whether tooltip is visible
defaultVisible boolean whether tooltip is visible initially
placement String one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight']
align Object: alignConfig of [dom-align](https://github.com/yiminghe/dom-align) value will be merged into placement's config
onPopupAlign function(popupDomNode, align) callback when popup node is aligned
overlay React.Element | () => React.Element popup content
arrowContent React.Node null arrow content
getTooltipContainer function function returning html node which will act as tooltip contaier
destroyTooltipOnHide boolean false whether destroy tooltip when tooltip is hidden

Development

npm install
npm start

Test Case

http://localhost:8007/tests/runner.html?coverage

Coverage

http://localhost:8007/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8007/tests/runner.html?coverage

License

rc-tooltip is released under the MIT license.