NeoChessProps

neo-chess-board

---

Defined in: src/react/NeoChessBoard.tsx:185

Extends

• Omit\<BoardOptions, "fen" | "position" | "rulesAdapter" | "squareRenderer" | "pieces" | "boardStyle">

Properties

allowAutoScroll?

optional allowAutoScroll: boolean

Defined in: src/core/types.ts:487

Inherited from

BoardOptions.allowAutoScroll

---

allowDragging?

optional allowDragging: boolean

Defined in: src/core/types.ts:488

Inherited from

BoardOptions.allowDragging

---

allowDragOffBoard?

optional allowDragOffBoard: boolean

Defined in: src/core/types.ts:489

Inherited from

BoardOptions.allowDragOffBoard

---

allowDrawingArrows?

optional allowDrawingArrows: boolean

Defined in: src/core/types.ts:512

Inherited from

BoardOptions.allowDrawingArrows

---

allowPremoves?

optional allowPremoves: boolean

Defined in: src/core/types.ts:496

Inherited from

BoardOptions.allowPremoves

---

alphaNotationStyle?

optional alphaNotationStyle: NotationStyleOptions

Defined in: src/core/types.ts:525

Inherited from

BoardOptions.alphaNotationStyle

---

animation?

optional animation: BoardAnimationConfig

Defined in: src/core/types.ts:475

Inherited from

BoardOptions.animation

---

animationDurationInMs?

optional animationDurationInMs: number

Defined in: src/core/types.ts:477

Inherited from

BoardOptions.animationDurationInMs

---

animationEasing?

optional animationEasing: AnimationEasing

Defined in: src/core/types.ts:478

Inherited from

BoardOptions.animationEasing

---

animationMs?

optional animationMs: number

Defined in: src/core/types.ts:476

Inherited from

BoardOptions.animationMs

---

arrowOptions?

optional arrowOptions: ArrowStyleOptions

Defined in: src/core/types.ts:514

Inherited from

BoardOptions.arrowOptions

---

arrows?

optional arrows: Arrow[]

Defined in: src/core/types.ts:513

Inherited from

BoardOptions.arrows

---

autoFlip?

optional autoFlip: boolean

Defined in: src/core/types.ts:505

Inherited from

BoardOptions.autoFlip

---

boardOrientation?

optional boardOrientation: "white" | "black"

Defined in: src/react/NeoChessBoard.tsx:195

Overrides

BoardOptions.boardOrientation

---

boardStyle?

optional boardStyle: InlineStyle | CSSProperties

Defined in: src/react/NeoChessBoard.tsx:194

---

cameraEffects?

optional cameraEffects: BoardCameraEffectsOptions

Defined in: src/core/types.ts:479

Inherited from

BoardOptions.cameraEffects

---

canDragPiece()?

optional canDragPiece: (params) => boolean

Defined in: src/core/types.ts:490

Parameters

params

PieceCanDragHandlerArgs

Returns

boolean

Inherited from

BoardOptions.canDragPiece

---

captureEffect?

optional captureEffect: CaptureEffectOptions

Defined in: src/core/types.ts:509

Inherited from

BoardOptions.captureEffect

---

captureEffectRenderer?

optional captureEffectRenderer: ReactCaptureEffectRenderer

Defined in: src/react/NeoChessBoard.tsx:198

---

chessboardColumns?

optional chessboardColumns: number

Defined in: src/core/types.ts:470

Inherited from

BoardOptions.chessboardColumns

---

chessboardRows?

optional chessboardRows: number

Defined in: src/core/types.ts:469

Inherited from

BoardOptions.chessboardRows

---

className?

optional className: string

Defined in: src/react/NeoChessBoard.tsx:192

---

clearArrowsOnClick?

optional clearArrowsOnClick: boolean

Defined in: src/core/types.ts:516

Inherited from

BoardOptions.clearArrowsOnClick

---

clock?

optional clock: ClockConfig

Defined in: src/core/types.ts:532

Inherited from

BoardOptions.clock

---

darkSquareNotationStyle?

optional darkSquareNotationStyle: NotationStyleOptions

Defined in: src/core/types.ts:524

Inherited from

BoardOptions.darkSquareNotationStyle

---

darkSquareStyle?

optional darkSquareStyle: SquareStyleOptions

Defined in: src/core/types.ts:521

Inherited from

BoardOptions.darkSquareStyle

---

dragActivationDistance?

optional dragActivationDistance: number

Defined in: src/core/types.ts:491

Inherited from

BoardOptions.dragActivationDistance

---

dragCancelOnEsc?

optional dragCancelOnEsc: boolean

Defined in: src/core/types.ts:495

Inherited from

BoardOptions.dragCancelOnEsc

---

dragGhostOpacity?

optional dragGhostOpacity: number

Defined in: src/core/types.ts:494

Inherited from

BoardOptions.dragGhostOpacity

---

dragGhostPiece?

optional dragGhostPiece: boolean

Defined in: src/core/types.ts:493

Inherited from

BoardOptions.dragGhostPiece

---

dragSnapToSquare?

optional dragSnapToSquare: boolean

Defined in: src/core/types.ts:492

Inherited from

BoardOptions.dragSnapToSquare

---

extensions?

optional extensions: ExtensionConfig\<unknown>[]

Defined in: src/core/types.ts:510

Inherited from

BoardOptions.extensions

---

fen?

optional fen: string

Defined in: src/react/NeoChessBoard.tsx:190

---

highlightLegal?

optional highlightLegal: boolean

Defined in: src/core/types.ts:481

Inherited from

BoardOptions.highlightLegal

---

id?

optional id: string

Defined in: src/core/types.ts:517

Inherited from

BoardOptions.id

---

interactive?

optional interactive: boolean

Defined in: src/core/types.ts:471

Inherited from

BoardOptions.interactive

---

lightSquareNotationStyle?

optional lightSquareNotationStyle: NotationStyleOptions

Defined in: src/core/types.ts:523

Inherited from

BoardOptions.lightSquareNotationStyle

---

lightSquareStyle?

optional lightSquareStyle: SquareStyleOptions

Defined in: src/core/types.ts:520

Inherited from

BoardOptions.lightSquareStyle

---

maxArrows?

optional maxArrows: number

Defined in: src/core/types.ts:501

Inherited from

BoardOptions.maxArrows

---

maxHighlights?

optional maxHighlights: number

Defined in: src/core/types.ts:502

Inherited from

BoardOptions.maxHighlights

---

numericNotationStyle?

optional numericNotationStyle: NotationStyleOptions

Defined in: src/core/types.ts:526

Inherited from

BoardOptions.numericNotationStyle

---

onArrowsChange()?

optional onArrowsChange: (arrows) => void

Defined in: src/core/types.ts:515

Parameters

arrows

Arrow[]

Returns

void

Inherited from

BoardOptions.onArrowsChange

---

onClockChange()?

optional onClockChange: (state) => void

Defined in: src/react/NeoChessBoard.tsx:211

Parameters

state

ClockState

Returns

void

---

onClockFlag()?

optional onClockFlag: (e) => void

Defined in: src/react/NeoChessBoard.tsx:214

Parameters

e

color

Color

remaining

number

Returns

void

---

onClockPause()?

optional onClockPause: () => void

Defined in: src/react/NeoChessBoard.tsx:213

Returns

void

---

onClockStart()?

optional onClockStart: () => void

Defined in: src/react/NeoChessBoard.tsx:212

Returns

void

---

onIllegal()?

optional onIllegal: (e) => void

Defined in: src/react/NeoChessBoard.tsx:200

Parameters

e

from

`${string}${number}`

reason

string

to

`${string}${number}`

Returns

void

---

onMove()?

optional onMove: (e) => void

Defined in: src/react/NeoChessBoard.tsx:199

Parameters

e

captured?

string | null

fen

string

from

`${string}${number}`

san?

string

to

`${string}${number}`

Returns

void

---

onPieceClick()?

optional onPieceClick: (e) => void

Defined in: src/react/NeoChessBoard.tsx:208

Parameters

e

PiecePointerEventPayload

Returns

void

---

onPieceDrag()?

optional onPieceDrag: (e) => void

Defined in: src/react/NeoChessBoard.tsx:209

Parameters

e

PieceDragEventPayload

Returns

void

---

onPieceDrop()?

optional onPieceDrop: (e) => void

Defined in: src/react/NeoChessBoard.tsx:210

Parameters

e

PieceDropEventPayload

Returns

void

---

onPromotionRequired()?

optional onPromotionRequired: (request) => void | Promise\<void>

Defined in: src/core/types.ts:511

Parameters

request

PromotionRequest

Returns

void | Promise\<void>

Inherited from

BoardOptions.onPromotionRequired

---

onPuzzleComplete()?

optional onPuzzleComplete: (event) => void

Defined in: src/react/NeoChessBoard.tsx:218

Parameters

event

attempts

number

durationMs?

number

puzzleId

string

Returns

void

---

onPuzzleEvent()?

optional onPuzzleEvent: (event) => void

Defined in: src/react/NeoChessBoard.tsx:220

Parameters

event

PuzzleTelemetryEvent

Returns

void

---

onPuzzleHint()?

optional onPuzzleHint: (event) => void

Defined in: src/react/NeoChessBoard.tsx:217

Parameters

event

hintPayload?

string

hintType

"text" | "origin-highlight"

hintUsage

number

puzzleId

string

Returns

void

---

onPuzzleLoad()?

optional onPuzzleLoad: (event) => void

Defined in: src/react/NeoChessBoard.tsx:215

Parameters

event

collectionId

string

puzzle

PuzzleDefinition

session

PuzzleSessionState

Returns

void

---

onPuzzleMove()?

optional onPuzzleMove: (event) => void

Defined in: src/react/NeoChessBoard.tsx:216

Parameters

event

attempts

number

cursor

number

move

string

puzzleId

string

result

"correct" | "incorrect"

Returns

void

---

onPuzzlePersistenceWarning()?

optional onPuzzlePersistenceWarning: (event) => void

Defined in: src/react/NeoChessBoard.tsx:219

Parameters

event

error

string

fallback

"memory"

Returns

void

---

onSquareClick()?

optional onSquareClick: (e) => void

Defined in: src/react/NeoChessBoard.tsx:202

Parameters

e

SquarePointerEventPayload

Returns

void

---

onSquareMouseDown()?

optional onSquareMouseDown: (e) => void

Defined in: src/react/NeoChessBoard.tsx:203

Parameters

e

SquarePointerEventPayload

Returns

void

---

onSquareMouseOut()?

optional onSquareMouseOut: (e) => void

Defined in: src/react/NeoChessBoard.tsx:207

Parameters

e

SquareTransitionEventPayload

Returns

void

---

onSquareMouseOver()?

optional onSquareMouseOver: (e) => void

Defined in: src/react/NeoChessBoard.tsx:206

Parameters

e

SquareTransitionEventPayload

Returns

void

---

onSquareMouseUp()?

optional onSquareMouseUp: (e) => void

Defined in: src/react/NeoChessBoard.tsx:204

Parameters

e

SquarePointerEventPayload

Returns

void

---

onSquareRightClick()?

optional onSquareRightClick: (e) => void

Defined in: src/react/NeoChessBoard.tsx:205

Parameters

e

SquarePointerEventPayload

Returns

void

---

onUpdate()?

optional onUpdate: (e) => void

Defined in: src/react/NeoChessBoard.tsx:201

Parameters

e

fen

string

Returns

void

---

orientation?

optional orientation: "white" | "black"

Defined in: src/core/types.ts:467

Inherited from

BoardOptions.orientation

---

pgnWorkerThreshold?

optional pgnWorkerThreshold: number

Defined in: src/core/types.ts:536

Inherited from

BoardOptions.pgnWorkerThreshold

---

pieces?

optional pieces: Partial\<Record\<Piece, PieceRenderer>> | Partial\<Record\<Piece, ReactPieceRenderer>>

Defined in: src/react/NeoChessBoard.tsx:197

---

pieceSet?

optional pieceSet: PieceSet

Defined in: src/core/types.ts:473

Inherited from

BoardOptions.pieceSet

---

position?

optional position: string

Defined in: src/react/NeoChessBoard.tsx:191

---

premove?

optional premove: BoardPremoveSettings

Defined in: src/core/types.ts:497

Inherited from

BoardOptions.premove

---

promotion?

optional promotion: PromotionOptions

Defined in: src/core/types.ts:530

Inherited from

BoardOptions.promotion

---

puzzleMode?

optional puzzleMode: PuzzleModeConfig

Defined in: src/core/types.ts:531

Inherited from

BoardOptions.puzzleMode

---

rightClickHighlights?

optional rightClickHighlights: boolean

Defined in: src/core/types.ts:500

Inherited from

BoardOptions.rightClickHighlights

---

showAnimations?

optional showAnimations: boolean

Defined in: src/core/types.ts:480

Inherited from

BoardOptions.showAnimations

---

showArrows?

optional showArrows: boolean

Defined in: src/core/types.ts:498

Inherited from

BoardOptions.showArrows

---

showCoordinates?

optional showCoordinates: boolean

Defined in: src/core/types.ts:474

Inherited from

BoardOptions.showCoordinates

---

showHighlights?

optional showHighlights: boolean

Defined in: src/core/types.ts:499

Inherited from

BoardOptions.showHighlights

---

showNotation?

optional showNotation: boolean

Defined in: src/core/types.ts:527

Inherited from

BoardOptions.showNotation

---

showSquareNames?

optional showSquareNames: boolean

Defined in: src/core/types.ts:504

Inherited from

BoardOptions.showSquareNames

---

size?

optional size: number

Defined in: src/core/types.ts:466

Inherited from

BoardOptions.size

---

soundEnabled?

optional soundEnabled: boolean

Defined in: src/core/types.ts:503

Inherited from

BoardOptions.soundEnabled

---

soundEventUrls?

optional soundEventUrls: Partial\<Record\<BoardSoundEventType, BoardSoundEventUrl>>

Defined in: src/core/types.ts:508

Inherited from

BoardOptions.soundEventUrls

---

soundUrl?

optional soundUrl: string

Defined in: src/core/types.ts:506

Inherited from

BoardOptions.soundUrl

---

soundUrls?

optional soundUrls: Partial\<Record\<"white" | "black", string>>

Defined in: src/core/types.ts:507

Inherited from

BoardOptions.soundUrls

---

squareRenderer?

optional squareRenderer: SquareRenderer | ReactSquareRenderer

Defined in: src/react/NeoChessBoard.tsx:196

---

squareStyle?

optional squareStyle: SquareStyleOptions

Defined in: src/core/types.ts:519

Inherited from

BoardOptions.squareStyle

---

squareStyles?

optional squareStyles: Partial\<Record\<`${string}${number}`, SquareStyleOptions>>

Defined in: src/core/types.ts:522

Inherited from

BoardOptions.squareStyles

---

style?

optional style: CSSProperties

Defined in: src/react/NeoChessBoard.tsx:193

---

theme?

optional theme: string | Theme

Defined in: src/core/types.ts:472

Inherited from

BoardOptions.theme

---

useWorkerForLegalMoves?

optional useWorkerForLegalMoves: boolean

Defined in: src/core/types.ts:534

Inherited from

BoardOptions.useWorkerForLegalMoves

---

useWorkerForPgnParsing?

optional useWorkerForPgnParsing: boolean

Defined in: src/core/types.ts:535

Inherited from

BoardOptions.useWorkerForPgnParsing

---

variant?

optional variant: Variant

Defined in: src/core/types.ts:484

Inherited from

BoardOptions.variant