React tooltip and sticky-note library

• easy-to-use, one-line basic usage
• stylable and configurable tip-wrapper components
• overridable tip-wrapper components
• precise tip placement and position adjustment
• pinnable, draggable sticky-notes

Check our storybook for lots of interactive examples and documentation !

Table of Contents

• Demo and samples
• Contributing

Installing

npm install @ulgaal/react-infotip

# or if you use yarn

yarn add @ulgaal/react-infotip

Usage

// ES6
import { Source } from "@ulgaal/react-infotip";

const MyComponent = () => (
  <div>
    Hover over <Source tip="Here is the tip">these words</Source> to get a tip
  </div>
);

Documentation

• Reference documentation provides a component-level autogenerated doc
• Overview provides a conceptual overview of what the library can do and how to do it.
• Annotated source provides a groc-generated annotated view of the source code.

Demo and samples

Be sure to check the storybook as it contains many samples, complete with source-code, documentation and interactive panels to tweak all possible aspects of tooltips and sticky-notes.

Contributing

This guide provides info on various ways you can contribute to this project.