247 lines
8.5 KiB
Markdown
247 lines
8.5 KiB
Markdown
# rc-tooltip
|
|
|
|
React Tooltip
|
|
|
|
[![NPM version][npm-image]][npm-url] [](https://github.com/umijs/dumi) [![build status][github-actions-image]][github-actions-url] [![Test coverage][coveralls-image]][coveralls-url] [![gemnasium deps][gemnasium-image]][gemnasium-url] [![node version][node-image]][node-url] [![npm download][download-image]][download-url]
|
|
|
|
[npm-image]: https://img.shields.io/npm/v/rc-tooltip.svg?style=flat-square
|
|
[npm-url]: https://npmjs.org/package/rc-tooltip
|
|
[github-actions-image]: https://github.com/react-component/tooltip/workflows/CI/badge.svg
|
|
[github-actions-url]: https://github.com/react-component/tooltip/actions
|
|
[coveralls-image]: https://img.shields.io/coveralls/react-component/tooltip.svg?style=flat-square
|
|
[coveralls-url]: https://coveralls.io/r/react-component/tooltip?branch=master
|
|
[gemnasium-image]: https://img.shields.io/gemnasium/react-component/tooltip.svg?style=flat-square
|
|
[gemnasium-url]: https://gemnasium.com/react-component/tooltip
|
|
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
|
|
[node-url]: https://nodejs.org/download/
|
|
[download-image]: https://img.shields.io/npm/dm/rc-tooltip.svg?style=flat-square
|
|
[download-url]: https://npmjs.org/package/rc-tooltip
|
|
|
|
## Screenshot
|
|
|
|
<img src="https://gtms03.alicdn.com/tps/i3/TB1NQUSHpXXXXaUXFXXlQqyZXXX-1312-572.png" width="600"/>
|
|
|
|
## Browsers support
|
|
|
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
|
|
| --------- | --------- | --------- | --------- | --------- |
|
|
| IE 8 + ✔ | Firefox 31.0+ ✔ | Chrome 31.0+ ✔ | Safari 7.0+ ✔ | Opera 30.0+ ✔ |
|
|
|
|
|
|
## Install
|
|
|
|
[](https://npmjs.org/package/rc-tooltip)
|
|
|
|
## Usage
|
|
|
|
```js
|
|
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: <https://react-component.github.io/tooltip/examples/>
|
|
|
|
## API
|
|
|
|
### Props
|
|
|
|
<table class="table table-bordered table-striped">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 100px;">name</th>
|
|
<th style="width: 50px;">type</th>
|
|
<th style="width: 50px;">default</th>
|
|
<th>description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>overlayClassName</td>
|
|
<td>string</td>
|
|
<td></td>
|
|
<td>additional className added to popup overlay</td>
|
|
</tr>
|
|
<tr>
|
|
<td>trigger</td>
|
|
<td>string | string[]</td>
|
|
<td>['hover']</td>
|
|
<td>which actions cause tooltip shown. enum of 'hover','click','focus'</td>
|
|
</tr>
|
|
<tr>
|
|
<td>mouseEnterDelay</td>
|
|
<td>number</td>
|
|
<td>0</td>
|
|
<td>delay time to show when mouse enter.unit: s.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>mouseLeaveDelay</td>
|
|
<td>number</td>
|
|
<td>0.1</td>
|
|
<td>delay time to hide when mouse leave.unit: s.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>overlayStyle</td>
|
|
<td>Object</td>
|
|
<td></td>
|
|
<td>additional style of overlay node</td>
|
|
</tr>
|
|
<tr>
|
|
<td>prefixCls</td>
|
|
<td>String</td>
|
|
<td>rc-tooltip</td>
|
|
<td>prefix class name</td>
|
|
</tr>
|
|
<tr>
|
|
<td>transitionName</td>
|
|
<td>String|Object</td>
|
|
<td></td>
|
|
<td>same as https://github.com/react-component/animate</td>
|
|
</tr>
|
|
<tr>
|
|
<td>onVisibleChange</td>
|
|
<td>Function</td>
|
|
<td></td>
|
|
<td>call when visible is changed</td>
|
|
</tr>
|
|
<tr>
|
|
<td>afterVisibleChange</td>
|
|
<td>Function</td>
|
|
<td></td>
|
|
<td>call after visible is changed</td>
|
|
</tr>
|
|
<tr>
|
|
<td>visible</td>
|
|
<td>boolean</td>
|
|
<td></td>
|
|
<td>whether tooltip is visible</td>
|
|
</tr>
|
|
<tr>
|
|
<td>defaultVisible</td>
|
|
<td>boolean</td>
|
|
<td></td>
|
|
<td>whether tooltip is visible initially</td>
|
|
</tr>
|
|
<tr>
|
|
<td>placement</td>
|
|
<td>String</td>
|
|
<td></td>
|
|
<td>one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight', 'rightTop', 'rightBottom', 'leftTop', 'leftBottom']</td>
|
|
</tr>
|
|
<tr>
|
|
<td>align</td>
|
|
<td>Object: alignConfig of [dom-align](https://github.com/yiminghe/dom-align)</td>
|
|
<td></td>
|
|
<td>value will be merged into placement's config</td>
|
|
</tr>
|
|
<tr>
|
|
<td>onPopupAlign</td>
|
|
<td>function(popupDomNode, align)</td>
|
|
<td></td>
|
|
<td>callback when popup node is aligned</td>
|
|
</tr>
|
|
<tr>
|
|
<td>overlay</td>
|
|
<td>React.Element | () => React.Element</td>
|
|
<td></td>
|
|
<td>popup content</td>
|
|
</tr>
|
|
<tr>
|
|
<td>overlayInnerStyle</td>
|
|
<td>Object</td>
|
|
<td></td>
|
|
<td>set overlay inner style</td>
|
|
</tr>
|
|
<tr>
|
|
<td>showArrow</td>
|
|
<td>boolean</td>
|
|
<td>true</td>
|
|
<td>arrow visible</td>
|
|
</tr>
|
|
<tr>
|
|
<td>arrowContent</td>
|
|
<td>React.Node</td>
|
|
<td>null</td>
|
|
<td>arrow content</td>
|
|
</tr>
|
|
<tr>
|
|
<td>getTooltipContainer</td>
|
|
<td>function</td>
|
|
<td></td>
|
|
<td>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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>destroyTooltipOnHide</td>
|
|
<td>boolean | { keepParent: boolean }</td>
|
|
<td>false</td>
|
|
<td>whether destroy tooltip when tooltip is hidden.In general, destroyTooltipOnHide will only remove itself instead of parent container of it. Parent container will be removed include tooltip when keepParent is true</td>
|
|
</tr>
|
|
<tr>
|
|
<td>id</td>
|
|
<td>String</td>
|
|
<td></td>
|
|
<td>Id which gets attached to the tooltip content. Can be used with aria-describedby to achieve Screenreader-Support.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## Important Note
|
|
|
|
`Tooltip` requires a child node that accepts an `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` event. This means the child node must be a built-in component like `div` or `span`, or a custom component that passes its props to its built-in component child.
|
|
|
|
## 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:
|
|
```js
|
|
<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
|
|
|
|
```bash
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
## Test Case
|
|
|
|
```bash
|
|
npm test
|
|
npm run chrome-test
|
|
```
|
|
|
|
## Coverage
|
|
|
|
```bash
|
|
npm run coverage
|
|
```
|
|
|
|
## License
|
|
|
|
`rc-tooltip` is released under the MIT license.
|