kokopu-react 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/.eslintrc.yml +1 -1
  2. package/CHANGELOG.md +6 -0
  3. package/dist/lib/chessboard/BoardProperties.js.map +1 -1
  4. package/dist/lib/chessboard/Chessboard.css +13 -13
  5. package/dist/lib/chessboard/Chessboard.js.map +1 -1
  6. package/dist/lib/chessboard/ChessboardImpl.js.map +1 -1
  7. package/dist/lib/chessboard/Draggable.js.map +1 -1
  8. package/dist/lib/chessboard/Motion.js.map +1 -1
  9. package/dist/lib/chessboard/colorsets.js.map +1 -1
  10. package/dist/lib/chessboard/piecesets.js.map +1 -1
  11. package/dist/lib/errorbox/ErrorBox.css +18 -18
  12. package/dist/lib/errorbox/ErrorBox.js.map +1 -1
  13. package/dist/lib/errorbox/parsing.js.map +1 -1
  14. package/dist/lib/exception.js.map +1 -1
  15. package/dist/lib/i18n.d.ts +1 -0
  16. package/dist/lib/i18n.js +1 -0
  17. package/dist/lib/i18n.js.map +1 -1
  18. package/dist/lib/icons/AnnotationSymbolShape.css +6 -6
  19. package/dist/lib/icons/AnnotationSymbolShape.js.map +1 -1
  20. package/dist/lib/icons/ArrowMarkerIcon.js.map +1 -1
  21. package/dist/lib/icons/ArrowTip.js.map +1 -1
  22. package/dist/lib/icons/ChessPieceIcon.js.map +1 -1
  23. package/dist/lib/icons/SquareMarkerIcon.js.map +1 -1
  24. package/dist/lib/icons/TextMarkerIcon.js.map +1 -1
  25. package/dist/lib/icons/arrow.css +1 -1
  26. package/dist/lib/index.d.ts +1 -0
  27. package/dist/lib/index.js +1 -0
  28. package/dist/lib/index.js.map +1 -1
  29. package/dist/lib/movetext/Movetext.css +27 -27
  30. package/dist/lib/movetext/Movetext.js.map +1 -1
  31. package/dist/lib/movetext/MovetextImpl.js.map +1 -1
  32. package/dist/lib/movetext/fonts.css +7 -7
  33. package/dist/lib/movetext/htmlFilter.js.map +1 -1
  34. package/dist/lib/movetext/moveFormatter.js.map +1 -1
  35. package/dist/lib/navigationboard/NavigationBoard.d.ts +39 -1
  36. package/dist/lib/navigationboard/NavigationBoard.js +94 -11
  37. package/dist/lib/navigationboard/NavigationBoard.js.map +1 -1
  38. package/dist/lib/navigationboard/NavigationButton.d.ts +54 -0
  39. package/dist/lib/navigationboard/NavigationButton.js +35 -0
  40. package/dist/lib/navigationboard/NavigationButton.js.map +1 -0
  41. package/dist/lib/navigationboard/NavigationField.css +7 -7
  42. package/dist/lib/navigationboard/NavigationField.js.map +1 -1
  43. package/dist/lib/navigationboard/NavigationToolbar.css +16 -13
  44. package/dist/lib/navigationboard/NavigationToolbar.d.ts +3 -10
  45. package/dist/lib/navigationboard/NavigationToolbar.js +31 -82
  46. package/dist/lib/navigationboard/NavigationToolbar.js.map +1 -1
  47. package/dist/lib/navigationboard/iconPaths.d.ts +29 -0
  48. package/dist/lib/navigationboard/iconPaths.js +91 -0
  49. package/dist/lib/navigationboard/iconPaths.js.map +1 -0
  50. package/dist/lib/sanitization.js.map +1 -1
  51. package/dist/lib/types.js.map +1 -1
  52. package/dist/lib/util.js.map +1 -1
  53. package/doc_src/demo/PageChessboardBase.tsx +115 -115
  54. package/doc_src/demo/PageChessboardInteraction.tsx +303 -303
  55. package/doc_src/demo/PageChessboardMove.tsx +173 -173
  56. package/doc_src/demo/PageChessboardSmallScreens.tsx +94 -94
  57. package/doc_src/demo/PageMovetextBase.tsx +180 -180
  58. package/doc_src/demo/PageMovetextInteraction.tsx +123 -123
  59. package/doc_src/demo/PageNavigationBoardBase.tsx +144 -137
  60. package/doc_src/demo/PageNavigationBoardUncontrolledVsControlled.tsx +69 -69
  61. package/doc_src/demo/decs.d.ts +4 -4
  62. package/doc_src/demo/demo.css +12 -12
  63. package/doc_src/demo/util.ts +1 -1
  64. package/doc_src/examples/NavigationBoard.md +1 -1
  65. package/doc_src/theming/LogoRenderer.js +13 -13
  66. package/doc_src/theming/theming.css +5 -5
  67. package/package.json +95 -95
  68. package/scripts/doc.styleguide.config.js +131 -131
  69. package/scripts/doc.tsconfig.json +5 -5
  70. package/scripts/docker-compose.yml +1 -1
  71. package/scripts/test-graphic.tsconfig.json +5 -5
  72. package/scripts/test-graphic.webpack.config.js +57 -57
  73. package/scripts/test-headless.webpack.config.js +29 -29
  74. package/src/chessboard/BoardProperties.ts +68 -68
  75. package/src/chessboard/Chessboard.css +13 -13
  76. package/src/chessboard/Chessboard.tsx +380 -380
  77. package/src/chessboard/ChessboardImpl.tsx +557 -557
  78. package/src/chessboard/Draggable.tsx +185 -185
  79. package/src/chessboard/Motion.tsx +67 -67
  80. package/src/chessboard/colorsets.ts +66 -66
  81. package/src/chessboard/piecesets.ts +84 -84
  82. package/src/decs.d.ts +2 -2
  83. package/src/errorbox/ErrorBox.css +18 -18
  84. package/src/errorbox/ErrorBox.tsx +75 -75
  85. package/src/errorbox/parsing.tsx +95 -95
  86. package/src/exception.ts +17 -17
  87. package/src/i18n.ts +1 -0
  88. package/src/icons/AnnotationSymbolShape.css +6 -6
  89. package/src/icons/AnnotationSymbolShape.tsx +31 -31
  90. package/src/icons/ArrowMarkerIcon.tsx +34 -34
  91. package/src/icons/ArrowTip.tsx +14 -14
  92. package/src/icons/ChessPieceIcon.tsx +45 -45
  93. package/src/icons/SquareMarkerIcon.tsx +20 -20
  94. package/src/icons/TextMarkerIcon.tsx +29 -29
  95. package/src/icons/arrow.css +1 -1
  96. package/src/index.ts +3 -2
  97. package/src/movetext/Movetext.css +27 -27
  98. package/src/movetext/Movetext.tsx +158 -158
  99. package/src/movetext/MovetextImpl.tsx +345 -345
  100. package/src/movetext/fonts.css +7 -7
  101. package/src/movetext/htmlFilter.tsx +129 -129
  102. package/src/movetext/moveFormatter.tsx +37 -37
  103. package/src/navigationboard/NavigationBoard.tsx +297 -178
  104. package/src/navigationboard/NavigationButton.ts +72 -0
  105. package/src/navigationboard/NavigationField.css +7 -7
  106. package/src/navigationboard/NavigationField.tsx +90 -90
  107. package/src/navigationboard/NavigationToolbar.css +16 -13
  108. package/src/navigationboard/NavigationToolbar.tsx +60 -117
  109. package/src/navigationboard/iconPaths.ts +98 -0
  110. package/src/sanitization.ts +17 -17
  111. package/src/types.ts +116 -116
  112. package/src/util.ts +11 -11
  113. package/test/01_types.js +167 -167
  114. package/test/02_chessboard_util.js +114 -114
  115. package/test/03_error_box_graphic.js +16 -16
  116. package/test/04_icons_graphic.js +32 -32
  117. package/test/05_chessboard_graphic.js +60 -60
  118. package/test/06_chessboard_animation.js +36 -36
  119. package/test/07_chessboard_interaction.js +101 -101
  120. package/test/08_chessboard_play_moves.js +62 -62
  121. package/test/09_chessboard_small_screens.js +32 -32
  122. package/test/10_movetext_graphic.js +32 -32
  123. package/test/11_movetext_interaction.js +100 -100
  124. package/test/12_navigation_board_base.js +151 -0
  125. package/test/13_navigation_board_graphic.js +68 -0
  126. package/test/14_navigation_board_autoplay.js +100 -0
  127. package/test/common/graphic.js +106 -97
  128. package/test/graphic_references/12_navigation_board_base/controlled/default.png +0 -0
  129. package/test/graphic_references/{12_navigation_board/controlled/forbidden_navigation_1.png → 12_navigation_board_base/controlled/forbidden_navigation_0.png} +0 -0
  130. package/test/graphic_references/{12_navigation_board/controlled/invalid_node_id.png → 12_navigation_board_base/controlled/forbidden_navigation_1.png} +0 -0
  131. package/test/graphic_references/{12_navigation_board/controlled/forbidden_navigation_0.png → 12_navigation_board_base/controlled/invalid_node_id.png} +0 -0
  132. package/test/graphic_references/12_navigation_board_base/controlled/no_callback_defined_0.png +0 -0
  133. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/controlled/no_callback_defined_1.png +0 -0
  134. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/controlled/overriding_initial_node_id.png +0 -0
  135. package/test/graphic_references/{12_navigation_board/controlled/regular_navigation_1.png → 12_navigation_board_base/controlled/regular_navigation_0.png} +0 -0
  136. package/test/graphic_references/{12_navigation_board/uncontrolled/initial_state_at_specific_id.png → 12_navigation_board_base/controlled/regular_navigation_1.png} +0 -0
  137. package/test/graphic_references/{12_navigation_board/controlled/regular_navigation_3.png → 12_navigation_board_base/controlled/regular_navigation_2.png} +0 -0
  138. package/test/graphic_references/{12_navigation_board/controlled/regular_navigation_0.png → 12_navigation_board_base/controlled/regular_navigation_3.png} +0 -0
  139. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_beginning_2.png → 12_navigation_board_base/uncontrolled/forbidden_navigation_at_beginning_0.png} +0 -0
  140. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_beginning_0.png → 12_navigation_board_base/uncontrolled/forbidden_navigation_at_beginning_1.png} +0 -0
  141. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_beginning_1.png → 12_navigation_board_base/uncontrolled/forbidden_navigation_at_beginning_2.png} +0 -0
  142. package/test/graphic_references/{12_navigation_board/controlled/no_callback_defined_0.png → 12_navigation_board_base/uncontrolled/forbidden_navigation_at_end_0.png} +0 -0
  143. package/test/graphic_references/12_navigation_board_base/uncontrolled/forbidden_navigation_at_end_1.png +0 -0
  144. package/test/graphic_references/12_navigation_board_base/uncontrolled/forbidden_navigation_at_end_2.png +0 -0
  145. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/initial_state_at_end.png +0 -0
  146. package/test/graphic_references/12_navigation_board_base/uncontrolled/initial_state_at_specific_id.png +0 -0
  147. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/initial_state_default.png +0 -0
  148. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/initial_state_default_with_game_index.png +0 -0
  149. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/initial_state_on_null-move.png +0 -0
  150. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/navigation_with_keys_0.png +0 -0
  151. package/test/graphic_references/12_navigation_board_base/uncontrolled/navigation_with_keys_1.png +0 -0
  152. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/navigation_with_keys_2.png +0 -0
  153. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/navigation_with_keys_3.png +0 -0
  154. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/navigation_with_keys_4.png +0 -0
  155. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_flipping_0.png +0 -0
  156. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_flipping_1.png +0 -0
  157. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_navigation_0.png +0 -0
  158. package/test/graphic_references/{12_navigation_board/controlled/default.png → 12_navigation_board_base/uncontrolled/regular_navigation_1.png} +0 -0
  159. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_navigation_2.png +0 -0
  160. package/test/graphic_references/12_navigation_board_base/uncontrolled/regular_navigation_3.png +0 -0
  161. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_navigation_4.png +0 -0
  162. package/test/graphic_references/{12_navigation_board → 12_navigation_board_base}/uncontrolled/regular_navigation_5.png +0 -0
  163. package/test/graphic_references/13_navigation_board_graphic/additional_buttons/error_1.png +0 -0
  164. package/test/graphic_references/13_navigation_board_graphic/additional_buttons/error_2.png +0 -0
  165. package/test/graphic_references/13_navigation_board_graphic/additional_buttons/multiple_buttons.png +0 -0
  166. package/test/graphic_references/{12_navigation_board/uncontrolled/regular_navigation_3.png → 13_navigation_board_graphic/additional_buttons/single_button.png} +0 -0
  167. package/test/graphic_references/{12_navigation_board → 13_navigation_board_graphic}/theme/custom_1.png +0 -0
  168. package/test/graphic_references/{12_navigation_board → 13_navigation_board_graphic}/theme/custom_2.png +0 -0
  169. package/test/graphic_references/{12_navigation_board → 13_navigation_board_graphic}/theme/large.png +0 -0
  170. package/test/graphic_references/13_navigation_board_graphic/theme/small.png +0 -0
  171. package/test/graphic_references/14_navigation_board_autoplay/controlled/after_1_move_acknowledging_is-playing_changes.png +0 -0
  172. package/test/graphic_references/14_navigation_board_autoplay/controlled/after_1_move_not_acknowledging_is-playing_changes.png +0 -0
  173. package/test/graphic_references/14_navigation_board_autoplay/controlled/after_2_moves_acknowledging_node_changes.png +0 -0
  174. package/test/graphic_references/14_navigation_board_autoplay/controlled/after_2_moves_not_acknowledging_node_changes.png +0 -0
  175. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_end_1.png → 14_navigation_board_autoplay/controlled/after_reaching_the_end.png} +0 -0
  176. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_end_2.png → 14_navigation_board_autoplay/controlled/already_at_the_end.png} +0 -0
  177. package/test/graphic_references/14_navigation_board_autoplay/controlled/initial_state_acknowledging_is-playing_changes.png +0 -0
  178. package/test/graphic_references/14_navigation_board_autoplay/controlled/initial_state_acknowledging_node_changes.png +0 -0
  179. package/test/graphic_references/{12_navigation_board/uncontrolled/forbidden_navigation_at_end_0.png → 14_navigation_board_autoplay/controlled/initial_state_at_the_end.png} +0 -0
  180. package/test/graphic_references/14_navigation_board_autoplay/controlled/initial_state_close_to_end.png +0 -0
  181. package/test/graphic_references/14_navigation_board_autoplay/controlled/initial_state_not_acknowledging_is-playing_changes.png +0 -0
  182. package/test/graphic_references/14_navigation_board_autoplay/controlled/initial_state_not_acknowledging_node_changes.png +0 -0
  183. package/test/graphic_references/14_navigation_board_autoplay/uncontrolled/after_2_moves_from_beginning_after_stop.png +0 -0
  184. package/test/graphic_references/14_navigation_board_autoplay/uncontrolled/after_2_moves_from_beginning_before_stop.png +0 -0
  185. package/test/graphic_references/14_navigation_board_autoplay/uncontrolled/after_reaching_the_end_after_stop.png +0 -0
  186. package/test/graphic_references/14_navigation_board_autoplay/uncontrolled/after_reaching_the_end_before_stop.png +0 -0
  187. package/test/graphic_references/14_navigation_board_autoplay/uncontrolled/initial_state_close_to_end.png +0 -0
  188. package/test/graphic_references/{12_navigation_board/uncontrolled/navigation_with_keys_1.png → 14_navigation_board_autoplay/uncontrolled/initial_state_default.png} +0 -0
  189. package/test/graphic_test_app/03_error_box_graphic/base.tsx +14 -14
  190. package/test/graphic_test_app/03_error_box_graphic/localization.tsx +1 -1
  191. package/test/graphic_test_app/04_icons_graphic/chess_piece.tsx +7 -7
  192. package/test/graphic_test_app/04_icons_graphic/marker.tsx +15 -15
  193. package/test/graphic_test_app/05_chessboard_graphic/annotations.tsx +7 -7
  194. package/test/graphic_test_app/05_chessboard_graphic/base.tsx +6 -6
  195. package/test/graphic_test_app/05_chessboard_graphic/chess_variants.tsx +7 -7
  196. package/test/graphic_test_app/05_chessboard_graphic/flipped.tsx +5 -5
  197. package/test/graphic_test_app/05_chessboard_graphic/move.tsx +12 -12
  198. package/test/graphic_test_app/05_chessboard_graphic/theme.tsx +12 -12
  199. package/test/graphic_test_app/06_chessboard_animation/base_1.tsx +6 -6
  200. package/test/graphic_test_app/06_chessboard_animation/base_2.tsx +6 -6
  201. package/test/graphic_test_app/06_chessboard_animation/base_3.tsx +6 -6
  202. package/test/graphic_test_app/06_chessboard_animation/on_redraw.tsx +16 -16
  203. package/test/graphic_test_app/07_chessboard_interaction/click_squares.tsx +5 -5
  204. package/test/graphic_test_app/07_chessboard_interaction/edit_arrows.tsx +4 -4
  205. package/test/graphic_test_app/07_chessboard_interaction/error.tsx +2 -2
  206. package/test/graphic_test_app/07_chessboard_interaction/move_pieces.tsx +5 -5
  207. package/test/graphic_test_app/08_chessboard_play_moves/base.tsx +8 -8
  208. package/test/graphic_test_app/08_chessboard_play_moves/promotions.tsx +4 -4
  209. package/test/graphic_test_app/09_chessboard_small_screens/base.tsx +9 -9
  210. package/test/graphic_test_app/09_chessboard_small_screens/top_bottom_components.tsx +9 -9
  211. package/test/graphic_test_app/10_movetext_graphic/base.tsx +4 -4
  212. package/test/graphic_test_app/10_movetext_graphic/error.tsx +6 -6
  213. package/test/graphic_test_app/10_movetext_graphic/format_move.tsx +1 -1
  214. package/test/graphic_test_app/10_movetext_graphic/html.tsx +5 -5
  215. package/test/graphic_test_app/10_movetext_graphic/options.tsx +10 -10
  216. package/test/graphic_test_app/11_movetext_interaction/error.tsx +1 -1
  217. package/test/graphic_test_app/11_movetext_interaction/select_moves.tsx +11 -11
  218. package/test/graphic_test_app/{12_navigation_board → 12_navigation_board_base}/controlled.tsx +5 -5
  219. package/test/graphic_test_app/{12_navigation_board → 12_navigation_board_base}/uncontrolled.tsx +7 -7
  220. package/test/graphic_test_app/13_navigation_board_graphic/additional_buttons.tsx +49 -0
  221. package/test/graphic_test_app/{12_navigation_board → 13_navigation_board_graphic}/error.tsx +2 -2
  222. package/test/graphic_test_app/{12_navigation_board → 13_navigation_board_graphic}/theme.tsx +4 -4
  223. package/test/graphic_test_app/14_navigation_board_autoplay/controlled.tsx +73 -0
  224. package/test/graphic_test_app/14_navigation_board_autoplay/uncontrolled.tsx +34 -0
  225. package/test/graphic_test_app/common/decs.d.ts +2 -2
  226. package/test/graphic_test_app/common/test_app.css +15 -15
  227. package/test/graphic_test_app/common/test_app.tsx +48 -48
  228. package/tsconfig.json +13 -13
  229. package/test/12_navigation_board.js +0 -168
  230. package/test/graphic_references/12_navigation_board/controlled/regular_navigation_2.png +0 -0
  231. package/test/graphic_references/12_navigation_board/theme/small.png +0 -0
  232. package/test/graphic_references/12_navigation_board/uncontrolled/regular_navigation_1.png +0 -0
  233. /package/test/graphic_references/{12_navigation_board → 13_navigation_board_graphic}/error/pgn_parsing_error.png +0 -0
  234. /package/test/graphic_references/{12_navigation_board → 13_navigation_board_graphic}/error/wrong_game_type.png +0 -0
@@ -30,11 +30,11 @@ import './NavigationField.css';
30
30
 
31
31
 
32
32
  interface NavigationFieldProps {
33
- onFirstPressed?: () => void;
34
- onPreviousPressed?: () => void;
35
- onNextPressed?: () => void;
36
- onLastPressed?: () => void;
37
- onExitPressed?: () => void;
33
+ onFirstPressed?: () => void;
34
+ onPreviousPressed?: () => void;
35
+ onNextPressed?: () => void;
36
+ onLastPressed?: () => void;
37
+ onExitPressed?: () => void;
38
38
  }
39
39
 
40
40
 
@@ -43,53 +43,53 @@ interface NavigationFieldProps {
43
43
  */
44
44
  export class NavigationField extends React.Component<NavigationFieldProps> {
45
45
 
46
- private focusFieldRef: React.RefObject<HTMLAnchorElement> = React.createRef();
47
-
48
- render() {
49
- return (
50
- <div className="kokopu-focusFieldContainer">
51
- <a className="kokopu-focusField" href="#" ref={this.focusFieldRef} onKeyDown={evt => this.handleKeyDown(evt)}></a>
52
- </div>
53
- );
54
- }
55
-
56
- private handleKeyDown(evt: React.KeyboardEvent<HTMLAnchorElement>) {
57
- /* eslint-disable no-unused-expressions */
58
- doHandleKeyDown(evt, 'Home', this.props.onFirstPressed) ||
59
- doHandleKeyDown(evt, 'ArrowLeft', this.props.onPreviousPressed) ||
60
- doHandleKeyDown(evt, 'ArrowRight', this.props.onNextPressed) ||
61
- doHandleKeyDown(evt, 'End', this.props.onLastPressed) ||
62
- doHandleKeyDown(evt, 'Escape', this.props.onExitPressed);
63
- /* eslint-enable */
64
- }
65
-
66
- /**
67
- * Set the focus to the component.
68
- */
69
- focus(): void {
70
- const target = this.focusFieldRef.current;
71
- // istanbul ignore else
72
- if (target) {
73
- target.focus();
74
- }
75
- }
46
+ private focusFieldRef: React.RefObject<HTMLAnchorElement> = React.createRef();
47
+
48
+ render() {
49
+ return (
50
+ <div className="kokopu-focusFieldContainer">
51
+ <a className="kokopu-focusField" href="#" ref={this.focusFieldRef} onKeyDown={evt => this.handleKeyDown(evt)}></a>
52
+ </div>
53
+ );
54
+ }
55
+
56
+ private handleKeyDown(evt: React.KeyboardEvent<HTMLAnchorElement>) {
57
+ /* eslint-disable no-unused-expressions */
58
+ doHandleKeyDown(evt, 'Home', this.props.onFirstPressed) ||
59
+ doHandleKeyDown(evt, 'ArrowLeft', this.props.onPreviousPressed) ||
60
+ doHandleKeyDown(evt, 'ArrowRight', this.props.onNextPressed) ||
61
+ doHandleKeyDown(evt, 'End', this.props.onLastPressed) ||
62
+ doHandleKeyDown(evt, 'Escape', this.props.onExitPressed);
63
+ /* eslint-enable */
64
+ }
65
+
66
+ /**
67
+ * Set the focus to the component.
68
+ */
69
+ focus(): void {
70
+ const target = this.focusFieldRef.current;
71
+ // istanbul ignore else
72
+ if (target) {
73
+ target.focus();
74
+ }
75
+ }
76
76
 
77
77
  }
78
78
 
79
79
 
80
80
  function doHandleKeyDown(evt: React.KeyboardEvent<HTMLAnchorElement>, targetKey: string, targetCallback: (() => void) | undefined) {
81
81
 
82
- // Skip if the pressed key does not match the target key.
83
- if (evt.key !== targetKey) {
84
- return false;
85
- }
86
-
87
- // Otherwise, invoke the callback.
88
- if (targetCallback) {
89
- evt.preventDefault();
90
- targetCallback();
91
- }
92
- return true;
82
+ // Skip if the pressed key does not match the target key.
83
+ if (evt.key !== targetKey) {
84
+ return false;
85
+ }
86
+
87
+ // Otherwise, invoke the callback.
88
+ if (targetCallback) {
89
+ evt.preventDefault();
90
+ targetCallback();
91
+ }
92
+ return true;
93
93
  }
94
94
 
95
95
 
@@ -102,10 +102,10 @@ function doHandleKeyDown(evt: React.KeyboardEvent<HTMLAnchorElement>, targetKey:
102
102
  * @public
103
103
  */
104
104
  export function firstNodeId(game: Game, selection: string): string | undefined {
105
- if (!game.findById(selection)) {
106
- return undefined;
107
- }
108
- return selection === 'start' ? undefined : 'start';
105
+ if (!game.findById(selection)) {
106
+ return undefined;
107
+ }
108
+ return selection === 'start' ? undefined : 'start';
109
109
  }
110
110
 
111
111
 
@@ -118,24 +118,24 @@ export function firstNodeId(game: Game, selection: string): string | undefined {
118
118
  * @public
119
119
  */
120
120
  export function previousNodeId(game: Game, selection: string): string | undefined {
121
- let currentNode = game.findById(selection);
122
- if (!currentNode) {
123
- return undefined;
124
- }
125
- if (currentNode instanceof Variation) {
126
- currentNode = currentNode.parentNode();
127
- if (!currentNode) {
128
- return undefined; // This case corresponds to the first variation being selected initially.
129
- }
130
- }
131
- while (currentNode) {
132
- const previousNode = currentNode.previous();
133
- if (previousNode) {
134
- return previousNode.id();
135
- }
136
- currentNode = currentNode.parentVariation().parentNode();
137
- }
138
- return 'start';
121
+ let currentNode = game.findById(selection);
122
+ if (!currentNode) {
123
+ return undefined;
124
+ }
125
+ if (currentNode instanceof Variation) {
126
+ currentNode = currentNode.parentNode();
127
+ if (!currentNode) {
128
+ return undefined; // This case corresponds to the first variation being selected initially.
129
+ }
130
+ }
131
+ while (currentNode) {
132
+ const previousNode = currentNode.previous();
133
+ if (previousNode) {
134
+ return previousNode.id();
135
+ }
136
+ currentNode = currentNode.parentVariation().parentNode();
137
+ }
138
+ return 'start';
139
139
  }
140
140
 
141
141
 
@@ -148,12 +148,12 @@ export function previousNodeId(game: Game, selection: string): string | undefine
148
148
  * @public
149
149
  */
150
150
  export function nextNodeId(game: Game, selection: string): string | undefined {
151
- const currentNode = game.findById(selection);
152
- if (!currentNode) {
153
- return undefined;
154
- }
155
- const nextNode = currentNode instanceof Variation ? currentNode.first() : currentNode.next();
156
- return nextNode ? nextNode.id() : undefined;
151
+ const currentNode = game.findById(selection);
152
+ if (!currentNode) {
153
+ return undefined;
154
+ }
155
+ const nextNode = currentNode instanceof Variation ? currentNode.first() : currentNode.next();
156
+ return nextNode ? nextNode.id() : undefined;
157
157
  }
158
158
 
159
159
 
@@ -166,20 +166,20 @@ export function nextNodeId(game: Game, selection: string): string | undefined {
166
166
  * @public
167
167
  */
168
168
  export function lastNodeId(game: Game, selection: string): string | undefined {
169
- let currentNode = game.findById(selection);
170
- if (!currentNode) {
171
- return undefined;
172
- }
173
- currentNode = currentNode instanceof Variation ? currentNode.first() : currentNode.next();
174
- if (!currentNode) { // Ensure that the input node is not already the last one.
175
- return undefined;
176
- }
177
- let currentNodeNotNull = currentNode;
178
- while (true) {
179
- const nextNode = currentNodeNotNull.next();
180
- if (!nextNode) {
181
- return currentNodeNotNull.id();
182
- }
183
- currentNodeNotNull = nextNode;
184
- }
169
+ let currentNode = game.findById(selection);
170
+ if (!currentNode) {
171
+ return undefined;
172
+ }
173
+ currentNode = currentNode instanceof Variation ? currentNode.first() : currentNode.next();
174
+ if (!currentNode) { // Ensure that the input node is not already the last one.
175
+ return undefined;
176
+ }
177
+ let currentNodeNotNull = currentNode;
178
+ while (true) {
179
+ const nextNode = currentNodeNotNull.next();
180
+ if (!nextNode) {
181
+ return currentNodeNotNull.id();
182
+ }
183
+ currentNodeNotNull = nextNode;
184
+ }
185
185
  }
@@ -23,29 +23,32 @@
23
23
 
24
24
 
25
25
  .kokopu-navigationBoard {
26
- display: flex;
27
- flex-direction: column;
28
- align-items: center;
26
+ display: flex;
27
+ flex-direction: column;
28
+ align-items: center;
29
29
  }
30
30
 
31
31
  .kokopu-navigationToolbar {
32
- line-height: 0px;
32
+ line-height: 0px;
33
33
  }
34
34
 
35
- .kokopu-navigationButton {
36
- display: inline-block;
37
- cursor: pointer;
35
+ .kokopu-enabledNavigationButton,
36
+ .kokopu-disabledNavigationButton {
37
+ display: inline-block;
38
38
  }
39
39
 
40
- .kokopu-navigationButton:hover {
41
- opacity: 0.6;
40
+ .kokopu-enabledNavigationButton {
41
+ cursor: pointer;
42
42
  }
43
43
 
44
- * + .kokopu-navigationButton {
45
- margin-left: 2px;
44
+ .kokopu-enabledNavigationButton:hover {
45
+ opacity: 0.6;
46
+ }
47
+
48
+ .kokopu-disabledNavigationButton {
49
+ opacity: 0.2;
46
50
  }
47
51
 
48
52
  .kokopu-navigationSpacer {
49
- display: inline-block;
50
- width: 10px;
53
+ display: inline-block;
51
54
  }
@@ -22,153 +22,96 @@
22
22
  * -------------------------------------------------------------------------- */
23
23
 
24
24
 
25
-
26
25
  import * as React from 'react';
27
26
 
28
- import { i18n } from '../i18n';
27
+ import { NavigationButton, NavigationButtonList } from './NavigationButton';
29
28
 
30
29
  import './NavigationToolbar.css';
31
30
 
32
- const THICKNESS = 2;
33
- const CHEVRON_SIZE = 7;
34
- const ARROW_SIZE = 5;
35
- const ARROW_LENGTH = 16;
36
-
37
31
 
38
32
  interface NavigationToolbarProps {
39
- flipButtonVisible: boolean;
40
- squareSize: number;
41
- onFirstClicked?: () => void;
42
- onPreviousClicked?: () => void;
43
- onNextClicked?: () => void;
44
- onLastClicked?: () => void;
45
- onFlipClicked?: () => void;
33
+ squareSize: number;
34
+ buttons: NavigationButtonList;
46
35
  }
47
36
 
48
37
 
49
38
  /**
50
39
  * Toolbar below the navigation board.
51
40
  */
52
- export class NavigationToolbar extends React.Component<NavigationToolbarProps> {
53
-
54
- render() {
55
- const buttonSize = computeButtonSize(this.props.squareSize);
56
- const marginTop = Math.round(buttonSize / 4);
57
- return (
58
- <div className="kokopu-navigationToolbar" style={{ marginTop: marginTop }}>
59
- <NavigationButton size={buttonSize} tooltip={i18n.TOOLTIP_GO_FIRST} path={chevronPath(14, 16, -1) + ' ' + chevronPath(10, 16, -1)}
60
- onClick={this.props.onFirstClicked} />
61
- <NavigationButton size={buttonSize} tooltip={i18n.TOOLTIP_GO_PREVIOUS} path={chevronPath(12, 16, -1)}
62
- onClick={this.props.onPreviousClicked} />
63
- <NavigationButton size={buttonSize} tooltip={i18n.TOOLTIP_GO_NEXT} path={chevronPath(20, 16, 1)}
64
- onClick={this.props.onNextClicked} />
65
- <NavigationButton size={buttonSize} tooltip={i18n.TOOLTIP_GO_LAST} path={chevronPath(18, 16, 1) + ' ' + chevronPath(22, 16, 1)}
66
- onClick={this.props.onLastClicked} />
67
- {this.renderFlipButton(buttonSize)}
68
- </div>
69
- );
70
- }
71
-
72
- private renderFlipButton(buttonSize: number) {
73
- if (!this.props.flipButtonVisible) {
74
- return undefined;
75
- }
76
- return (<>
77
- <div className="kokopu-navigationSpacer" />
78
- <NavigationButton size={buttonSize} tooltip={i18n.TOOLTIP_FLIP} path={arrowPath(11, 25, 1) + ' ' + arrowPath(21, 7, -1)}
79
- onClick={this.props.onFlipClicked} />
80
- </>);
81
- }
82
-
41
+ export function NavigationToolbar({ squareSize, buttons }: NavigationToolbarProps) {
42
+
43
+ const buttonSize = computeButtonSize(squareSize);
44
+ const spacerSize = computeSpacerSize(squareSize);
45
+ const buttonNodes: React.ReactNode[] = [];
46
+
47
+ let atLeastOneButtonEncountered = false;
48
+ for (let i = 0; i < buttons.length; ++i) {
49
+
50
+ const button = buttons[i];
51
+
52
+ // Skip the spacers.
53
+ if (button === 'spacer') {
54
+ continue;
55
+ }
56
+
57
+ // Enqueue a spacer if necessary.
58
+ // Remark: consecutive spacers are collapsed into a single one for rendering, and spacers at the begin and end of the button list are not rendered.
59
+ if (atLeastOneButtonEncountered && buttons[i - 1] === 'spacer') {
60
+ buttonNodes.push(<div key={buttonNodes.length} className="kokopu-navigationSpacer" style={{ width: spacerSize }} />);
61
+ }
62
+ atLeastOneButtonEncountered = true;
63
+
64
+ // Enqueue the button node.
65
+ buttonNodes.push(<NavigationButtonImpl
66
+ key={buttonNodes.length}
67
+ tooltip={button.tooltip} iconPath={button.iconPath} enabled={button.enabled} onClick={button.onClick}
68
+ size={buttonSize}
69
+ spaceOnLeft={i === 0 || buttons[i - 1] === 'spacer'}
70
+ spaceOnRight={i === buttons.length - 1 || buttons[i + 1] === 'spacer'}
71
+ />);
72
+ }
73
+
74
+ return <div className="kokopu-navigationToolbar" style={{ marginTop: Math.round(buttonSize / 4) }}>{buttonNodes}</div>;
83
75
  }
84
76
 
85
77
 
86
- interface NavigationButtonProps {
87
- size: number;
88
- tooltip: string;
89
- path: string;
90
- onClick?: () => void;
78
+ interface NavigationButtonImplProps extends NavigationButton {
79
+ size: number;
80
+ spaceOnLeft: boolean;
81
+ spaceOnRight: boolean;
91
82
  }
92
83
 
93
84
 
94
85
  /**
95
86
  * Button for the navigation toolbar.
96
87
  */
97
- function NavigationButton({ size, tooltip, path, onClick }: NavigationButtonProps) {
98
- return (
99
- <div className="kokopu-navigationButton" title={tooltip} onClick={onClick}>
100
- <svg viewBox="0 0 32 32" width={size} height={size}>
101
- <path d={`M 16 0 A 16 16 0 0 0 16 32 A 16 16 0 0 0 16 0 Z ${path}`} fill="currentcolor" />
102
- </svg>
103
- </div>
104
- );
105
- }
106
-
107
-
108
- /**
109
- * * C
110
- * / \
111
- * B * \
112
- * \ \
113
- * \ \
114
- * A * * D
115
- * / /
116
- * / /
117
- * F * /
118
- * \ /
119
- * * E
120
- *
121
- * (x,y) = middle of [AD]
122
- */
123
- function chevronPath(x: number, y: number, direction: 1 | -1) {
124
- const xA = x - direction * THICKNESS * Math.sqrt(2) / 2;
125
- const xB = x - direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
126
- const xC = x - direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
127
- const xD = x + direction * THICKNESS * Math.sqrt(2) / 2;
128
- const yB = y - direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
129
- const yC = y - direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
130
- const yE = y + direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
131
- const yF = y + direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
132
- return `M ${xA} ${y} L ${xB} ${yB} L ${xC} ${yC} L ${xD} ${y} L ${xC} ${yE} L ${xB} ${yF} Z`;
88
+ function NavigationButtonImpl({ size, spaceOnLeft, spaceOnRight, iconPath, tooltip, enabled, onClick }: NavigationButtonImplProps) {
89
+ const leftBoundary = spaceOnLeft ? 'A 16 16 0 0 0 16 32' : 'L 1 0 L 1 32 L 16 32';
90
+ const rightBoundary = spaceOnRight ? 'A 16 16 0 0 0 16 0' : 'L 31 32 L 31 0 L 16 0';
91
+ const actuallyEnabled = enabled ?? true;
92
+ return (
93
+ <div className={actuallyEnabled ? 'kokopu-enabledNavigationButton' : 'kokopu-disabledNavigationButton'} title={tooltip}
94
+ onClick={actuallyEnabled ? onClick : undefined}
95
+ >
96
+ <svg viewBox="0 0 32 32" width={size} height={size}>
97
+ <path d={`M 16 0 ${leftBoundary} ${rightBoundary} Z ${iconPath}`} fill="currentcolor" />
98
+ </svg>
99
+ </div>
100
+ );
133
101
  }
134
102
 
135
103
 
136
104
  /**
137
- * D +---+ E
138
- * | |
139
- * | |
140
- * | |
141
- * B * | | * G
142
- * / \ | | / \
143
- * A * \| |/ * H
144
- * \ * * /
145
- * \ C F /
146
- * \ O /
147
- * \ * /
148
- * \ /
149
- * \ /
150
- * *
151
- * (x,y)
105
+ * Return the height/width of the buttons assuming the given square size.
152
106
  */
153
- function arrowPath(x: number, y: number, direction: 1 | -1) {
154
- const xA = x - direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
155
- const xB = x - direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
156
- const xC = x - direction * THICKNESS / 2;
157
- const xF = x + direction * THICKNESS / 2;
158
- const xG = x + direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
159
- const xH = x + direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
160
- const y0 = y - direction * THICKNESS * Math.sqrt(2) / 2;
161
- const yA = y0 - direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
162
- const yB = y0 - direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
163
- const yC = yB + (xC - xB);
164
- const yD = y - direction * ARROW_LENGTH;
165
- return `M ${x} ${y} L ${xA} ${yA} L ${xB} ${yB} L ${xC} ${yC} V ${yD} H ${xF} V ${yC} L ${xG} ${yB} L ${xH} ${yA} Z`;
107
+ function computeButtonSize(squareSize: number) {
108
+ return Math.round((squareSize * 2 + 116) / 7);
166
109
  }
167
110
 
168
111
 
169
112
  /**
170
- * Return the height/width of the buttons assuming the given square size.
113
+ * Return the width of the spacer between button groups, assuming the given square size.
171
114
  */
172
- function computeButtonSize(squareSize: number) {
173
- return Math.round((squareSize * 2 + 116) / 7);
115
+ function computeSpacerSize(squareSize: number) {
116
+ return Math.round((squareSize * 2 + 116) / 14);
174
117
  }
@@ -0,0 +1,98 @@
1
+ /*!
2
+ * -------------------------------------------------------------------------- *
3
+ * *
4
+ * Kokopu-React - A React-based library of chess-related components. *
5
+ * <https://www.npmjs.com/package/kokopu-react> *
6
+ * Copyright (C) 2021-2024 Yoann Le Montagner <yo35 -at- melix.net> *
7
+ * *
8
+ * Kokopu-React is free software: you can redistribute it and/or *
9
+ * modify it under the terms of the GNU Lesser General Public License *
10
+ * as published by the Free Software Foundation, either version 3 of *
11
+ * the License, or (at your option) any later version. *
12
+ * *
13
+ * Kokopu-React is distributed in the hope that it will be useful, *
14
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16
+ * GNU Lesser General Public License for more details. *
17
+ * *
18
+ * You should have received a copy of the GNU Lesser General *
19
+ * Public License along with this program. If not, see *
20
+ * <http://www.gnu.org/licenses/>. *
21
+ * *
22
+ * -------------------------------------------------------------------------- */
23
+
24
+
25
+ const THICKNESS = 2;
26
+ const CHEVRON_SIZE = 7;
27
+ const ARROW_SIZE = 5;
28
+ const ARROW_LENGTH = 16;
29
+
30
+
31
+ /**
32
+ * * C
33
+ * / \
34
+ * B * \
35
+ * \ \
36
+ * \ \
37
+ * A * * D
38
+ * / /
39
+ * / /
40
+ * F * /
41
+ * \ /
42
+ * * E
43
+ *
44
+ * (x,y) = middle of [AD]
45
+ */
46
+ function chevronPath(x: number, y: number, direction: 1 | -1) {
47
+ const xA = x - direction * THICKNESS * Math.sqrt(2) / 2;
48
+ const xB = x - direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
49
+ const xC = x - direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
50
+ const xD = x + direction * THICKNESS * Math.sqrt(2) / 2;
51
+ const yB = y - direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
52
+ const yC = y - direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
53
+ const yE = y + direction * (CHEVRON_SIZE + THICKNESS / Math.sqrt(2) / 2);
54
+ const yF = y + direction * (CHEVRON_SIZE - THICKNESS / Math.sqrt(2) / 2);
55
+ return `M ${xA} ${y} L ${xB} ${yB} L ${xC} ${yC} L ${xD} ${y} L ${xC} ${yE} L ${xB} ${yF} Z`;
56
+ }
57
+
58
+
59
+ /**
60
+ * D +---+ E
61
+ * | |
62
+ * | |
63
+ * | |
64
+ * B * | | * G
65
+ * / \ | | / \
66
+ * A * \| |/ * H
67
+ * \ * * /
68
+ * \ C F /
69
+ * \ O /
70
+ * \ * /
71
+ * \ /
72
+ * \ /
73
+ * *
74
+ * (x,y)
75
+ */
76
+ function arrowPath(x: number, y: number, direction: 1 | -1) {
77
+ const xA = x - direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
78
+ const xB = x - direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
79
+ const xC = x - direction * THICKNESS / 2;
80
+ const xF = x + direction * THICKNESS / 2;
81
+ const xG = x + direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
82
+ const xH = x + direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
83
+ const y0 = y - direction * THICKNESS * Math.sqrt(2) / 2;
84
+ const yA = y0 - direction * (ARROW_SIZE - THICKNESS / Math.sqrt(2) / 2);
85
+ const yB = y0 - direction * (ARROW_SIZE + THICKNESS / Math.sqrt(2) / 2);
86
+ const yC = yB + (xC - xB);
87
+ const yD = y - direction * ARROW_LENGTH;
88
+ return `M ${x} ${y} L ${xA} ${yA} L ${xB} ${yB} L ${xC} ${yC} V ${yD} H ${xF} V ${yC} L ${xG} ${yB} L ${xH} ${yA} Z`;
89
+ }
90
+
91
+
92
+ export const GO_FIRST_ICON_PATH = chevronPath(14, 16, -1) + ' ' + chevronPath(10, 16, -1);
93
+ export const GO_PREVIOUS_ICON_PATH = chevronPath(12, 16, -1);
94
+ export const GO_NEXT_ICON_PATH = chevronPath(20, 16, 1);
95
+ export const GO_LAST_ICON_PATH = chevronPath(18, 16, 1) + ' ' + chevronPath(22, 16, 1);
96
+ export const PLAY_ICON_PATH = 'M 23 16 L 12 23 V 9 Z';
97
+ export const STOP_ICON_PATH = 'M 11 11 H 21 V 21 H 11 Z';
98
+ export const FLIP_ICON_PATH = arrowPath(11, 25, 1) + ' ' + arrowPath(21, 7, -1);
@@ -26,41 +26,41 @@ import { IllegalArgument } from './exception';
26
26
 
27
27
 
28
28
  export function sanitizeString(input: string): string {
29
- return String(input);
29
+ return String(input);
30
30
  }
31
31
 
32
32
 
33
33
  export function sanitizeBoolean(input: boolean): boolean {
34
- return Boolean(input);
34
+ return Boolean(input);
35
35
  }
36
36
 
37
37
 
38
38
  export function sanitizePartialObject<T>(input: Partial<T> | undefined, exceptionBuilder: () => IllegalArgument): Partial<T> {
39
- if (input === undefined || input === null) {
40
- return {};
41
- }
42
- else if (typeof input !== 'object') {
43
- throw exceptionBuilder();
44
- }
45
- else {
46
- return input;
47
- }
39
+ if (input === undefined || input === null) {
40
+ return {};
41
+ }
42
+ else if (typeof input !== 'object') {
43
+ throw exceptionBuilder();
44
+ }
45
+ else {
46
+ return input;
47
+ }
48
48
  }
49
49
 
50
50
 
51
51
  export function sanitizeInteger(input: number, exceptionBuilder: () => IllegalArgument): number {
52
- if (typeof input !== 'number' || !Number.isFinite(input)) {
53
- throw exceptionBuilder();
54
- }
55
- return Math.round(input);
52
+ if (typeof input !== 'number' || !Number.isFinite(input)) {
53
+ throw exceptionBuilder();
54
+ }
55
+ return Math.round(input);
56
56
  }
57
57
 
58
58
 
59
59
  export function sanitizeBoundedInteger(input: number, min: number, max: number, exceptionBuilder: () => IllegalArgument) {
60
- return Math.min(Math.max(sanitizeInteger(input, exceptionBuilder), min), max);
60
+ return Math.min(Math.max(sanitizeInteger(input, exceptionBuilder), min), max);
61
61
  }
62
62
 
63
63
 
64
64
  export function sanitizeOptional<T>(input: T | undefined, sanitizationFunction: (val: T) => T): T | undefined {
65
- return input === undefined || input === null ? undefined : sanitizationFunction(input);
65
+ return input === undefined || input === null ? undefined : sanitizationFunction(input);
66
66
  }