@souljs/ribbon.js

ribbon-canvas

使用超简单的网站特效插件

⭐ 特性

• 支持ES6+或TypeScript编写源码，编译生成生产代码
• 多环境支持（支持浏览器原生，支持AMD，CMD，支持Webpack，Rollup，fis等）

注意: 如果不同时使用 export 与 export default 可打开 legacy模式，legacy模式 下的模块系统可以兼容 ie6-8，见rollup配置文件

💊 兼容性

单元测试保证支持如下环境：

IE	CH	FF	SF	OP	IOS	Android
11+	100+	100+	16+	100+	10.3+	4.1+

注意：编译代码依赖ES5环境，对于ie6-8需要引入es5-shim才可以兼容，可以查看demo/demo-global.html中的例子

📂 目录介绍

.
├── demo 使用demo
├── dist 编译产出代码
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能

🚀 使用者指南

通过npm下载安装代码

$ npm install --save @souljs/ribbon.js

入口文件main.ts

import '@souljs/ribbon.js';

📑 文档

API

😘 贡献者指南

贡献者列表

contributors

⚙️ 更新日志

CHANGELOG.md

✈️ 计划列表

TODO.md