Code Monkey home page Code Monkey logo

wscratchpad's Introduction

wScratchPad.js

A jQuery plugin to simulate scratching a card/ticket/etc (mobile friendly). Check out the live demo.

Settings

Available options with notes, the values here are the defaults.

$('#elem').wScratchPad({
    width         : 210,                 // set width - best to match image width
    height        : 100,                 // set height - best to match image height
    image         : 'images/slide1.jpg', // set image path
    image2        : null,                // set overlay image path - if set color is not used
    color         : '#336699',           // set scratch color - if image2 is not set uses color
    overlay       : 'none',              // set the type of overlay effect 'none', 'lighter' - only used with color
    size          : 10,                  // set size of scratcher
    scratchDown   : null,                // scratchDown callback
    scratchUp     : null,                // scratchUp callback
    scratchMove   : null,                // scratcMove callback
    cursor        : null                 // Set path to custom cursor
});

Update settings on the fly:

$('#elem').wScratchPad('width', 300);

Retrieve settings, if more than one it will return an array otherwise just the value.

console.log($('#elem').wScratchPad('size'));            // 10
console.log($('.elem').wScratchPad('size'));            // ['10', '10', '10']

Methods

$('#elem').wScratchPad('reset');
$('#elem').wScratchPad('clear');
$('#elem').wScratchPad('enabled', <boolean>);

Examples

Show percent scratched:

<div id="wScratchPad"></div>

<div>
    percent scratched: <span id="percent_scratched"></span>
</div>

<script type="text/javascript">
    var sp = $("#wScratchPad").wScratchPad({
        scratchDown: function(e, percent){$("#percent_scratched").html(percent)},
        scratchMove: function(e, percent){$("#percent_scratched").html(percent)},
        scratchUp: function(e, percent){$("#percent_scratched").html(percent)}
    });
</script>

Update on the fly:

<div id="wScratchPad"></div>

<script type="text/javascript">
    var sp = $("#wScratchPad").wScratchPad();

    sp.wScratchPad('width', '200');
    sp.wScratchPad('image', './images/winner.png');
    sp.wScratchPad('image2', './images/scratch-to-win.png');
    sp.wScratchPad('cursor', './cursors/coin.png');
    sp.wScratchPad('reset');
</script>

Init with custom cursor:

<div id="wScratchPad"></div>

<script type="text/javascript">
    $("#wScratchPad").wScratchPad({
        cursor:'./cursors/mario.png'
    });
</script>

Resources

License

MIT licensed

Copyright (C) 2011-2012 Websanova http://www.websanova.com

wscratchpad's People

Contributors

websanova avatar richardvandermeer avatar

Watchers

Leonardo Thibes avatar

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.