# StepGuide

**Repository Path**: ankeji/step-guide

## Basic Information

- **Project Name**: StepGuide
- **Description**: 用于产品引导、突出显示和上下文帮助的轻量级 JavaScript 库，可引导用户了解您的产品。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-02-21
- **Last Updated**: 2025-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# StepGuide

#### 介绍
用于产品引导、突出显示和上下文帮助的轻量级 JavaScript 库，可引导用户了解您的产品。

#### 软件架构
软件架构说明


#### 安装教程

1.  在 ES6 模块中使用 import

    ```
    import StepGuide from "StepGuide.js"
    ```

#### 使用说明

1.  实例化引导库
    ```
    const guide = new StepGuide({
      steps: [
        {
          element: '#data-item-one', // CSS选择器
          title: '欢迎使用',
          content: '这是第一个步骤，点击这里开始！',
          position: 'top'
        },
        {
          element: '.data-item-two',
          title: '主要功能',
          content: '这是第二个步骤，继续下一个吧！',
          position: 'top'
        },
        {
          element: '.dataLayer',
          title: '主要功能',
          content: '这是第三个步骤，继续下一个吧！',
          position: 'top'
        }
      ],
      maskColor: 'rgba(0, 0, 0, 0.6)', //遮罩层颜色
      btnNextText: '下一步',
      btnPrevText: '上一步',
      btnSkipText: '跳过',
      btnFinishText: '完成',
      padding: 15,
      maxWidth: 300, // 操作面板最大宽度
      position: 'auto',
      scrollLock: true,
      zIndex: 10000, // 步骤引导类的层级
    });
    ```
2.  调用方法类
    ```
    guide.start();
    ```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)