UseNeoChessBoardOptions

neo-chess-board

---

Defined in: src/react/useNeoChessBoard.ts:56

Extends

• MoveHandlers.SquareHandlers.PieceHandlers.ClockHandlers.PuzzleHandlers

Properties

fen?

optional fen: string

Defined in: src/react/useNeoChessBoard.ts:63

Position FEN initiale

---

onClockChange()?

optional onClockChange: (state) => void

Defined in: src/react/useNeoChessBoard.ts:40

Parameters

state

ClockState

Returns

void

Inherited from

ClockHandlers.onClockChange

---

onClockFlag()?

optional onClockFlag: (event) => void

Defined in: src/react/useNeoChessBoard.ts:43

Parameters

event

color

Color

remaining

number

Returns

void

Inherited from

ClockHandlers.onClockFlag

---

onClockPause()?

optional onClockPause: () => void

Defined in: src/react/useNeoChessBoard.ts:42

Returns

void

Inherited from

ClockHandlers.onClockPause

---

onClockStart()?

optional onClockStart: () => void

Defined in: src/react/useNeoChessBoard.ts:41

Returns

void

Inherited from

ClockHandlers.onClockStart

---

onIllegal()?

optional onIllegal: (event) => void

Defined in: src/react/useNeoChessBoard.ts:17

Parameters

event

from

`${string}${number}`

reason

string

to

`${string}${number}`

Returns

void

Inherited from

MoveHandlers.onIllegal

---

onMove()?

optional onMove: (event) => void

Defined in: src/react/useNeoChessBoard.ts:16

Parameters

event

captured?

string | null

fen

string

from

`${string}${number}`

san?

string

to

`${string}${number}`

Returns

void

Inherited from

MoveHandlers.onMove

---

onPieceClick()?

optional onPieceClick: (event) => void

Defined in: src/react/useNeoChessBoard.ts:33

Parameters

event

PiecePointerEventPayload

Returns

void

Inherited from

PieceHandlers.onPieceClick

---

onPieceDrag()?

optional onPieceDrag: (event) => void

Defined in: src/react/useNeoChessBoard.ts:34

Parameters

event

PieceDragEventPayload

Returns

void

Inherited from

PieceHandlers.onPieceDrag

---

onPieceDrop()?

optional onPieceDrop: (event) => void

Defined in: src/react/useNeoChessBoard.ts:35

Parameters

event

PieceDropEventPayload

Returns

void

Inherited from

PieceHandlers.onPieceDrop

---

onPuzzleComplete()?

optional onPuzzleComplete: (event) => void

Defined in: src/react/useNeoChessBoard.ts:51

Parameters

event

attempts

number

durationMs?

number

puzzleId

string

Returns

void

Inherited from

PuzzleHandlers.onPuzzleComplete

---

onPuzzleEvent()?

optional onPuzzleEvent: (event) => void

Defined in: src/react/useNeoChessBoard.ts:53

Parameters

event

PuzzleTelemetryEvent

Returns

void

Inherited from

PuzzleHandlers.onPuzzleEvent

---

onPuzzleHint()?

optional onPuzzleHint: (event) => void

Defined in: src/react/useNeoChessBoard.ts:50

Parameters

event

hintPayload?

string

hintType

"text" | "origin-highlight"

hintUsage

number

puzzleId

string

Returns

void

Inherited from

PuzzleHandlers.onPuzzleHint

---

onPuzzleLoad()?

optional onPuzzleLoad: (event) => void

Defined in: src/react/useNeoChessBoard.ts:48

Parameters

event

collectionId

string

puzzle

PuzzleDefinition

session

PuzzleSessionState

Returns

void

Inherited from

PuzzleHandlers.onPuzzleLoad

---

onPuzzleMove()?

optional onPuzzleMove: (event) => void

Defined in: src/react/useNeoChessBoard.ts:49

Parameters

event

attempts

number

cursor

number

move

string

puzzleId

string

result

"correct" | "incorrect"

Returns

void

Inherited from

PuzzleHandlers.onPuzzleMove

---

onPuzzlePersistenceWarning()?

optional onPuzzlePersistenceWarning: (event) => void

Defined in: src/react/useNeoChessBoard.ts:52

Parameters

event

error

string

fallback

"memory"

Returns

void

Inherited from

PuzzleHandlers.onPuzzlePersistenceWarning

---

onSquareClick()?

optional onSquareClick: (event) => void

Defined in: src/react/useNeoChessBoard.ts:23

Parameters

event

SquarePointerEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareClick

---

onSquareMouseDown()?

optional onSquareMouseDown: (event) => void

Defined in: src/react/useNeoChessBoard.ts:24

Parameters

event

SquarePointerEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareMouseDown

---

onSquareMouseOut()?

optional onSquareMouseOut: (event) => void

Defined in: src/react/useNeoChessBoard.ts:28

Parameters

event

SquareTransitionEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareMouseOut

---

onSquareMouseOver()?

optional onSquareMouseOver: (event) => void

Defined in: src/react/useNeoChessBoard.ts:27

Parameters

event

SquareTransitionEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareMouseOver

---

onSquareMouseUp()?

optional onSquareMouseUp: (event) => void

Defined in: src/react/useNeoChessBoard.ts:25

Parameters

event

SquarePointerEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareMouseUp

---

onSquareRightClick()?

optional onSquareRightClick: (event) => void

Defined in: src/react/useNeoChessBoard.ts:26

Parameters

event

SquarePointerEventPayload

Returns

void

Inherited from

SquareHandlers.onSquareRightClick

---

onUpdate()?

optional onUpdate: (event) => void

Defined in: src/react/useNeoChessBoard.ts:18

Parameters

event

fen

string

Returns

void

Inherited from

MoveHandlers.onUpdate

---

options?

optional options: UpdatableBoardOptions

Defined in: src/react/useNeoChessBoard.ts:67

Options additionnelles du board

---

position?

optional position: string

Defined in: src/react/useNeoChessBoard.ts:65

Position ou alias (e.g., 'start')