# [react-chessboard](https://react-chessboard.vercel.app/) ## The React Chessboard Library used at [ChessOpenings.co.uk](https://chessopenings.co.uk) ### Inspired and adapted from the unmaintained [chessboardjsx](https://github.com/willb335/chessboardjsx) [![Pull Requests][prs-badge]][prs] [![Version][version-badge]][version] [![MIT License][license-badge]][license]

What is react-chessboard?

react-chessboard is a React component that provides chessboard functionality to your application. The Chess game logic that controls the board should be independent to the board, using a library such as Chess.js. An example of these two working together is shown in the example below. For interactive examples visit https://react-chessboard.vercel.app/.

ChessOpenings.co.uk was originally built utilising the chessboardjsx library. With chessboardjsx being unmaintained, it made it difficult to add functionality or optimise performance, so react-chessboard was made.

Installation

npm i react-chessboard

Examples

Storybook

Features

Current

• Accessible Functions
  • chessboardRef.current.clearPremoves();, takes optional boolean parameter clearLastPieceColour to allow/disallow further premoves of the last moved piece color. Default: true
• Board Orientation Choice
• Custom Actions
  • getPositionObject
  • onArrowsChange
  • onDragOverSquare
  • onMouseOutSquare
  • onMouseOverSquare
  • onPieceClick
  • onPieceDragBegin
  • onPieceDragEnd
  • onPieceDrop
  • onPromotionCheck
  • onPromotionPieceSelect
  • onSquareClick
  • onSquareRightClick
• Customisable Board Styles
• Customisable Pieces
• Customisable Square Styles
• Customisable Notation Styles
• Drag and Drop
• Draw Arrows with Drag or Props
• Mobile Compatibility
• Moving Piece Animations
• Optional Square Coordinates Notation
• Position Control
• Premoves
• Promotion Piece Select
• Responsive Board Width
• TypeScript Support

Usage

Bare Minimum

import { Chessboard } from "react-chessboard";

export default function App() {
  return (
    <div>
      <Chessboard id="BasicBoard" />
    </div>
  );
}

Basic Example

IMPORTANT: Examples use the current stable release of chess.js. As of writing this, chess.js v1.0.0 is still in beta. These examples use chess.js ^0.12.0

import { useState } from "react";
import Chess from "chess.js";
import { Chessboard } from "react-chessboard";

export default function PlayRandomMoveEngine() {
  const [game, setGame] = useState(new Chess());

  function makeAMove(move) {
    const gameCopy = { ...game };
    const result = gameCopy.move(move);
    setGame(gameCopy);
    return result; // null if the move was illegal, the move object if the move was legal
  }

  function makeRandomMove() {
    const possibleMoves = game.moves();
    if (game.game_over() || game.in_draw() || possibleMoves.length === 0)
      return; // exit if the game is over
    const randomIndex = Math.floor(Math.random() * possibleMoves.length);
    makeAMove(possibleMoves[randomIndex]);
  }

  function onDrop(sourceSquare, targetSquare) {
    const move = makeAMove({
      from: sourceSquare,
      to: targetSquare,
      promotion: "q", // always promote to a queen for example simplicity
    });

    // illegal move
    if (move === null) return false;
    setTimeout(makeRandomMove, 200);
    return true;
  }

  return <Chessboard position={game.fen()} onPieceDrop={onDrop} />;
}

Advanced Examples

For more advanced code usage examples, please see example boards shown in Storybook.

Props

Contributing

1. Fork this repository
2. Clone your forked repository onto your development machine

   git clone https://github.com/yourUsernameHere/react-chessboard.git
   cd react-chessboard

3. Create a branch for your PR

   git checkout -b your-branch-name

4. Set upstream remote

   git remote add upstream https://github.com/Clariity/react-chessboard.git

5. Make your changes
6. Test your changes by running storybook

   npm run storybook

7. Push your changes

   git add .
   git commit -m "feature/cool-new-feature"
   git push --set-upstream origin your-branch-name

8. Create pull request on GitHub
9. Contribute again

   git checkout main
   git pull upstream main
   git checkout -b your-new-branch-name

LICENSE

MIT