@wirelineio/shogiboardjsx/shogiboard.d.ts

Shogiboardjsx is a shogiboard for React. Inspired by Chessboardjsx

import { Component, CSSProperties } from 'react';
import { Square } from "chess.js"

type Piece =
  'wP' | 'wN' | 'wB' | 'wR' | 'wQ' | 'wK' |
  'bP' | 'bN' | 'bB' | 'bR' | 'bQ' | 'bK'
;

type Position = {
  [pos in Square]?: Piece
}

type CustomPieces = {
  [piece in Piece]?: (obj: {isDragging: boolean, squareWidth: number, droppedPiece: Piece, targetSquare: Square, sourceSquare: Square}) => JSX.Element
}

interface Props {
  allowDrag?: (obj: {piece: Piece, sourceSquare: Square}) => boolean,
  boardStyle?: CSSProperties,
  calcWidth?: (obj: {screenWidth: number, screenHeight: number}) => number,
  darkSquareStyle?: CSSProperties,
  draggable?: boolean,
  dropOffBoard?: 'snapback' | 'trash',
  dropSquareStyle?: CSSProperties,
  getPosition?: (currentPosition: Position) => void,
  id?: string | number,
  lightSquareStyle?: CSSProperties,
  onDragOverSquare?: (square: Square) => void,
  onDrop?: (obj: {sourceSquare: Square, targetSquare: Square, piece: Piece}) => void,
  onMouseOutSquare?: (square: Square) => void,
  onMouseOverSquare?: (square: Square) => void,
  onPieceClick?: (piece: Piece) => void,
  onSquareClick?: (square: Square) => void,
  onSquareRightClick?: (square: Square) => void,
  pieces?: CustomPieces,
  position?: string | Position,
  roughSquare?: (obj: {squareElement: SVGElement, squareWidth: number}) => void,
  showNotation?: boolean,
  sparePieces?: boolean,
  squareStyles?: {[square in Square]?: CSSProperties},
  transitionDuration?: number,
  width?: number,
  undo?: boolean,
}

export default class Shogiboard extends Component<Props> {
}