react-chess-core 0.1.1 → 0.1.2
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.
- package/README.md +48 -46
- package/dist/features/chessboard/ChessboardDnDProvider.d.ts +5 -0
- package/dist/index.esm.js +1592 -3
- package/dist/index.js +1592 -3
- package/package.json +69 -65
- package/dist/features/training/expectedMoveDrop.test.d.ts +0 -1
package/README.md
CHANGED
|
@@ -1,46 +1,48 @@
|
|
|
1
|
-
# react-chess-core
|
|
2
|
-
|
|
3
|
-
```bash
|
|
4
|
-
npm install
|
|
5
|
-
npm run build
|
|
6
|
-
```
|
|
7
|
-
|
|
8
|
-
Shared **chessboard** (theme + `HighlightChessboard`) and **browser Stockfish** utilities. Used by `react-chess-puzzle-kit` and (planned) `react-chess-explorer`.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
1
|
+
# react-chess-core
|
|
2
|
+
|
|
3
|
+
```bash
|
|
4
|
+
npm install
|
|
5
|
+
npm run build
|
|
6
|
+
```
|
|
7
|
+
|
|
8
|
+
Shared **chessboard** (theme + `HighlightChessboard`) and **browser Stockfish** utilities. Used by `react-chess-puzzle-kit` and (planned) `react-chess-explorer`.
|
|
9
|
+
|
|
10
|
+
Used in production at [endchess.com](https://endchess.com).
|
|
11
|
+
|
|
12
|
+
Storybook: `npm run storybook` → http://localhost:6007
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Migration phases (Option B)
|
|
17
|
+
|
|
18
|
+
| Phase | Status | Work |
|
|
19
|
+
|-------|--------|------|
|
|
20
|
+
| **1** | Done | Scaffold package, Rollup, Storybook |
|
|
21
|
+
| **2** | Done | Board + engine source live in this repo |
|
|
22
|
+
| **3** | Done | `react-chess-puzzle-kit` depends on `file:../react-chess-core`, re-export for compatibility |
|
|
23
|
+
| **4** | Done | Remove duplicate shim files from puzzle-kit; slim public API (no core re-exports from puzzle-kit) |
|
|
24
|
+
| **5** | In progress | `react-chess-explorer` scaffold (core only); requirements → `docs/REQUIREMENTS.md` |
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Install (consumers)
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm install react-chess-core
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
**Peer dependencies:** `react`, `react-chessboard`, `chess.js`
|
|
35
|
+
|
|
36
|
+
For Stockfish in the browser:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install stockfish
|
|
40
|
+
npm run copy:stockfish # in your app, or copy WASM to public/stockfish/
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Exports
|
|
46
|
+
|
|
47
|
+
- **Chessboard:** `ThemeProvider`, `useChessboardTheme`, `HighlightChessboard`, `boardSquareHighlightColors`
|
|
48
|
+
- **Engine:** `useAnalysisEngine`, `StockfishBrowserEngine`, `EngineEvaluationPanel`, `isAnalyzableFen`, types/helpers
|
|
@@ -1,4 +1,9 @@
|
|
|
1
1
|
import type { ReactNode } from 'react';
|
|
2
|
+
/**
|
|
3
|
+
* HTML5 for mouse (desktop + Chrome device emulation), touch backend for real
|
|
4
|
+
* mobile devices. react-chessboard alone picks TouchBackend whenever
|
|
5
|
+
* `ontouchstart` is in window, which breaks mouse drags in DevTools emulation.
|
|
6
|
+
*/
|
|
2
7
|
export declare const ChessboardDnDProvider: ({ children, }: {
|
|
3
8
|
children: ReactNode;
|
|
4
9
|
}) => import("react").JSX.Element;
|