Code Monkey home page Code Monkey logo

react-tooltip's Introduction

react-tooltip build status Coverage Status

NPM

React Tooltip

Demo: https://trendmicro-frontend.github.io/react-tooltip

Installation

  1. Install the latest version of react and react-tooltip:
npm install --save react @trendmicro/react-tooltip
  1. At this point you can import @trendmicro/react-tooltip and its styles in your application as follows:
import { Tooltip, Infotip } from '@trendmicro/react-tooltip';

// Be sure to include styles at some point, probably during your bootstraping
import '@trendmicro/react-tooltip/dist/react-tooltip.css';

Usage

// Right tooltip
<Tooltip content="Config settings">
    <button>Settings</button>
</Tooltip>

// Right tooltip with a function content
<Tooltip
    content={() => {
        return (<span style={{ whiteSpace: 'nowrap' }}>{'Right tooltip'}</span>);
    }}
>
    <sapn>Hover on me</span>
</Tooltip>

// Top tooltip
<Tooltip placement="top" content="Top tooltip"><sapn>Hover on me</span></Tooltip>
// Infotip
<Infotip content="This is a simple example for infotip.">
    <span className="icon icon-info-sign" />
</Infotip >

<Infotip placement="rightTop" content="This is a simple example for infotip.">
    <span className="icon icon-info-sign" />
</Infotip >

<Infotip
    tooltipStyle={{ wordWrap: 'break-word' }}
    content="Pneumonoultramicroscopicsilicovolcanoconiosis is the longest word. Start01234567890123456789012345678901234567890123456789012345678901234567890123456789End Start0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789End"
>
    <span>Hover on me (infotip with long article)</span>
</Infotip>

API

Properties for Tooltip

Name Type Default Description
placement string 'right' One of: 'top', 'right', 'bottom' and 'left'.
Tooltip will display at placement if possible, otherwise tooltip adjust it's location automatically.
enterDelay number 0 The delay length (in ms) before the tooltip appears.
leaveDelay number 0 The delay length (in ms) before the tooltip disappears.
hideOnClick boolean false Hide tooltip when target been clicked.
disabled boolean false Disable tooltip.
tooltipClassName string The className apply to tooltip itself. You can use it to override style if need.
tooltipStyle object The style apply to tooltip itself. You can use it to override style if need.
content node or function The tooltip content. Required.

Properties for Infotip

Name Type Default Description
placement string 'rightBottom' One of: 'rightTop', 'rightBottom', 'leftTop', and 'leftBottom'.
Tooltip will display at placement if possible, otherwise tooltip adjust it's location automatically.
enterDelay number 0 The delay length (in ms) before the infotip appears.
leaveDelay number 0 The delay length (in ms) before the infotip disappears.
hideOnClick boolean false Hide infotip when target been clicked.
disabled boolean false Disable infotip.
tooltipClassName string The className apply to infotip itself. You can use it to override style if need.
tooltipStyle object The style apply to infotip itself. You can use it to override style if need.
content node or function The infotip content. Required.

License

MIT

react-tooltip's People

Contributors

cheton avatar seawind543 avatar xjkit avatar

Watchers

 avatar  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.