# @huise513/guide

> user guide

Latest version **0.1.17** (published 2022-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @huise513/guide
pnpm add @huise513/guide
yarn add @huise513/guide
bun add @huise513/guide
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.17 |
| Published | 2022-10-27 |
| First published | 2022-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 67.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | huise513 |
| Maintainers | huise513 |
| Keywords | guide, guider, user guide, intro |

## Links

- npm: https://www.npmjs.com/package/@huise513/guide
- Repository: https://gitee.com/huise513/guide
- npm.io page: https://npm.io/package/@huise513/guide

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.17 (latest) — 2022-10-27
- 0.1.16 — 2022-10-26
- 0.1.15 — 2022-08-23
- 0.1.14 — 2022-06-16
- 0.1.13 — 2022-06-16
- 0.1.12 — 2022-06-16
- 0.1.11 — 2022-06-15
- 0.1.10 — 2022-06-15
- 0.1.9 — 2022-06-15
- 0.1.8 — 2022-06-15
- 0.1.7 — 2022-06-15
- 0.1.6 — 2022-06-15
- 0.1.5 — 2022-06-15
- 0.1.4 — 2022-06-15
- 0.1.3 — 2022-06-15
- … 3 more at https://npm.io/package/@huise513/guide/versions

## README

# @huise513/guide
### a user guide lib
## Usage

```sh
npm install @huise513/guide
```

```html
<div data-guide="step1"></div>
<div data-guide="step60"></div>
<div data-guide="step90"></div>
```

```js
import  { createGuide } from  '@huise513/guide';
import '@huise513/guide/dist/style.css'
const guide = createGuide({
  theme: 'default', //主题 default | dark
  flag: 'data-guide',
  props: { // 所有属性支持在step中配置
    targetClickEnable: false, //目标区域是否可以点击 
    clickTargetNext: false, //点击目标区域自动执行下一步, targetClickEnable需为true
    scrollToTarget: true, //滚动到目标区域
    showTooltip: true, //是否显示提示框
    showOperation: true, //是否显示操作按钮
    showSkip: true, //是否显示跳过
    showNextBtn: true, //是否显示下一步
    showPrevBtn: true, //是否显示上一步
    showCompleteBtn: true, //是否完成
    nextText: '下一步', //下一步按钮文案
    prevText: '上一步', //上一步按钮文案
    skipText: '跳过', //跳过按钮文案 最后一步之前都展示
    completeText: '完成', //完成按钮文案 只会在最后一步展示
    autoNext: false, //是否自动下一步
    autoNextTime: 5, //自动下一步等待时间(秒)
    position: 'top', //引导展示位置top/bottom/left/right 默认根据位置自动选择 
  },
  events: {
    onInit() {
      console.log('global onInit');
    },
    onStart() {
      console.log('global onStart');
    },
    beforeStart(next) {
      console.log('global beforeStart');
      next();
    },
    beforeSkip(next) {
      console.log('global beforeSkip');
      next();
    },
    beforeComplete(next) {
      console.log('global beforeComplete');
      next();
    },
    beforeEnter(next) {
      console.log('global beforeEnter');
      next();
    },
    beforeNext(next: Function) {
      console.log('global beforeNext');
      next();
    },
    beforePrev(prev: Function) {
      console.log('global beforePrev');
      prev();
    },
    afterEnter() {
      console.log('global afterEnter');
    },
    onSkip() {
      console.log('global onSkip');
    },
    onComplete() {
      console.log('global onComplete');
    },
    onExit() {
      console.log('global exit');
    }
  },
  steps: [
    {
      tip: `欢迎你Guide
          你好
            你好  
              开始`,
      beforeNext(next: Function) {
        console.log('beforeNext');
        next()
      },
      beforeEnter(next: Function) {
        console.log('beforeEnter');
        next();
      },
      afterEnter() {
        console.log('afterEnter');
      },
    },
    {
      id: 'step1',
      tip: '<div style="color: red;">html</div>',
      beforePrev(prev: Function) {
        console.log('beforePrev'); prev()
      },
    },
    {
      id: 'step60',
      tip: '提示文案60',
      position: 'left',
    },
    {
      id: () => document.querySelector('[data-guide="step90"]'),
      tip: '提示文案90',
    },
    {
      id: 'step40',
      tip: '提示文案40',
    }
  ],
})
// wait DomTree render complete
guide.start();
```

ps: 完整选项请查看源码

---
_Source: https://npm.io/package/@huise513/guide · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._