Giter VIP home page Giter VIP logo

tooltip's Introduction

rc-tooltip


React Tooltip

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

Screenshot

Browser Support

IE Chrome Firefox Opera Safari
IE 8 + ✔ Chrome 31.0+ ✔ Firefox 31.0+ ✔ Opera 30.0+ ✔ Safari 7.0+ ✔

Install

rc-tooltip

Usage

var Tooltip = require('rc-tooltip');
var React = require('react');
var ReactDOM = require('react-dom');

// By default, the tooltip has no style.
// Consider importing the stylesheet it comes with:
// 'rc-tooltip/assets/bootstrap_white.css'

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

Examples

npm start and then go to http://localhost:8007/examples

Online examples: 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|Object same as https://github.com/react-component/animate
onVisibleChange Function call when visible is changed
afterVisibleChange Function call after 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 container. By default the tooltip attaches to the body. If you want to change the container, simply return a new element.
destroyTooltipOnHide boolean false whether destroy tooltip when tooltip is hidden
id String Id which gets attached to the tooltip content. Can be used with aria-describedby to achieve Screenreader-Support.

Note

Tooltip requires child node accepts onMouseEnter, onMouseLeave, onFocus, onClick event.

Accessibility

For accessibility purpose you can use the id prop to link your tooltip with another element. For example attaching it to an input element:

<Tooltip
    ...
    id={this.props.name}>
    <input type="text"
           ...
           aria-describedby={this.props.name}/>
</Tooltip>

If you do it like this, a screenreader would read the content of your tooltip if you focus the input element.

Development

npm install
npm start

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

License

rc-tooltip is released under the MIT license.

tooltip's People

Contributors

yiminghe avatar afc163 avatar paranoidjk avatar yesmeck avatar benjycui avatar simeg avatar romainneutron avatar adaptunit avatar sehuo avatar nickhsine avatar andriijas avatar gregthebusker avatar gregory90 avatar jasonblanchard avatar ldabiralai avatar mikemunsie avatar stevenmusumeche avatar warent avatar warmhug avatar ddcat1115 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.