scratch-me v1.0.0

ScratchMe

一个基于canvas实现“刮刮卡”功能的js库。

安装

使用npm:

$ npm install scratch-me

直接引入<script>:

<script src="//cdn.jsdelivr.net/npm/scratch-me@0.0.1/dist/scratch-me.min.js"></script>

示例

查看demo页面

快速开始

首先需要在html中放置一个容器：

<div class="container"></div>

在js中引入ScratchCanvas并将容器元素传递给构造函数后调用实例的init方法即可：

import ScratchMe from 'scratch-me'

const containerElm = document.querySelector('.container')
const scratchMe = new ScratchMe(containerElm)
scratchMe.init()

配置

在创建实例时通过向第二个参数传入一个对象进行配置：

const scratchMe = new ScratchMe(elm, {/* 配置项... */})
scratchMe.init()

可用配置项：

实例API

License

MIT