cm-chessboard 4.3.1 → 4.3.4

package/README.md

@@ -102,7 +102,8 @@ let defaultProps = {
         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
 }
 ```
 
@@ -335,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
             }
-
         }]
 })
 ```

package/package.json

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

package/src/cm-chessboard/Chessboard.js

@@ -67,7 +67,7 @@ export class Chessboard {
                 size: 40, // the sprite tiles size, defaults to 40x40px
                 cache: true // cache the sprite
             },
-            extensions: [ /* {class: ExtensionClass, props: { ... }} */ ] // add extensions here like this
+            extensions: [ /* {class: ExtensionClass, props: { ... }} */ ] // add extensions here
         }
         this.props = {}
         Object.assign(this.props, defaultProps)