vue-chessground is a Vue Wrapper of the original Chessground UI developed for lichess.org. This project currently contains no chess logic, please visit chess.js for validation/generation.
This package is in very early stages of development, thus usage of this package in TypeScript is highly recommended.
Currently, the package has peerDependencies
on vue: ^3.2.26
.
# If you are using pnpm:
pnpm install vue-chessground
# If you are using npm:
npm install vue-chessground
# If you are using yarn:
yarn add vue-chessground
After installing, the component can be imported by name. It has 3 optional props:
size: string
defaults to 512px
, determines height and width of the chessboard in pixels
config: Partial<Config>
defaults to {}
, determines various configuration properties of Chessground
arrows: DrawShape[]
defaults to []
, determines if any arrows should be added to the board
Renders a simple 512 x 512
board, with pieces in their default position:
import { Chessboard } from 'vue-chessground';
// this style must be imported somewhere
import 'vue-chessground/chessboard.css';