Skip to content

kostasmanionis/dibs-react-tooltip

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Usage:

const Tooltip = require('dibs-react-tooltip');


render() {
	return (
		<Tooltip isVisible={true} rootPosition={{x: 50, y: 50}}>
			I'm a tooltip!
		</Tooltip>
	)
}

Props:

// Determines the initial position of the tooltip relative to rootPosition
tooltipDirection: 		React.PropTypes.oneOf(['top', 'bottom']),	// TODO: left and right

// Whether to render the tooltip
isVisible: 				React.PropTypes.bool,

// These can be used to override the default local styles
containerClass: 		React.PropTypes.string,
triangleClass: 			React.PropTypes.string,

// The height of the triangle arrow of the tooltip
triangleSize: 			React.PropTypes.number,

// Determines at what point the tooltip will flip to the opposite direction
// 		For example, if tooltipDirection=top and positionThresholds.top=60, the direction
//		will become bottom once the top of the tooltip is less than 60px from the top of 
//		the window
positionThresholds: 	React.PropTypes.shape({
    top: React.PropTypes.number,
    bottom: React.PropTypes.number,
    left: React.PropTypes.number,
    right: React.PropTypes.number
}),

// The position of the tooltip. Typically this is defined relative to whatever its parent is.
rootPosition: 			React.PropTypes.shape({
    x: React.PropTypes.number,
    y: React.PropTypes.number
}).isRequired,

// Handler for when the tooltip is clicked
onClick: 				React.PropTypes.func,

// Handler for when a position threshold is crossed and the direction changes
onThresholdPassed: 		React.PropTypes.func

Building:

npm install
npm run build

This will transpile all the ES6, JSX, and local styles to dist/Tooltip.js.

Tests:

npm run test

About

A tooltip in React from 1stdibs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.5%
  • CSS 2.5%