🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

github.com/trendmicro-frontend/react-tooltip

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/trendmicro-frontend/react-tooltip

v0.6.0
Source
Go
Version published
Created
Source

react-tooltip build status Coverage Status

NPM

React Tooltip

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

Installation

  • Install the latest version of react and react-tooltip:
npm install --save react @trendmicro/react-tooltip
  • 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

NameTypeDefaultDescription
placementstring'right'One of: 'top', 'right', 'bottom' and 'left'.
Tooltip will display at placement if possible, otherwise tooltip adjust it's location automatically.
enterDelaynumber0The delay length (in ms) before the tooltip appears.
leaveDelaynumber0The delay length (in ms) before the tooltip disappears.
hideOnClickbooleanfalseHide tooltip when target been clicked.
disabledbooleanfalseDisable tooltip.
tooltipClassNamestringThe className apply to tooltip itself. You can use it to override style if need.
tooltipStyleobjectThe style apply to tooltip itself. You can use it to override style if need.
contentnode or functionThe tooltip content. Required.

Properties for Infotip

NameTypeDefaultDescription
placementstring'rightBottom'One of: 'rightTop', 'rightBottom', 'leftTop', and 'leftBottom'.
Tooltip will display at placement if possible, otherwise tooltip adjust it's location automatically.
enterDelaynumber0The delay length (in ms) before the infotip appears.
leaveDelaynumber0The delay length (in ms) before the infotip disappears.
hideOnClickbooleanfalseHide infotip when target been clicked.
disabledbooleanfalseDisable infotip.
tooltipClassNamestringThe className apply to infotip itself. You can use it to override style if need.
tooltipStyleobjectThe style apply to infotip itself. You can use it to override style if need.
contentnode or functionThe infotip content. Required.

License

MIT

FAQs

Package last updated on 16 May 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts