Merge pull request #15621 from henrique-barros/global-setting-for-coo…

…rdinates-on-every-square Global setting for coordinates on every square
lichess-org · Jun 29, 2024 · 92fd94d · 92fd94d
2 parents d2a903c + d2e5dbd
commit 92fd94d
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 7 deletions.
diff --git a/modules/coreI18n/src/main/key.scala b/modules/coreI18n/src/main/key.scala
@@ -474,6 +474,7 @@ object I18nKey:
     val `slow`: I18nKey = "slow"
     val `insideTheBoard`: I18nKey = "insideTheBoard"
     val `outsideTheBoard`: I18nKey = "outsideTheBoard"
+    val `allSquaresOfTheBoard`: I18nKey = "allSquaresOfTheBoard"
     val `onSlowGames`: I18nKey = "onSlowGames"
     val `always`: I18nKey = "always"
     val `never`: I18nKey = "never"

diff --git a/modules/pref/src/main/Pref.scala b/modules/pref/src/main/Pref.scala
@@ -329,17 +329,20 @@ object Pref:
     val NONE    = 0
     val INSIDE  = 1
     val OUTSIDE = 2
+    val ALL     = 3
 
     val choices = Seq(
       NONE    -> "No",
       INSIDE  -> "Inside the board",
-      OUTSIDE -> "Outside the board"
+      OUTSIDE -> "Outside the board",
+      ALL     -> "Inside all squares of the board"
     )
 
     def classOf(v: Int) =
       v match
         case INSIDE  => "in"
         case OUTSIDE => "out"
+        case ALL     => "all"
         case _       => "no"
 
   object Replay:

diff --git a/modules/pref/src/main/ui/PrefHelper.scala b/modules/pref/src/main/ui/PrefHelper.scala
@@ -24,7 +24,8 @@ trait PrefHelper:
     List(
       (Pref.Coords.NONE, trans.site.no.txt()),
       (Pref.Coords.INSIDE, trans.site.insideTheBoard.txt()),
-      (Pref.Coords.OUTSIDE, trans.site.outsideTheBoard.txt())
+      (Pref.Coords.OUTSIDE, trans.site.outsideTheBoard.txt()),
+      (Pref.Coords.ALL, trans.site.allSquaresOfTheBoard.txt())
     )
 
   def translatedMoveListWhilePlayingChoices(using Translate) =

diff --git a/modules/web/src/main/ui/LearnUi.scala b/modules/web/src/main/ui/LearnUi.scala
@@ -10,12 +10,18 @@ final class LearnUi(helpers: Helpers):
   import helpers.{ *, given }
   import trans.{ learn as trl }
 
-  def apply(data: Option[play.api.libs.json.JsValue])(using Context) =
+  def apply(data: Option[play.api.libs.json.JsValue])(using ctx: Context) =
     Page(s"${trl.learnChess.txt()} - ${trl.byPlaying.txt()}")
       .js:
         PageModule(
           "learn",
-          Json.obj("data" -> data, "i18n" -> i18nJsObject(i18nKeys))
+          Json.obj(
+            "data" -> data,
+            "i18n" -> i18nJsObject(i18nKeys),
+            "pref" -> Json.obj(
+              "coords" -> ctx.pref.coords
+            )
+          )
         )
       .css("learn")
       .graph(

diff --git a/translation/source/site.xml b/translation/source/site.xml
@@ -590,6 +590,7 @@
   <string name="slow">Slow</string>
   <string name="insideTheBoard">Inside the board</string>
   <string name="outsideTheBoard">Outside the board</string>
+  <string name="allSquaresOfTheBoard">All squares of the board</string>
   <string name="onSlowGames">On slow games</string>
   <string name="always">Always</string>
   <string name="never">Never</string>

diff --git a/ui/analyse/src/ground.ts b/ui/analyse/src/ground.ts
@@ -32,6 +32,7 @@ export function makeConfig(ctrl: AnalyseCtrl): CgConfig {
     lastMove: opts.lastMove,
     orientation: ctrl.bottomColor(),
     coordinates: pref.coords !== Prefs.Coords.Hidden,
+    coordinatesOnSquares: pref.coords === Prefs.Coords.All,
     addPieceZIndex: pref.is3d,
     addDimensionsCssVarsTo: document.body,
     viewOnly: false,

diff --git a/ui/common/src/prefs.ts b/ui/common/src/prefs.ts
@@ -5,6 +5,7 @@ export const Coords = {
   Hidden: 0,
   Inside: 1,
   Outside: 2,
+  All: 3,
 };
 export type Coords = (typeof Coords)[keyof typeof Coords];
 

diff --git a/ui/learn/src/chessground.ts b/ui/learn/src/chessground.ts
@@ -1,6 +1,7 @@
 import { Config as CgConfig } from 'chessground/config';
 import { h, VNode } from 'snabbdom';
 import { RunCtrl } from './run/runCtrl';
+import * as Prefs from 'common/prefs';
 
 export interface Shape {
   orig: Key;
@@ -19,17 +20,18 @@ export default function (ctrl: RunCtrl): VNode {
       insert: vnode => {
         const el = vnode.elm as HTMLElement;
         el.addEventListener('contextmenu', e => e.preventDefault());
-        ctrl.setChessground(site.makeChessground(el, makeConfig()));
+        ctrl.setChessground(site.makeChessground(el, makeConfig(ctrl)));
       },
       destroy: () => ctrl.chessground!.destroy(),
     },
   });
 }
 
-const makeConfig = (): CgConfig => ({
+const makeConfig = (ctrl: RunCtrl): CgConfig => ({
   fen: '8/8/8/8/8/8/8/8',
   blockTouchScroll: true,
   coordinates: true,
+  coordinatesOnSquares: ctrl.pref.coords === Prefs.Coords.All,
   movable: { free: false, color: undefined },
   drawable: { enabled: false },
   draggable: { enabled: true },

diff --git a/ui/learn/src/learn.ts b/ui/learn/src/learn.ts
@@ -8,6 +8,7 @@ import {
 } from 'snabbdom';
 import { LearnCtrl } from './ctrl';
 import { view } from './view';
+import * as Prefs from 'common/prefs';
 
 import storage, { Storage } from './storage';
 
@@ -28,20 +29,27 @@ export interface LearnOpts {
   stageId: number | null;
   levelId: number | null;
   route?: string;
+  pref: LearnPrefs;
+}
+
+export interface LearnPrefs {
+  coords: Prefs.Coords;
 }
 
 interface LearnServerOpts {
   data?: LearnProgress;
   i18n: I18nDict;
+  pref: LearnPrefs;
 }
 
-export function initModule({ data, i18n }: LearnServerOpts) {
+export function initModule({ data, i18n, pref }: LearnServerOpts) {
   const _storage = storage(data);
   const opts: LearnOpts = {
     i18n,
     storage: _storage,
     stageId: null,
     levelId: null,
+    pref: pref,
   };
   const ctrl = new LearnCtrl(opts, redraw);
 

diff --git a/ui/learn/src/run/runCtrl.ts b/ui/learn/src/run/runCtrl.ts
@@ -73,6 +73,8 @@ export class RunCtrl {
     this.withGround(this.levelCtrl.initializeWithGround);
   };
 
+  pref = this.opts.pref;
+
   withGround: WithGround = f => (this.chessground ? f(this.chessground) : undefined);
 
   stageScore = () => {

diff --git a/ui/puz/src/view/chessground.ts b/ui/puz/src/view/chessground.ts
@@ -11,6 +11,7 @@ export function makeConfig(opts: CgConfig, pref: PuzPrefs, userMove: UserMove):
     check: opts.check,
     lastMove: opts.lastMove,
     coordinates: pref.coords !== Prefs.Coords.Hidden,
+    coordinatesOnSquares: pref.coords === Prefs.Coords.All,
     addPieceZIndex: pref.is3d,
     addDimensionsCssVarsTo: document.body,
     movable: {

diff --git a/ui/puzzle/src/view/chessground.ts b/ui/puzzle/src/view/chessground.ts
@@ -22,6 +22,7 @@ export function makeConfig(ctrl: PuzzleCtrl): CgConfig {
     check: opts.check,
     lastMove: opts.lastMove,
     coordinates: ctrl.pref.coords !== Prefs.Coords.Hidden,
+    coordinatesOnSquares: ctrl.pref.coords === Prefs.Coords.All,
     addPieceZIndex: ctrl.pref.is3d,
     addDimensionsCssVarsTo: document.body,
     movable: {

diff --git a/ui/round/src/ground.ts b/ui/round/src/ground.ts
@@ -21,6 +21,7 @@ export function makeConfig(ctrl: RoundController): Config {
     lastMove: uciToMove(step.uci),
     check: !!step.check,
     coordinates: data.pref.coords !== Prefs.Coords.Hidden,
+    coordinatesOnSquares: data.pref.coords === Prefs.Coords.All,
     addPieceZIndex: ctrl.data.pref.is3d,
     addDimensionsCssVarsTo: document.body,
     highlight: {