https://github.com/SoorajSNBlaze333/tooltip-sequence

A simple step by step tooltip helper for any site
https://github.com/SoorajSNBlaze333/tooltip-sequence

description focus guide helper hint hover info intro javascript popover tooltip tooltip-sequence tour utility webdev

Last synced: 7 days ago
JSON representation

A simple step by step tooltip helper for any site

• Host: GitHub
• URL: https://github.com/SoorajSNBlaze333/tooltip-sequence
• Owner: SoorajSNBlaze333
• License: mit
• Created: 2020-08-05T17:10:47.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T15:19:25.000Z (over 1 year ago)
• Last Synced: 2024-04-14T11:57:53.623Z (3 months ago)
• Topics: description, focus, guide, helper, hint, hover, info, intro, javascript, popover, tooltip, tooltip-sequence, tour, utility, webdev
• Language: JavaScript
• Homepage: https://tooltip-sequence.netlify.app/
• Size: 2.49 MB
• Stars: 306
• Watchers: 5
• Forks: 19
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - SoorajSNBlaze333/tooltip-sequence - A simple step by step tooltip helper for any site (JavaScript)

README

        
# Tooltip Sequence

A minimalistic set of tooltips on your app.



  

  

  

  







## 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


```html

```

Or


Use npm


```sh

npm install tooltip-sequence --save

```

Add the following statements to the file that uses the sequence


```js

import createSequence from "tooltip-sequence";

import "tooltip-sequence/dist/index.css";

```

## Example

```js

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](https://gohugo.io/) to run the dev server. If you have [Homebrew](https://brew.sh/) you can do the following:

```sh

brew install hugo

```

Check this [Hugo installation page](https://gohugo.io/getting-started/installing/) for installing on other systems.

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

```sh

git clone https://github.com/SoorajSNBlaze333/tooltip-sequence.git

cd tooltip-sequence

npm i

npm start

```

Open [`http://localhost:1313`](http://localhost:1313) in your browser.

| Scripts              | Description                          |

| -------------------- | ------------------------------------ |

| `npm start`          | Starts a local dev server            |

| `npm run production` | For generating production docs files |