react-toolbox/components/tooltip
Keren Chandran 86e1dcada4 Updated Progress, Radio and Tooltip Readme. Aligned properties for ripple. 2016-03-25 13:06:09 -04:00
..
Tooltip.jsx propagate events in Tooltip 2016-01-22 14:20:22 +01:00
_config.scss New approach for Tooltips 2015-11-29 12:39:55 +01:00
index.js Remove jsx extension from imports in components 2015-11-28 20:24:46 +01:00
readme.md Updated Progress, Radio and Tooltip Readme. Aligned properties for ripple. 2016-03-25 13:06:09 -04:00
style.scss Fixes #214 2015-12-19 21:06:18 +01:00

readme.md

Tooltip

A Tooltip is useful to show information on hover in any kind of component. We have a component that can be used as a decorator for any kind of component. You just have to take into account that the overflow in the component should be visible.

import Button from 'react-toolbox/lib/button';
import Tooltip from 'react-toolbox/lib/tooltip';
import Link from 'react-toolbox/lib/link';

const TooltipButton = Tooltip(Button);
const TooltipInput = Tooltip(Input);
const TooltipLink = Tooltip(Link);

const TooltipTest = () => (
  <div>
    <TooltipButton label='Bookmark' icon='bookmark' raised primary tooltip='Bookmark Tooltip' tooltipDelay={1000} />
    <TooltipButton icon='add' floating accent tooltip='Floating Tooltip' />
    <TooltipLink count={42} href="#" label="The answer is" icon='speaker_notes' tooltip='Question - universe?'/>
    <TooltipInput tooltip='lorem ipsum...' />
  </div>
);

Properties

In any component you decorate with the Tooltip you'd get some additional props:

Name Type Default Description
className String '' Sets a class to give customized styles to the tooltip.
onClick Function Callback to be invoked when Component is clicked.
onMouseEnter Function Callback called when the mouse enters the Component.
onMouseLeave Function Callback called when the mouse leaves the Component.
tooltip String The text string to use for the tooltip.
tooltipDelay Number Amount of time in miliseconds spent before the tooltip is visible.
tooltipHideOnClick Boolean true If true, the Tooltip hides after a click in the host component.