react-chessboard-ui 1.0.0 → 1.1.1

package/README.md

@@ -1,35 +1,50 @@
-# react-chessboard-ui
+# react-chessboard-ui ♟️
 
-[![NPM](https://img.shields.io/npm/v/react-chessboard-ui.svg)](https://www.npmjs.com/package/react-chessboard-ui) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![NPM](https://img.shields.io/npm/v/react-chessboard-ui.svg)](https://www.npmjs.com/package/react-chessboard-ui)  
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-<img src="./blob/ChessBoard.png?raw=true" width="400px">
+A lightweight and customizable React chessboard component built with modern UI in mind. Easily integrate chess functionality into your React apps with FEN support, game-end detection, and position handling.
 
-## See full documentation on https://chessboardui.space
+<img src="./blob/ChessBoard.png?raw=true" width="400px" alt="react-chessboard-ui preview" />
 
+## 📘 **Full documentation**: [https://chessboardui.space/](https://chessboardui.space/)
 
-## Install
+---
+
+## 🚀 Features
+
+- 🎯 Fully controlled via FEN strings  
+- ♻️ React functional component with hooks support  
+- 🎨 Customizable styles (via CSS or override)  
+- ♟️ Game-end and move-change callbacks  
+- 🧩 Easy integration into any React project  
+
+---
+
+## 📦 Installation
+
+Install via npm:
 
 ```bash
 npm install react-chessboard-ui
 ```
 
-or
+Or using yarn:
 
 ```bash
 yarn add react-chessboard-ui
 ```
 
-## Usage example
+---
+
+## 💡 Usage Example
+
 ```tsx
 import React from 'react';
-import { ChessBoard } from 'react-chessboard-ui'; // ChessBoard is a base component of react-chessboard-ui
-
-import 'react-chessboard-ui/dist/index.css'; // required import css for ChessBoard
+import { ChessBoard } from 'react-chessboard-ui';
+import 'react-chessboard-ui/dist/index.css'; // Required CSS
 
 export const App = () => {
-
-  // ... all handlers
-
   return (
     <div>
       <ChessBoard 
@@ -39,11 +54,32 @@ export const App = () => {
       />
     </div>
   );
-}
+};
 ```
 
-## Creators
-Created by [in: Tanya](https://www.linkedin.com/in/tatiana-utbanova-6415b8271/) and [in: Alex](linkedin.com/in/alexander-utbanov-a9670a210/)
+## Full customizable
+<img src="./blob/customization.png?raw=true" width="400px" alt="react-chessboard-ui preview" />
+
+### 📘 **Documentation for customization**: [https://chessboardui.space/properties/config/](https://chessboardui.space/properties/config/)
+
+
+---
+
+## 👥 Authors
+
+Created by:
+
+- [Tatiana Utbanova](https://www.linkedin.com/in/tatiana-utbanova-6415b8271/) - Design owner
+- [Alexander Utbanov](https://linkedin.com/in/alexander-utbanov-a9670a210/) - Code owner
+
+---
+
+## 📄 License
+
+MIT © [react-chessboard-ui](https://github.com/)
+
+---
+
+## 🧠 Keywords (for discoverability)
 
-## License
-MIT © [](https://github.com/)
+`react` `chess` `chessboard` `react-chess` `chess ui` `react chess component` `fen` `chess game` `react board game`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-chessboard-ui",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "A customizable and interactive chessboard component for React applications. Easily integrate a fully functional and responsive chessboard into your React project with features like drag-and-drop pieces, move validation, and customizable board styles.",
   "author": "skilldill",
   "license": "MIT",
@@ -26,7 +26,7 @@
     "deploy": "gh-pages -d example/build"
   },
   "peerDependencies": {
-    "react": "^18.3.0"
+    "react": "^19.1.0"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^4.2.4",
@@ -34,8 +34,8 @@
     "@testing-library/user-event": "^7.2.1",
     "@types/jest": "^25.1.4",
     "@types/node": "^12.12.38",
-    "@types/react": "^18.3.0",
-    "@types/react-dom": "^18.3.0",
+    "@types/react": "^19.1.0",
+    "@types/react-dom": "^19.1.0",
     "@typescript-eslint/eslint-plugin": "^2.26.0",
     "@typescript-eslint/parser": "^2.26.0",
     "babel-eslint": "^10.0.3",
@@ -54,8 +54,8 @@
     "microbundle-crl": "^0.13.10",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.4",
-    "react": "^18.3.0",
-    "react-dom": "^18.3.0",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
     "react-scripts": "^3.4.1",
     "typescript": "^3.7.5"
   },

package/dist/ChessBoard/models.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="react" />
-import { CellPos, Figure, MoveData } from "../JSChessEngine";
-export interface ChessPiecesMap {
-    [key: string]: (size: string) => JSX.Element;
-}
-export declare type ChessBoardConfig = {
-    cellSize: number;
-    whiteCellColor: string;
-    blackCellColor: string;
-    selectedCellColor: string;
-    selectedCellBorder: string;
-    markedCellColor: string;
-    circleMarkColor: string;
-    arrowColor: string;
-    checkedCellColor: string;
-    piecesMap: ChessPiecesMap;
-};
-export declare type ChangeMove = {
-    move: MoveData;
-    withTransition?: boolean;
-    attackedPos?: CellPos;
-    transformTo?: Figure;
-};
-export declare type ArrowCoords = {
-    start: number[];
-    end: number[];
-};

package/dist/index.test.d.ts

@@ -1 +0,0 @@
-export {};