Some Title

# jq-snap-puzzle Extensible puzzle game made with JQuery widget Based on [jQuery-snapPuzzle](https://github.com/Pixabay/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](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzleoptions.html#classes) - Extensible with Widget. See [jQuery UI widget docs](http://api.jqueryui.com/jQuery.widget/) - Define the number of rows and columns - Possibility to show the target image. [See backgroundInSlots](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzleoptions.html#backgroundinslots) - Possibility to show feedback (correct/incorrect) when the piece is over the slot[See feedbackOnHover](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzleoptions.html#feedbackonhover) - Possibility to allow drop the pieces only in the correct slot[See onlyDropOnValid](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzleoptions.html#onlydroponvalid) - Solve a random piece, a specific piece by index or all the pieces moving automatically to the correct slot[See solve](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#solve) - Responsive ## Docs For more info, please check the [docs](https://davinchi-finsi.github.io/jq-snap-puzzle/) ## Playground [Demo in jsfiddle](https://jsfiddle.net/Haztivity/71vecg2x/) ## Usage Install with `npm i jq-snap-puzzle` or download the [latest release](https://github.com/davinchi-finsi/jq-snap-puzzle/releases) ### Import as module #### Typescript: ```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({ //options }); ``` #### Vanilla ES2015 ```javascript 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 ```html Some Title

``` ## 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: ```typescript import "jq-snap-puzzle/esm2015/jquery-ui-deps"; ``` ### dist package In npm is available the package [jquery-ui-dist](https://www.npmjs.com/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](https://jqueryui.com/download) and checks: - Interaction: - Draggable - Droppable or use [this configuration](https://jqueryui.com/download/#!version=1.12.1&components=101000000100110000000000010000000000000000000000) ### Options Please go to [docs](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzlepieceoptions.html) ### Events | Event name | Detail | Emit | | ------------- | ---------------- | ----- | | [snapPuzzle:pieceDrop](https://davinchi-finsi.github.io/jq-snap-puzzle/enums/jqsnappuzzle.snappuzzleevents.html#piecedrop) | Triggered when a piece is dropped in a slot | [SnapPuzzlePieceDropEvent](https://davinchi-finsi.github.io/jq-snap-puzzle/interfaces/jqsnappuzzle.snappuzzlepiecedropevent.html) | | [snapPuzzle:complete](https://davinchi-finsi.github.io/jq-snap-puzzle/enums/jqsnappuzzle.snappuzzleevents.html#complete) | Triggered when all the pieces of the puzzle are placed correctly. | | | [snapPuzzle:reset](https://davinchi-finsi.github.io/jq-snap-puzzle/enums/jqsnappuzzle.snappuzzleevents.html#reset) | Triggered when the puzzle is reset. | | For more info, please go to [docs](https://davinchi-finsi.github.io/jq-snap-puzzle/enums/jqsnappuzzle.snappuzzleevents.html) ### Methods Available methods to invoke: | Method | Short description | | ------------- | ----------------------- | | [destroy](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#destroy) | Destroy the widget | | [disable](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#disabled) | Disable the widget | | [enable](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#enable) | Enable the widget | | [solve](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#solve) | Solve the puzzle. Multiple options are available | | [refresh](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#refresh) | Refresh the dimensions and positions of the pieces and slots | | [reset](https://davinchi-finsi.github.io/jq-snap-puzzle/classes/jqsnappuzzle.snappuzzlegame.html#reset) | Reset the puzzle reverting the pieces and resetting the progress | For more info, please go to [docs](https://davinchi-finsi.github.io/jq-snap-puzzle/enums/jqsnappuzzle.snappuzzlegame.html) **Please note** that only public methods are available using `$("selector").snapPuzzle("methodName","methodParams");`