Welcome to React Chess Analysis Board!
React Chess Analysis Board provides a React component you can drop into your React app to render an analysis board of any PGN string.
You can fully customize the style of this analysis board.
Install the library
npm install react-chess-analysis-board
yarn add react-chess-analysis-board
Use the component
import ChessAnalysisBoard from 'react-chess-analysis-board' return ( <ChessAnalysisBoard pgnString='[Event "Berlin"] [Site "Berlin GER"] [Date "1852.??.??"] [EventDate "?"] [Round "?"] [Result "1-0"] [White "Adolf Anderssen"] [Black "Jean Dufresne"] [ECO "C52"] [WhiteElo "?"] [BlackElo "?"] [PlyCount "47"] 1.e4 e5 2.Nf3 Nc6 3.Bc4 Bc5 4.b4 Bxb4 5.c3 Ba5 6.d4 exd4 7.O-O d3 8.Qb3 Qf6 9.e5 Qg6 10.Re1 Nge7 11.Ba3 b5 12.Qxb5 Rb8 13.Qa4 Bb6 14.Nbd2 Bb7 15.Ne4 Qf5 16.Bxd3 Qh5 17.Nf6+ gxf6 18.exf6 Rg8 19.Rad1 Qxf3 20.Rxe7+ Nxe7 21.Qxd7+ Kxd7 22.Bf5+ Ke8 23.Bd7+ Kf8 24.Bxe7# 1-0' /> )
React Chess Analysis Board accepts the following props:
pgnString[string | required]: any valid PGN
config[object | optional]: an object for various components
boardConfig[object | optional]: an object for configs related to the board
fen[string | optional]: a fen string to indicate the initial position of the board for analysis
ChessBoardProps[object | optional]: props that are passed directly to React-Chessboard, used for styling the board.
getCurrentPosition[function | optional]: calls your callback function, passing a
currentPositionobject as a parameter, which can be used to construct another analysis board you are keeping in sync with this one.
currentPosition** [object | optional]**: sets the entire state of the analysis board. Used, for example, if keeping two analysis boards in sync with one another. You should directly pass the object from a
getCurrentPositioncall from another analysis board you are keeping in sync with this one.
React-chess-analysis-board looks for
RCAB- prefixed classNames you can use in your source code. If you create css classes with any of the classNames found in
src/lib/style.css and make them available to the ChessAnalysisBoard component, they will be applied. We recommend copying
src/lib/styles.css into your own css file, and then iterating on the styling from there.
- Full React Analysis Board component
- Subcomponents can be accessed individually (BoardHeader, Board, Panel, and Moves)
- Managed state for unlimited branches of analysis
- Traverse state with panel buttons or arrow keys
- Create an alternative branch by exploring new moves
- Access any board state on any branch by clicking on the move
- PGN-viewer functionality
- Style with your own css classes
- Ability to show chess engine notation from a connected engine
- Stronger control over styles and layout, especially around
- Handling pawn promotion in side lines outside the root PGN (planned inclusion in react-chessboard) and will then be handled in this library
- Use your judgement — if it’s an obvious need or a bugfix, feel free to open a PR directly.
- If it materially changes the experience of using the library, is a major new feature, or is something you think someone else might already be working on, please open an issue for discussion before contributing, or confirm that you’re working on it within the discussion on an existing issue.
- Unsure what to contribute? Check out the existing issues for inspiration.
Opening a PR
- Fork this repository
- Clone your forked repository onto your development machine
git clone https://github.com/yourUsernameHere/react-chess-analysis-board.git
- Create a branch for your PR
git checkout -b your-branch-name
- Set upstream remote
git remote add upstream https://github.com/ps2-controller/react-chess-analysis-board.git
- Make your changes — the
libfolder contains the library with
index.tsxas the entry point, and
App.tsximports and uses the library to make local development easy. Use
npm run devto run
App.tsxin your browser.
- Push your changes
git add .
git commit -m "feature/cool-new-feature"
git push --set-upstream origin your-branch-name
- Create pull request on GitHub
- Contribute again
git checkout main
git pull upstream main
git checkout -b your-new-branch-name
- Note: There’s one additional undocumented easter egg config for fans of Agadmator chess channel in this library. Can you find it? 😉