cm-chessboard 4.3.2 → 4.3.5

package/README.md

@@ -85,25 +85,25 @@ Below is the default configuration
 
 ```javascript
 let defaultProps = {
-  position: "empty", // set as fen, "start" or "empty"
-  orientation: COLOR.white, // white on bottom
-  responsive: true, // resize the board automatically to the size of the context element
-  animationDuration: 300, // pieces animation duration in milliseconds. Disable all animation with `0`.
-  language: navigator.language.substring(0, 2).toLowerCase(), // supports "de" and "en" for now, used for pieces naming
-  style: {
-    cssClass: "default", // set the css theme of the board, try "green", "blue" or "chess-club"
-    showCoordinates: true, // show ranks and files
-    borderType: BORDER_TYPE.none, // "thin" thin border, "frame" wide border with coordinates in it, "none" no border
-    aspectRatio: 1, // height/width of the board
-    moveFromMarker: MARKER_TYPE.frame, // the marker used to mark the start square
-    moveToMarker: MARKER_TYPE.frame, // the marker used to mark the square where the figure is moving to
-  },
-  sprite: {
-    url: "./assets/images/chessboard-sprite.svg", // pieces and markers are stored in a sprite file
-    size: 40, // the sprite tiles size, defaults to 40x40px
-    cache: true // cache the sprite
-  },
-  extensions: [ /* {class: ExtensionClass, props: { ... }} */ ] // add extensions here
+    position: "empty", // set as fen, "start" or "empty"
+    orientation: COLOR.white, // white on bottom
+    responsive: true, // resize the board automatically to the size of the context element
+    animationDuration: 300, // pieces animation duration in milliseconds. Disable all animation with `0`.
+    language: navigator.language.substring(0, 2).toLowerCase(), // supports "de" and "en" for now, used for pieces naming
+    style: {
+        cssClass: "default", // set the css theme of the board, try "green", "blue" or "chess-club"
+        showCoordinates: true, // show ranks and files
+        borderType: BORDER_TYPE.none, // "thin" thin border, "frame" wide border with coordinates in it, "none" no border
+        aspectRatio: 1, // height/width of the board
+        moveFromMarker: MARKER_TYPE.frame, // the marker used to mark the start square
+        moveToMarker: MARKER_TYPE.frame, // the marker used to mark the square where the figure is moving to
+    },
+    sprite: {
+        url: "./assets/images/chessboard-sprite.svg", // pieces and markers are stored in a sprite file
+        size: 40, // the sprite tiles size, defaults to 40x40px
+        cache: true // cache the sprite
+    },
+    extensions: [ /* {class: ExtensionClass, props: { ... }} */] // add extensions here
 }
 ```
 
@@ -336,24 +336,39 @@ cm-chessboard provides the ability to extend its functionality with extensions.
 and have access to the chessboard and can register extension points.
 
 ```js
-this.registerExtensionPoint(EXTENSION_POINT.moveInputStateChanged, (data) => {
-    // do something on move [start | cancel | done]
-    console.log(data)
-})
+class MyCoolChessboardExtension extends Extension {
+    constructor(chessboard, props) {
+        super(chessboard, props)
+        this.registerExtensionPoint(EXTENSION_POINT.moveInputStateChanged, (data) => {
+            // do something on move [start | cancel | done]
+            console.log(data)
+        })
+    }
+}
 ```
 
-Enable extension via the chessboard props.
+Currently possible extension points are defined in `Extension.js`.
+
+```js
+export const EXTENSION_POINT = {
+    positionChanged: "positionChanged",
+    boardChanged: "boardChanged",
+    moveInputStateChanged: "moveInputStateChanged",
+    destroy: "destroy"
+}
+```
+
+Enable extensions via the chessboard props.
 
 ```js
 const chessboard = new Chessboard(document.getElementById("board"), {
     position: "start",
     extensions: // list of used extensions
         [{
-            class: ExtensionName, // this class of the extionsion
+            class: MyCoolChessboardExtension, // the class of the extension
             props: {
-                // configure your extions via its properties
+                // configure the extension here
             }
-
         }]
 })
 ```
@@ -380,7 +395,7 @@ const chessboard = new Chessboard(document.getElementById("board"), {
         [{
             class: Accessibility,
             props: {
-                brailleNotationInAlt: true, // show the braille notation of the game in the alt attribute of the SVG
+                brailleNotationInAlt: true, // show the braille notation of the position in the alt attribute of the SVG image
                 boardAsTable: true, // display the board additionally as HTML table
                 movePieceForm: true, // display a form to move a piece (from, to, move)
                 piecesAsList: true, // display the pieces additionally as List

package/package.json

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

package/src/cm-chessboard/extensions/Accessibility.js

@@ -37,7 +37,7 @@ export class Accessibility extends Extension {
     constructor(chessboard, props) {
         super(chessboard, props)
         this.props = {
-            brailleNotationInAlt: true, // show the braille notation of the game in the alt attribute of the SVG
+            brailleNotationInAlt: true, // show the braille notation of the position in the alt attribute of the SVG image
             boardAsTable: false, // display the board additionally as HTML table
             movePieceForm: false, // display a form to move a piece (from, to, move)
             piecesAsList: false, // display the pieces additionally as List