Skip to content

Quick start

About

vue3-chessboard is a component library for vue 3 written in TypeScript, using the lichess chessground and chess.js for the board logic.

Installation

bash
npm install vue3-chessboard
bash
yarn add vue3-chessboard
bash
pnpm install vue3-chessboard

Basic Example

vue
<script setup>
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
</script>

<template>
  <TheChessboard />
</template>
vue
<script setup lang="ts">
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
</script>

<template>
  <TheChessboard />
</template>