Skip to content

Commit

Permalink
Merge pull request #237 from qwerty084/v1.3.0
Browse files Browse the repository at this point in the history
v1.3.0
  • Loading branch information
qwerty084 authored Dec 10, 2023
2 parents b633e53 + 4a9a8dc commit c959ad6
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
19 changes: 17 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
## v1.3.0 (2023-12-10)

### Breaking changes

- `vue3-chessboard/style.css` has been removed. Please remove the import from existing projects.

### Bug fixes

- fix putPiece with movable set to free from jumping back to previous position ([#236](https://github.com/qwerty084/vue3-chessboard/pull/236))
- fixed promotion dialog with multiple board instances ([#233](https://github.com/qwerty084/vue3-chessboard/pull/233))

### Other

- documentation has been removed from the main repo and moved to [vue3-chessboard-docs](https://github.com/qwerty084/vue3-chessboard-docs) ([#235](https://github.com/qwerty084/vue3-chessboard/pull/235))

## v1.2.4 (2023-10-16)

### Features
Expand Down Expand Up @@ -30,9 +45,9 @@

### Features

- `reactive-config` - the board config object can now be made reactive ([#190](https://github.com/qwerty084/vue3-chessboard/pull/190)) @[gavin-lb](https://github.com/gavin-lb). Please visit the [documentation](https://qwerty084.github.io/vue3-chessboard/props.html#reactive-config-using-a-reactive-config-object) for
- `reactive-config` - the board config object can now be made reactive ([#190](https://github.com/qwerty084/vue3-chessboard/pull/190)) @[gavin-lb](https://github.com/gavin-lb). Please visit the [documentation](https://qwerty084.github.io/vue3-chessboard-docs/props.html#reactive-config-using-a-reactive-config-object) for
more information.
- `history-viewer` - the board component now contains a history viewer ([#200](https://github.com/qwerty084/vue3-chessboard/pull/200)) @[gavin-lb](https://github.com/gavin-lb). Please visit the [documentation](https://qwerty084.github.io/vue3-chessboard/board-api.html#example-game-history-viewer-usage) for
- `history-viewer` - the board component now contains a history viewer ([#200](https://github.com/qwerty084/vue3-chessboard/pull/200)) @[gavin-lb](https://github.com/gavin-lb). Please visit the [documentation](https://qwerty084.github.io/vue3-chessboard-docs/board-api.html#example-game-history-viewer-usage) for
more information.

### Other
Expand Down
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ vue3-chesssboard is a component library for vue 3 built with [lichess chessgroun

![Chessboard](https://media3.giphy.com/media/cWw6eHQ7AmjDXbWm6w/giphy.gif?cid=790b7611cce1bb251c4ae6a786ea4dc8be97b1563f59d989&rid=giphy.gif&ct=g)

You can find a demo and the full library documentation [here](https://qwerty084.github.io/vue3-chessboard/).
You can find a demo and the full library documentation [here](https://qwerty084.github.io/vue3-chessboard-docs/).

## Table of contents

Expand Down Expand Up @@ -38,7 +38,6 @@ Basic Example (Composition API)
```html
<script setup>
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
</script>

<template>
Expand All @@ -55,7 +54,6 @@ Basic Example (Options API)

<script>
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
export default {
components: {
Expand All @@ -72,7 +70,6 @@ Example Typescript Component
```html
<script setup lang="ts">
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
import type { BoardApi, BoardConfig } from 'vue3-chessboard';
let boardAPI: BoardApi;
Expand Down Expand Up @@ -113,7 +110,6 @@ Example Javascript Component
```html
<script setup>
import { TheChessboard } from 'vue3-chessboard';
import 'vue3-chessboard/style.css';
let boardAPI;
const boardConfig = {
Expand Down Expand Up @@ -149,13 +145,11 @@ function handleCheckmate(isMated) {
```

# Docs
You can find the full documentation [here](https://qwerty084.github.io/vue3-chessboard/).
You can find the full documentation [here](https://qwerty084.github.io/vue3-chessboard-docs/).

## Setup:

- Just install the package and import the component in your project, like shown above.
- Don't forget to include the stylesheet: <br>
`import 'vue3-chessboard/style.css';`

### Chessboard config

Expand All @@ -170,7 +164,7 @@ The chessboard component provides a class based API to interact with the chessbo

### Available methods:

For a full list of available methods please visit the [documentation](https://qwerty084.github.io/vue3-chessboard/board-api.html).
For a full list of available methods please visit the [documentation](https://qwerty084.github.io/vue3-chessboard-docs/board-api.html/board-api.html).

### Custom Events

Expand Down
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "vue3-chessboard",
"version": "1.2.4",
"version": "1.3.0",
"description": "vue3-chessboard is a component library for creating chess web apps with vue3",
"homepage": "https://qwerty084.github.io/vue3-chessboard/",
"homepage": "https://qwerty084.github.io/vue3-chessboard-docs/",
"keywords": [
"vue",
"chessboard",
Expand All @@ -23,8 +23,7 @@
"import": "./dist/vue3-chessboard.js",
"require": "./dist/vue3-chessboard.cjs",
"types": "./dist/src/index.d.ts"
},
"./style.css": "./dist/style.css"
}
},
"types": "./dist/src/index.d.ts",
"repository": {
Expand Down

0 comments on commit c959ad6

Please sign in to comment.