cm-chessboard 8.12.3 → 8.12.5

package/README.md

@@ -152,10 +152,9 @@ this.props = {
 
 ### setPiece(square, piece, animated = false)
 
-Sets a piece on a square. Example: `board.setPiece("e4", PIECE.blackKnight, true)` or
-`board.setPiece("e4", "bn")`. Remove a Piece with `board.setPiece("e4", null)`. Returns a **Promise**, which is
-resolved,
-after the animation finished.
+Sets a piece on a square. Example: `board.setPiece("e4", PIECE.bn, true)` or
+`board.setPiece("e4", "bn")`. Remove a piece with `board.setPiece("e4", null)`. Returns a **Promise**, which is
+resolved after the animation finished.
 
 ### getPiece(square)
 
@@ -177,9 +176,9 @@ Sets the position as `fen` or only the position part of a `fen`. Returns a **Pro
 
 Returns the board position in form of the position part of a `fen`.
 
-### setOrientation(color)
+### setOrientation(color, animated = false)
 
-Sets the board orientation (color at bottom). Allowed values are `COLOR.white` or `COLOR.black`.
+Sets the board orientation (color at bottom). Allowed values are `COLOR.white` or `COLOR.black`. When `animated` is `true`, the board turns with an animation. Returns a **Promise**, which is resolved after the animation finished.
 
 [Example for **setOrientation**](https://shaack.com/projekte/cm-chessboard/examples/enable-input.html)
 
@@ -187,12 +186,6 @@ Sets the board orientation (color at bottom). Allowed values are `COLOR.white` o
 
 Returns the board orientation.
 
-### destroy()
-
-Removes the board from the DOM.
-
-[Example for **destroy**](https://shaack.com/projekte/cm-chessboard/examples/destroy-many-boards.html)
-
 ### enableMoveInput(eventHandler, color = undefined)
 
 Enables moves via user input (mouse or touch). Set optional `color`, if you want to enable the move input for a specific
@@ -247,6 +240,44 @@ chessboard.enableMoveInput((event) => {
 
 Disables moves via user input.
 
+### isMoveInputEnabled()
+
+Returns `true` if move input is currently enabled for white or black.
+
+### enableSquareSelect(eventType, eventHandler)
+
+Listens for pointer events on squares and calls `eventHandler` with an object `{eventType, event, chessboard, square}`. `eventType` defaults to `POINTER_EVENTS.pointerdown`; allowed values are in `POINTER_EVENTS` (e.g. `pointerdown`, `pointerup`, `pointermove`, …).
+
+```javascript
+board.enableSquareSelect(POINTER_EVENTS.pointerdown, (event) => {
+    console.log(event.square)
+})
+```
+
+[Example for **enableSquareSelect**](https://shaack.com/projekte/cm-chessboard/examples/pointer-events.html)
+
+### disableSquareSelect(eventType)
+
+Stops listening for the given pointer event type.
+
+### isSquareSelectEnabled()
+
+Returns `true` if square select is currently enabled.
+
+### addExtension(extensionClass, props)
+
+Adds an extension at runtime. Throws if the extension class is already added.
+
+### getExtension(extensionClass)
+
+Returns the instance of an added extension, or `null` if not found.
+
+### destroy()
+
+Removes the board from the DOM.
+
+[Example for **destroy**](https://shaack.com/projekte/cm-chessboard/examples/destroy-many-boards.html)
+
 ## Piece sets
 
 cm-chessboard supports alternative piece sets. A piece set is defined in an SVG sprite. cm-chessboard is shipped with

package/package.json

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

package/src/extensions/markers/README.md

@@ -28,6 +28,33 @@ Removes markers from the board.
 Only set `type` to remove all markers of `type` from the board. Set `type` to `undefined`, to remove all types
 of markers from a square. Call without parameters to remove all markers from the board.
 
+## Marker type identity
+
+Marker types are matched by **object reference**, not by structural
+equality. Two type objects that only *look* the same are intentionally
+treated as different types — this lets you have several visually
+identical marker types that can be managed independently.
+
+Always keep your marker types as module-level constants and pass the
+**same reference** to `addMarker` and `removeMarkers`:
+
+```js
+// ✅ works — same reference
+const myType = {class: "marker-frame", slice: "markerFrame"}
+board.addMarker(myType, "e4")
+board.removeMarkers(myType)        // removed
+
+// ❌ silently does nothing — different reference, even though the
+// object looks identical
+board.addMarker({class: "marker-frame", slice: "markerFrame"}, "e4")
+board.removeMarkers({class: "marker-frame", slice: "markerFrame"})
+```
+
+The same applies to the exported `MARKER_TYPE.*` constants: import them
+once and reuse that reference — don't clone them (e.g. via
+`JSON.parse(JSON.stringify(...))` or a framework store that
+deep-copies), or `removeMarkers` won't find a match.
+
 ## Create your own custom markers
 
 Just create an object like `const myMarker = {class: "markerCssClass", slice: "markerSliceId"}`, where `class` is the