cm-chessboard 8.3.2 → 8.3.4

package/README.md

@@ -87,7 +87,7 @@ To enable the user to move the pieces, you have to enable the move input.
 const board = new Chessboard(document.getElementById("board"), {
         position: FEN.start,
         assetsUrl: "../assets/",
-        extensions: [{class: Markers}] // Looks better with markers
+        extensions: [{class: Markers}] // Looks better with markers. (Don't forget to also include the CSS for the markers)
     })
 
     board.enableMoveInput(inputHandler) // This enables the move input
@@ -218,25 +218,34 @@ board.enableMoveInput((event) => {
 The event has the following **`event.type`**:
 
 - **`INPUT_EVENT_TYPE.moveInputStarted`**: User started the move input, `event.squareFrom` contains the coordinates.
-  Return true or false to validate the start square.
-- **`INPUT_EVENT_TYPE.validateMoveInput`**: User finished the move input, `event.squareFrom` and `event.squareTo`
-  contain the coordinates. Return true or false to validate the move input.
-- **`INPUT_EVENT_TYPE.moveInputCanceled`**: User canceled the move with clicking again on the start square or clicking
-  outside the board.
+  Return `true` or `false` to validate the start square. `false` cancels the move.
+- **`INPUT_EVENT_TYPE.validateMoveInput`**: To validate the users move input. `event.squareFrom` and `event.squareTo`
+  contain the coordinates. Return `true` or `false` to validate the move. `false` cancels the move.
+- **`INPUT_EVENT_TYPE.moveInputCanceled`**: The user canceled the move with clicking again on the start square, clicking
+  outside the board or right click.
+- **`INPUT_EVENT_TYPE.moveInputFinished`**: Fired after the move was made.
+- **`INPUT_EVENT_TYPE.movingOverSquare`**: Fired, when the user moves the piece over a square. `event.square` contains
+  the coordinates.
 
 ```javascript
 chessboard.enableMoveInput((event) => {
+    console.log("move input", event)
     switch (event.type) {
         case INPUT_EVENT_TYPE.moveInputStarted:
-            console.log(`moveInputStarted: ${event.squareFrom}`)
-            // return `true`, if input is accepted/valid, `false` aborts the interaction, the piece will not move
-            return true
+            log(`moveInputStarted: ${event.squareFrom}`)
+            return true // false cancels move
         case INPUT_EVENT_TYPE.validateMoveInput:
-            console.log(`validateMoveInput: ${event.squareFrom}-${event.squareTo}`)
-            // return true, if input is accepted/valid, `false` takes the move back
-            return true
+            log(`validateMoveInput: ${event.squareFrom}-${event.squareTo}`)
+            return true // false cancels move
         case INPUT_EVENT_TYPE.moveInputCanceled:
-            console.log(`moveInputCanceled`)
+            log(`moveInputCanceled`)
+            break
+        case INPUT_EVENT_TYPE.moveInputFinished:
+            log(`moveInputFinished`)
+            break
+        case INPUT_EVENT_TYPE.movingOverSquare:
+            log(`movingOverSquare: ${event.square}`)
+            break
     }
 }, COLOR.white)
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cm-chessboard",
-  "version": "8.3.2",
+  "version": "8.3.4",
   "description": "A JavaScript chessboard which is lightweight, ES6 module based, responsive, SVG rendered and without dependencies.",
   "keywords": [
     "chess",

package/src/model/Extension.js

@@ -12,7 +12,7 @@ export const EXTENSION_POINT = {
     beforeRedrawBoard: "beforeRedrawBoard", // called before redrawing the board
     afterRedrawBoard: "afterRedrawBoard", // called after redrawing the board
     redrawBoard: "redrawBoard", // called after redrawing the board, DEPRECATED, use afterRedrawBoard 2023-09-18
-    animation: "animation", // called on animation start, end and on every animation frame
+    animation: "animation", // called on animation start, end, and on every animation frame
     destroy: "destroy" // called, before the board is destroyed
 }
 
@@ -23,7 +23,7 @@ export class Extension {
     }
 
     registerExtensionPoint(name, callback) {
-        if(name === EXTENSION_POINT.redrawBoard) {
+        if(name === EXTENSION_POINT.redrawBoard) { // deprecated 2023-09-18
             console.warn("EXTENSION_POINT.redrawBoard is deprecated, use EXTENSION_POINT.afterRedrawBoard")
             name = EXTENSION_POINT.afterRedrawBoard
         }

package/examples/test-getPiece.html

@@ -1,21 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-    <link rel="stylesheet" href="../assets/chessboard.css">
-    <title>frame test</title>
-</head>
-<body>
-Board:
-<div id="board"></div>
-
-<script type="module">
-    import { Chessboard } from '../src/Chessboard.js'
-
-    const board = new Chessboard(document.getElementById('board'), {
-        position: 'start',
-        sprite: {url: '../assets/images/chessboard-sprite.svg'},
-        style: {borderType: 'frame'}
-    })
-</script>
-</body>
-</html>