# ly-guide

**Repository Path**: tengzhinei/ly-guide

## Basic Information

- **Project Name**: ly-guide
- **Description**: ly-guide.js 是一个体积小,却超级好用的用户指引框架,使用简单,界面漂亮,适用范围广
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-06-22
- **Last Updated**: 2024-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ly-guide

#### 介绍
ly-guide是一个体积小,却超级好用的用户指引框架,使用简单,界面漂亮,适用范围广.

该项目已在我的后台框架里有引用,并进行了使用

ly-admin-ui 开源地址 https://gitee.com/tengzhinei/ly-admin-ui

#### 演示截图

<img  width="100%" style="border-radius:10px;margin-top:20px;margin-bottom:20px;box-shadow: 2px 0 6px gray;" src="demo.jpg" />

#### 演示地址

演示 1 http://cdn.static.magcloud.net/lyguide/

演示 2 http://lyadminui.magcloud.net/portal/comp/guide
#### 使用说明

#### 标签

| 属性名  |说明   | 类型|可选值|默认值|
| ------------ | ------------ |------------ |------------ |------------ |
|  guide-title| 显示标题	  |string |-	|-|
|  guide-content | 显示内容	  |string|-	|-|
|  guide-placement | 显示位置	 |string |top,left,right,bottom	|bottom	|
|  guide-group | 分组   |string|-	|默认不分组|
|  guide-level | 排序   |int|-	|默认排序是按元素位置排的|

#### 全局对象 `LyGuide`

##### Attributes
| 属性名  |说明   | 参数说明|
| ------------ | ------------ |------------ |
|  LyGuide.show(option) | 显示指导	 |can_finish:是否显示关闭按钮,callback:,, |
|  LyGuide.hide()| 关闭指导	  |- |
           
##### option
| 属性名  |说明   |
| ------------ | ------------ |
|  can_finish | 是否显示关闭按钮	 |
|  group | 按分组显示	 |
|  callback|结束回调, 回调参数 表示是否完整 观看	  |
|  guides|通过配置项配置的引导	 |
|  guides[].selector| 为 元素选择器|
|  guides[].el| 为 元素  el和selector必须有一个|
|  guides[].content|显示内容|
|  guides[].title|显示标题|
|  guides[].level|排序|
|  guides[].group|分组|
|  guides[].placement|显示位置|