Awesome Open Source
Awesome Open Source

Tooltip Sequence

A minimalistic set of tooltips on your app.

GitHub stars GitHub forks GitHub issues size
cover cover

What it does

So suppose you create a Web Application and you want to take your users or anyone on a walkthrough on one, two or maybe all the features in your app, you can install this simple Javascript package to create a sequence of small tooltips that will guide the user to each feature( in our case a web element ) and show a small description of what you want them to know about that feature.This package would save you the time to manually create tooltip descriptions on each page and link them together in action.

Installation

Quick Usage ⚡️

Add the following tags to your HTML document
<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/index.css">
<script src="https://unpkg.com/[email protected]/dist/index.min.js"></script>

Or

Use npm

npm install tooltip-sequence --save
Add the following statements to the file that uses the sequence
import createSequence from "tooltip-sequence";
import "tooltip-sequence/dist/index.css";

Example

const options = {
  backdropColor:"transparent || color-code",
  sequence:[{
    element:"#element",
    description:"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
    placement:"top || right || bottom || left"
  }],
  onComplete:function() {
    // your code
  }
};
createSequence(options);
Infinite Customizations available. You can customize any element that is created by overriding the classes. Customizations are only limited by the creativity of the designer

Checkout the features and a live demo here

Development

You need Hugo to run the dev server. If you have Homebrew you can do the following:

brew install hugo

Check this Hugo installation page for installing on other systems.

Then clone the repo, install dependencies, and start the server locally.

git clone https://github.com/SoorajSNBlaze333/tooltip-sequence.git
cd tooltip-sequence
npm i
npm start

Open http://localhost:1313 in your browser.

Scripts Description
npm start Starts a local dev server
npm run production For generating production docs files

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,555,105
Html (433,283
Npm (5,757
Ui (5,291
Utility (4,629
Npm Package (2,726
Guide (1,302
Helper (1,205
Ux (805
Webdev (339
Tooltip (335
Popover (165
Info (159
Focus (151
Related Projects