0.0.1 • Published 5 years ago

react-sticky-mouse-tooltip v0.0.1

Weekly downloads
1,620
License
MIT
Repository
github
Last release
5 years ago

react-sticky-mouse-tooltip

React tooltip component that follow mouse cursor. You can pass as this tooltip children any HTML element or other React component.

Installation

npm install react-sticky-mouse-tooltip --save

or

yarn add react-sticky-mouse-tooltip

Example

import React from 'react';
import MouseTooltip from 'react-sticky-mouse-tooltip';

class Preview extends React.Component {
  state = {
    isMouseTooltipVisible: false,
  };

  toggleMouseTooltip = () => {
    this.setState(prevState => ({ isMouseTooltipVisible: !prevState.isMouseTooltipVisible }));
  };

  render() {
    return (
      <div>
        <button onClick={this.toggleMouseTooltip} style={buttonStyle}>
          Toggle mouse tooltip
        </button>
        <MouseTooltip
          visible={this.state.isMouseTooltipVisible}
          offsetX={15}
          offsetY={10}
        >
          <span>Follow the cursor!</span>
        </MouseTooltip>
      </div>
    );
  }
}

Attributes

AttributeDescriptionTypeRequiredDefault value
visibleVisibility of component.booleanNotrue
offsetXOffset along X axis.numberNo0
offsetYOffset along Y axis.numberNo0
classNameTooltip div class name.stringNo-
styleStyles properties of tooltip div.objectNo-

License

MIT