react-hints

This is a simple component to show floating hints highlighting product features.

Usage no npm install needed!

<script type="module">
  import reactHints from 'https://cdn.skypack.dev/react-hints';
</script>

README

React Hints

This is a simple component to show floating hints highlighting product features.

Online Demo

Installation

In your React project folder run:

npm install react-hints --save

Usage

  1. ImportĀ react-hints into your component.

    import Hint from 'react-hints';
    
  2. In your render, wrap some element with the <Hint /> component. Here is a <button /> wrapped:

    <Hint
      id="hint-1"
      message="You can put the hint at any side of the element."
      position="top">
        <button className="btn btn-lg btn-default">
          Action!
        </button>
    </Hint>
    
  3. Read more about what each prop means here.

License

react-hints is available under MIT. See LICENSE for more details.