Giter VIP home page Giter VIP logo

jqjigsawpuzzle's Introduction

jqJigsawPuzzle

jqJigsawPuzzle is a JavaScript library that lets you create jigsaw puzzles in your web pages.

It requires jQuery and jQuery UI, and, by the moment, it only works in webkit browsers, since it uses the CSS property -webkit-mask-image.

Usage

In order to use jqJigsawPuzzle, first you must include the JavaScript and CSS files of jqJigsawPuzzle, jQuery and jQuery UI into your page's <head> tag:

<link type="text/css" rel="stylesheet" href="jquery-ui.custom.css"/>
<link type="text/css" rel="stylesheet" href="jqJigsawPuzzle.css"/>
    
<script type="text/javascript" src="jquery.min.js"></script>
<script type="text/javascript" src="jquery-ui.custom.min.js"></script>
<script type="text/javascript" src="jqJigsawPuzzle.js"></script>

And then you must call one of the jqJigsawPuzzle methods:

  • jqJigsawPuzzle.createPuzzleFromImage: transform a <img> element into a puzzle.
  • jqJigsawPuzzle.createPuzzleFromURL: adds a puzzle into a <div> element, using an image defined by a URL.

For example:

<div>
    <img id="my_puzzle" src="img/alaska-cliffs.jpg" alt=""/>
</div>
<script type="text/javascript">
    jQuery(document).ready(function() {
        jqJigsawPuzzle.createPuzzleFromImage("#my_puzzle");
    });
</script>

Methods description

jqJigsawPuzzle.createPuzzleFromImage

Creates a puzzle from a <img> element.

jqJigsawPuzzle.createPuzzleFromImage = function(imageSelector, options);

Parameters

Parameter Description
imageSelector A CSS selector or a jQuery's object for select the <img> element.
options (optional) An associative array with the properties (all of them optionals): piecesSize (which defines the size of the pieces, it can take the values 'normal', 'big' or 'small'), borderWidth (an integer which defines the width of the border around the puzzle) and shuffle (an associative array with the values rightLimit, leftLimit, topLimit and bottomLimit, which allow to extends the limits in with the pieces are moved when they are shuffled, since normally they are restricted to the puzzles frame).

jqJigsawPuzzle.createPuzzleFromURL

Creates a puzzle inside a <div> element, using an image defined by a URL.

jqJigsawPuzzle.createPuzzleFromURL = function(containerSelector, imageUrl, options)

Parameters

Parameter Description
containerSelector A CSS selector or a jQuery's object inside which create the puzzle.
imageUrl An string with the image's URL.
options (optional) An associative array with the properties (all of them optionals): piecesSize (which defines the size of the pieces, it can take the values 'normal', 'big' or 'small'), borderWidth (an integer which defines the width of the border around the puzzle) and shuffle (an associative array with the values rightLimit, leftLimit, topLimit and bottomLimit, which allow to extends the limits in with the pieces are moved when they are shuffled, since normally they are restricted to the puzzles frame).

License

This library is free software; you can redistribute it and/or modify it under the terms of the Mozilla Public License v2.0. You should have received a copy of the MPL 2.0 along with this library, otherwise you can obtain one at http://mozilla.org/MPL/2.0/.

jqjigsawpuzzle's People

Contributors

jfmdev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

jqjigsawpuzzle's Issues

puzzle responsiveness.

Is there a way to make the pieces and puzzle responsive.
And also i want to have a puzzle of fixed height and width right now if i put image of high dimensions it is taking over all the screen and the size of puzzle created is very big.

Positioning of Shuffled Pieces

Is there any way in which the pieces when shuffled, are outside the canvas, lined up on the side, waiting to be dragged and dropped, because right now, for larger images there is a huge mess on the canvas.

Also, is there any way this could be responsive?

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.