\n (boardAPI = api)\"\n @checkmate=\"handleCheckmate\"\n />\n \n\n```\n\n# Docs\nYou can find the full documentation [here](https://qwerty084.github.io/vue3-chessboard-docs/).\n\n## Setup:\n\n- Just install the package and import the component in your project, like shown above.\n- Don't forget to include the stylesheet: \n `import 'vue3-chessboard/style.css';`\n\n### Chessboard config\n\nYou can pass a config object to the chessboard component to modify the board to your needs, as a prop (:board-config). The config object is optional and will be merged with the [default config](https://github.com/qwerty084/vue3-chessboard/blob/main/src/helper/DefaultConfig.ts).\nThe default config is based on the [lichess board config](https://github.com/lichess-org/chessground/blob/master/src/state.ts).\nAdditionally custom callback functions can be passed to the component.\nFor example a custom function can be run on piece selection or after each move.\n\n### API\n\nThe chessboard component provides an API to interact with the chessboard. The API is accessible via the board-created event. The event will be emitted when the chessboard is created and ready to use.\n\n### Available methods:\n\nFor a full list of available methods please visit the [documentation](https://qwerty084.github.io/vue3-chessboard-docs/board-api.html).\n\n### Custom Events\n\nYou can listen for events on the chessboard component. The following events are available:\n\n- boardCreated - Emitted when the chessboard is created and the API is ready to use\n- checkmate - Emitted when a player is checkmated\n- stalemate - Emitted when a player is stalemated\n- draw - Emitted when the game is drawn\n- check - Emitted when a player is checked\n- promotion - Emitted when a player promotes\n- move - Emitted when a player makes a move\n\n```ts\nconst emit = defineEmits<{\n (e: 'boardCreated', boardApi: BoardApi): void;\n (e: 'checkmate', isMated: PieceColor): void;\n (e: 'stalemate'): void;\n (e: 'draw'): void;\n (e: 'check', isInCheck: PieceColor): void;\n (e: 'promotion', promotion: PromotionEvent): void;\n (e: 'move', move: MoveEvent): void;\n}>();\n```\n","readmeFilename":"README.md"}