cm-chessboard 7.6.7 → 7.6.8

package/README.md

@@ -208,7 +208,7 @@ board.enableMoveInput((event) => {
 
 The event has the following **`event.type`**:
 
-- **`INPUT_EVENT_TYPE.moveInputStarted`**: User started the move input, `event.square` contains the coordinates. Return true or false to validate the start square.
+- **`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.
 
@@ -216,7 +216,7 @@ The event has the following **`event.type`**:
 chessboard.enableMoveInput((event) => {
   switch (event.type) {
     case INPUT_EVENT_TYPE.moveInputStarted:
-      console.log(`moveInputStarted: ${event.square}`)
+      console.log(`moveInputStarted: ${event.squareFrom}`)
       // return `true`, if input is accepted/valid, `false` aborts the interaction, the piece will not move
       return true
     case INPUT_EVENT_TYPE.validateMoveInput:

package/examples/enable-input.html

@@ -30,7 +30,7 @@ function inputHandler(event) {
     window.board.removeMarkers(MARKER_TYPE.frame)
     switch (event.type) {
         case INPUT_EVENT_TYPE.moveInputStarted:
-            log(`moveInputStarted: ${event.square}`)
+            log(`moveInputStarted: ${event.squareFrom}`)
             return true
         case INPUT_EVENT_TYPE.validateMoveInput:
             log(`validateMoveInput: ${event.squareFrom}-${event.squareTo}`)
@@ -62,7 +62,7 @@ function inputHandler(event) {
         // console.log(event)
         switch (event.type) {
             case INPUT_EVENT_TYPE.moveInputStarted:
-                log(`moveInputStarted: ${event.square}`)
+                log(`moveInputStarted: ${event.squareFrom}`)
                 return true
             case INPUT_EVENT_TYPE.validateMoveInput:
                 log(`validateMoveInput: ${event.squareFrom}-${event.squareTo}`)

package/examples/validate-moves.html

@@ -40,11 +40,12 @@
 
     function inputHandler(event) {
         console.log("inputHandler", event)
-        console.log("fen", event.chessboard.getPosition())
-        event.chessboard.removeMarkers(MARKER_TYPE.dot)
-        event.chessboard.removeMarkers(MARKER_TYPE.bevel)
+        if(event.type !== INPUT_EVENT_TYPE.moveInputFinished) {
+            event.chessboard.removeMarkers(MARKER_TYPE.dot)
+            event.chessboard.removeMarkers(MARKER_TYPE.bevel)
+        }
         if (event.type === INPUT_EVENT_TYPE.moveInputStarted) {
-            const moves = chess.moves({square: event.square, verbose: true})
+            const moves = chess.moves({square: event.squareFrom, verbose: true})
             for (const move of moves) { // draw dots on possible squares
                 if (move.promotion && move.promotion !== "q") {
                     continue

package/package.json

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

package/src/lib/Svg.js

@@ -28,10 +28,10 @@ export class Svg {
      * @param parent
      * @param name
      * @param attributes
-     * @param sibling
+     * @param sibling // TODO remove this parameter (2023-05-22)
      * @returns {Element}
      */
-    static addElement(parent, name, attributes, sibling = undefined) {
+    static addElement(parent, name, attributes = {}, sibling = undefined) {
         let element = document.createElementNS(SVG_NAMESPACE, name)
         if (name === "use") {
             attributes["xlink:href"] = attributes["href"] // fix for safari

package/src/view/ChessboardView.js

@@ -335,6 +335,7 @@ export class ChessboardView {
         const data = {
             chessboard: this.chessboard,
             type: INPUT_EVENT_TYPE.moveInputStarted,
+            square: square, /** square is deprecated, use squareFrom (2023-05-22) */
             squareFrom: square,
             piece: this.chessboard.getPiece(square)
         }