wp_chessboard 0.0.7

A very customizable Chessboard with awesomeness already onboard.

WP_CHESSBOARD

A very customizable Chessboard with awesomeness already onboard:

👇️ Dragable Pieces

🎬️ Move Animations

🔄 Orientation

💡 Hints

💡 Arrows

⌨️ Keyboard Shortcuts

Features

👇️ Dragable Pieces

🎬️ Piece Animations for Single Moves

🎬️ Piece Animations for position changes/reset

🔄 Change Orientation

💡 Display Hints

💡 Display Arrows

⌨️ Keyboard Shortcuts

Opt in by passing shortcuts: ShortcutArgs(). The user types a file letter (a–h) to highlight a column, then a digit (1–8) to narrow to a single square, and confirms with space — which fires the same handlers a click would. Set commitMode: ShortcutCommitMode.auto to commit the moment the digit is typed (no space needed). A stray click clears any pending selection. The highlight widget is restyleable via highlightBuilder.

ShortcutArgs(
  commitMode: ShortcutCommitMode.space, // or .auto
  highlightBuilder: (size) => ShortcutHighlight(size: size, color: Colors.amber),
)

🎨 Per-square pieces

pieceBuilder draws a single piece in place of the pieceMap art, for example a piece that keeps a look of its own all game. Return null to draw the pieceMap art. The builder is told the square the piece came from in this state change, and the offset to it in the piece's own upright frame, so a returned widget can animate its own move: with ownsTravel: true the board places it on its square at once instead of sliding it, and draws it over the other pieces.

pieceBuilder: (args) {
  if (args.square.toString() != 'e2') return null;
  return SquarePiece(MyPiece(size: args.size, from: args.moved ? args.fromOffset : null), ownsTravel: true);
},

Usage

First import the WPChessboard widget.

import 'package:wp_chessboard/wp_chessboard.dart';

Then, you are ready to use it

You can use your own piece set, in the example we will use the chess_vectors_flutter package.

WPChessboard(
    size: size,
    orientation: orienatation,
    squareBuilder: squareBuilder,
    controller: controller,
    // Dont pass any onPieceDrop handler to disable drag and drop
    onPieceDrop: onPieceDrop,
    onPieceTap: onPieceTap,
    onPieceStartDrag: onPieceStartDrag,
    onEmptyFieldTap: onEmptyFieldTap,
    turnTopPlayerPieces: false,
    ghostOnDrag: true,
    dropIndicator: DropIndicatorArgs(
        size: size / 2,
        color: Colors.lightBlue.withOpacity(0.24)
    ),
    shortcuts: const ShortcutArgs(),
    pieceMap: PieceMap(
        K: (size) => WhiteKing(size: size),
        Q: (size) => WhiteQueen(size: size),
        B: (size) => WhiteBishop(size: size),
        N: (size) => WhiteKnight(size: size),
        R: (size) => WhiteRook(size: size),
        P: (size) => WhitePawn(size: size),
        k: (size) => BlackKing(size: size),
        q: (size) => BlackQueen(size: size),
        b: (size) => BlackBishop(size: size),
        n: (size) => BlackKnight(size: size),
        r: (size) => BlackRook(size: size),
        p: (size) => BlackPawn(size: size),
    ),
),

I know this is very short, for more information checkout the example :).

Web embedding (React / SolidJS)

The board can also be embedded in web apps by running the Flutter build (see web_example/build.sh) and loading it through a thin wrapper component. Two ready-to-use examples are included:

• react_example — React wrapper (size, fen).
• solid_example — SolidJS wrapper exposing the full state manager (size, fen, orientation, lightColor, darkColor, plus onFenChanged).

Additional information

Every contribution is very welcome.

Cheers 🥂