Skip to content

user guide is a lightweight library for creating introduction step-by-step.

License

Notifications You must be signed in to change notification settings

fridaymeng/user-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

For New User Guide

You can install User-guide in a few simple steps.

How To Use?

import userGuide from './src/index.js'
userGuide([
  {
    element: '#user-guide-id1',
    position: 'left',
    content: `This is a introduction.`
  },
  {
    element: '#user-guide-id2',
    position: 'right',
    content: `This is a introduction.`
  },
  {
    element: '#user-guide-id3',
    position: 'top',
    content: `This is a introduction.`
  },
  {
    element: '#user-guide-id4',
    position: 'bottom',
    contextHeight: 120, // you can set the context area height.
    content: `This is a introduction.`
  }
])

OR

userGuide({
    element: '#user-guide-id1',
    position: 'left',
    content: `This is a introduction.`
})

About

user guide is a lightweight library for creating introduction step-by-step.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published