❤
npm
Sign UpSign In

jq-snap-puzzle
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

jq-snap-puzzle

Extensible puzzle game made with JQuery widget

Based on jQuery-snapPuzzle of @Pixabay

Dependencies

  • jquery
  • jQuery UI:
    • jQuery UI widget
    • jQuery UI draggable
    • jQuery UI droppable

Features

  • Typescript sources
  • All the css classes are configurable. See css classes
  • Extensible with Widget. See jQuery UI widget docs
  • Define the number of rows and columns
  • Possibility to show the target image. See backgroundInSlots
  • Possibility to show feedback (correct/incorrect) when the piece is over the slotSee feedbackOnHover
  • Possibility to allow drop the pieces only in the correct slotSee onlyDropOnValid
  • Solve a random piece, a specific piece by index or all the pieces moving automatically to the correct slotSee solve
  • Responsive

Docs

For more info, please check the docs

Playground

Demo in jsfiddle

Usage

Install with npm i jq-snap-puzzle or download the latest release

Import as module

Typescript:

import * as $ from "jquery";
//choose one of the follow options
//for jquery-ui package
import "jq-snap-puzzle/esm2015/jquery-ui-deps";
//for jquery-ui-dist package
import "jquery-ui-dist/jquery-ui";
import {SnapPuzzleOptions} from "jq-snap-puzzle";
$("someSelector").snapPuzzle(<SnapPuzzleOptions>{
    //options
});

Vanilla ES2015

import * as $ from "jquery";
//choose one of the follow options
//for jquery-ui package
import "jq-snap-puzzle/esm2015/jquery-ui-deps";
//for jquery-ui-dist package
import "jquery-ui-dist/jquery-ui";
import "jq-snap-puzzle";
$("someSelector").snapPuzzle({
    //options
});

Please note that depending of the bundler you are using other configurations may be necessary. For example, shimming JQuery and jQuery UI.

Traditional way

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Some Title</title>
        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script> 
        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.min.js"></script> 
        <script type="text/javascript" src="path/to/jquery.snap-puzzle"></script> 
    </head>
    <body>
        <img src="someImage">
        <script type="text/javascript">
            //jq-snap-puzzle will wait until de image is loaded
            $("img").snapPuzzle({
                columns:4,
                rows:4
            });
        </script> 
    </body>
</html>

jQuery UI

jQuery UI could be included in the projects in many different ways and with different packages, instead of force you to use one, we leave up to you how to include it:

Modularized

Using npm i jquery-ui that install the package allowing to import the widgets you want.

We provided a file with the imports of the required dependencies:

import "jq-snap-puzzle/esm2015/jquery-ui-deps";

dist package

In npm is available the package jquery-ui-dist. Recommended if you will use the most of the framework.

Downloading a custom bundle

Go to the jQuery UI download page and checks:

  • Interaction:
    • Draggable
    • Droppable

or use this configuration

Options

Please go to docs

Events

Event name Detail Emit
snapPuzzle:pieceDrop Triggered when a piece is dropped in a slot SnapPuzzlePieceDropEvent
snapPuzzle:complete Triggered when all the pieces of the puzzle are placed correctly.
snapPuzzle:reset Triggered when the puzzle is reset.

For more info, please go to docs

Methods

Available methods to invoke:

Method Short description
destroy Destroy the widget
disable Disable the widget
enable Enable the widget
solve Solve the puzzle. Multiple options are available
refresh Refresh the dimensions and positions of the pieces and slots
reset Reset the puzzle reverting the pieces and resetting the progress

For more info, please go to docs Please note that only public methods are available using $("selector").snapPuzzle("methodName","methodParams");

Readme

Keywords

none

Package Sidebar

Install

npm i jq-snap-puzzle

Repository

github.com/davinchi-finsi/jq-snap-puzzle

Homepage

github.com/davinchi-finsi/jq-snap-puzzle

Weekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

173 kB

Total Files

29

Last publish

Collaborators

  • haztivity
Try on RunKit
Report malware