Giter Club home page Giter Club logo

canvas-scratch's Introduction

canvas-scratch

JavaScript plugin for scratch effect.

Demo

Usage

Install:

... just manual. for now.
...

Example:

scratch({
    wrapper: document.getElementById('scratch'),
    imageUrl: 'scratch.jpg',
    lineWidth: 60,
    useBrush: true,
    autoScratch: true,
    mode: scratch.MODE_WITHOUT_MOUSEDOWN,
    onInit: function() { ... },
    onComplete: function() { ... },
    onScratch: function(e) {
        // e.percent
    }
});

Configuration

DOMElement wrapper (required) - a DOM element where the canvas will be placed.

string imageUrl (required) - path to an image that will be scratched. Canvas will be resized to the image width & height.

int lineWidth (optional)

boolean useBrush (optional)

boolean autoScratch (optional)

object autoScratch: {delay: 5000} (optional) - delay in miliseconds

mode (required):

  • scratch.MODE_WITH_MOUSEDOWN
  • scratch.MODE_WITHOUT_MOUSEDOWN

function onInit (optional) - called when the image is loaded and canvas created.

function onComplete (optional) - called when user scratched the hole image.

function onScratch(event) (optional) - called every scratch movement. event object contains x, y and percent properties.

Browser requirements

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.