https://github.com/hunghg255/intro-js

https://github.com/hunghg255/intro-js

npm

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hunghg255/intro-js
• Owner: hunghg255
• Created: 2022-11-21T17:09:20.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-02T20:55:27.000Z (9 months ago)
• Last Synced: 2024-10-28T23:25:47.332Z (2 months ago)
• Topics: npm
• Language: JavaScript
• Homepage: https://hunghg255.github.io/intro-js/demo/index.html
• Size: 176 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        










  A library intro for your website





  

  

  

  

  



[Live Demo](https://hunghg255.github.io/intro-js/demo/index.html)

## Installation

[![NPM](https://nodei.co/npm/introh-js.png?compact=true)](https://nodei.co/npm/introh-js/)

#### To install the latest stable version:

```

npm install --save introh-js

or

yarn add introh-js

```

#### Basic usage:

```css

@import 'introh-js/dist/styles.css';

```

```ts

interface IIntroJs {

   steps: { element: string; children: string }[];

   isStart?: boolean;

}

new IntroJs(options: IIntroJs);

const steps = [

  {

    element: '.title',

    children: 'Title One',

  },

  {

    element: '.second',

    children: 'Title Two',

  },

  {

    element: '.three',

    children: 'Title Three',

  },

  {

    element: '.cat',

    children: 'Cat',

  },

];

const instante = new IntroJs({

  steps,

});

```