0.0.3 • Published 5 years ago
yjk-sdk v0.0.3
前面的话
- 使用原生语言编写的插件，自身不会受依赖的插件的使用场景而影响自身的使用（依赖 jQuery 的插件不适合在单页面应用（react/vue）中使用），所以使用上更加灵活；
- 搭配模块化开发，使用原生语言开发的插件可以只专注一个功能，所以代码量可以很少，方便开发和维护；
- 最后，随着 JS/CSS/HTML 的发展以及浏览器不断迭代更新，现在使用原生语言编写插件的开发成本越来越低，那为什么不呢？
使用方法
- 传统引入方式
<!DOCTYPE html>
<html lang="en">
<head>
</head>
<body>
...
<script src="youtpath/yjk.min.js"></script>
</body>
</html>- ES6 模块化引入
1）安装 npm package：
# 这里使用 yarn，也可以使用 npm 安装
yarn add yjk-sdk2）引入 js
// css 文件需单独引入
import yjk from 'yjk-sdk';- 其他说明
3）新建 yjk 实例并初始化
// 创建实例并初始化
new yjk();4）自定义参数
实例化 yjk 时接受一个''作为参数，
// 创建实例并初始化其中：
delay截流/间隔函数延迟时间，默认 1000 ms，为了兼容 Mac 触控板，这个值最好大于 1000ms。isShowNav控制是否显示右侧导航，Boolean 类型，默认为true，设为false则不显示；
了解更多
可查看 用 ES6 写全屏滚动插件 了解详细开发过程。
License
MIT
- 开发
1）clone 本仓库到本地
2）安装依赖
3）开发过程中通过 gulp 进行管理
# 开发过程监听 `src` 目录下文件的变化，有变化更新 dist 下面的文件
npm run dev
# 手动生成新的 dist 下面的文件
npm run build