3.7.3 • Published 6 years ago

rc-tooltip-arkade v3.7.3

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

rc-tooltip-arkade


React Tooltip

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

Screenshot

Browsers support

IE / EdgeFirefoxChromeSafariOpera
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

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.

NOTE: role="tooltip" is also added to expose the purpose of the tooltip element to a screenreader.

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.