Add option to enable/disable keyboard navigation

For times when it may conflict with other keyboard bindings on a page
lichess-org · Dec 11, 2024 · d9a293d · d9a293d
1 parent 12207f7
commit d9a293d
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 2 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+pnpm-lock.yaml
diff --git a/demo/demo.js b/demo/demo.js
diff --git a/src/config.ts b/src/config.ts
@@ -8,6 +8,7 @@ const defaults: Opts = {
   showMoves: 'auto', // false | "right" | "bottom" | auto. "auto" uses media queries
   showControls: true, // show the [prev, menu, next] buttons
   scrollToMove: true, // enable scrolling through moves with a mouse wheel
+  keyboardToMove: true, // enable keyboard navigation through moves
   orientation: undefined, // orientation of the board. Undefined to use the Orientation PGN tag.
   initialPly: 0, // current position to display. Can be a number, or "last"
   chessground: {}, // chessground configuration https://github.com/lichess-org/chessground/blob/master/src/config.ts#L7

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -88,6 +88,7 @@ export interface Opts {
   showControls: boolean;
   initialPly: Ply | 'last';
   scrollToMove: boolean;
+  keyboardToMove: boolean;
   drawArrows: boolean;
   menu: {
     getPgn: {

diff --git a/src/view/main.ts b/src/view/main.ts
@@ -26,7 +26,7 @@ export default function view(ctrl: PgnViewer) {
       },
       hook: onInsert(el => {
         ctrl.setGround(Chessground(el.querySelector('.cg-wrap') as HTMLElement, makeConfig(ctrl, el)));
-        el.addEventListener('keydown', onKeyDown(ctrl));
+        if (opts.keyboardToMove) el.addEventListener('keydown', onKeyDown(ctrl));
       }),
     },
     [