BoardOptions

neo-chess-board

---

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

Properties

allowAutoScroll?

optional allowAutoScroll: boolean

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

---

allowDragging?

optional allowDragging: boolean

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

---

allowDragOffBoard?

optional allowDragOffBoard: boolean

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

---

allowDrawingArrows?

optional allowDrawingArrows: boolean

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

---

allowPremoves?

optional allowPremoves: boolean

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

---

alphaNotationStyle?

optional alphaNotationStyle: NotationStyleOptions

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

---

animation?

optional animation: BoardAnimationConfig

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

---

animationDurationInMs?

optional animationDurationInMs: number

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

---

animationEasing?

optional animationEasing: AnimationEasing

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

---

animationMs?

optional animationMs: number

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

---

arrowOptions?

optional arrowOptions: ArrowStyleOptions

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

---

arrows?

optional arrows: Arrow[]

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

---

autoFlip?

optional autoFlip: boolean

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

---

boardOrientation?

optional boardOrientation: "white" | "black"

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

---

boardStyle?

optional boardStyle: InlineStyle

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

---

cameraEffects?

optional cameraEffects: BoardCameraEffectsOptions

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

---

canDragPiece()?

optional canDragPiece: (params) => boolean

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

Parameters

params

PieceCanDragHandlerArgs

Returns

boolean

---

captureEffect?

optional captureEffect: CaptureEffectOptions

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

---

chessboardColumns?

optional chessboardColumns: number

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

---

chessboardRows?

optional chessboardRows: number

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

---

clearArrowsOnClick?

optional clearArrowsOnClick: boolean

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

---

clock?

optional clock: ClockConfig

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

---

darkSquareNotationStyle?

optional darkSquareNotationStyle: NotationStyleOptions

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

---

darkSquareStyle?

optional darkSquareStyle: SquareStyleOptions

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

---

dragActivationDistance?

optional dragActivationDistance: number

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

---

dragCancelOnEsc?

optional dragCancelOnEsc: boolean

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

---

dragGhostOpacity?

optional dragGhostOpacity: number

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

---

dragGhostPiece?

optional dragGhostPiece: boolean

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

---

dragSnapToSquare?

optional dragSnapToSquare: boolean

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

---

extensions?

optional extensions: ExtensionConfig\<unknown>[]

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

---

fen?

optional fen: string

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

---

highlightLegal?

optional highlightLegal: boolean

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

---

id?

optional id: string

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

---

interactive?

optional interactive: boolean

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

---

lightSquareNotationStyle?

optional lightSquareNotationStyle: NotationStyleOptions

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

---

lightSquareStyle?

optional lightSquareStyle: SquareStyleOptions

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

---

maxArrows?

optional maxArrows: number

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

---

maxHighlights?

optional maxHighlights: number

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

---

numericNotationStyle?

optional numericNotationStyle: NotationStyleOptions

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

---

onArrowsChange()?

optional onArrowsChange: (arrows) => void

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

Parameters

arrows

Arrow[]

Returns

void

---

onPromotionRequired()?

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

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

Parameters

request

PromotionRequest

Returns

void | Promise\<void>

---

orientation?

optional orientation: "white" | "black"

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

---

pgnWorkerThreshold?

optional pgnWorkerThreshold: number

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

---

pieces?

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

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

---

pieceSet?

optional pieceSet: PieceSet

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

---

position?

optional position: string

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

---

premove?

optional premove: BoardPremoveSettings

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

---

promotion?

optional promotion: PromotionOptions

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

---

puzzleMode?

optional puzzleMode: PuzzleModeConfig

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

---

rightClickHighlights?

optional rightClickHighlights: boolean

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

---

rulesAdapter?

optional rulesAdapter: RulesAdapter

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

---

showAnimations?

optional showAnimations: boolean

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

---

showArrows?

optional showArrows: boolean

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

---

showCoordinates?

optional showCoordinates: boolean

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

---

showHighlights?

optional showHighlights: boolean

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

---

showNotation?

optional showNotation: boolean

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

---

showSquareNames?

optional showSquareNames: boolean

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

---

size?

optional size: number

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

---

soundEnabled?

optional soundEnabled: boolean

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

---

soundEventUrls?

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

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

---

soundUrl?

optional soundUrl: string

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

---

soundUrls?

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

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

---

squareRenderer?

optional squareRenderer: SquareRenderer

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

---

squareStyle?

optional squareStyle: SquareStyleOptions

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

---

squareStyles?

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

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

---

theme?

optional theme: string | Theme

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

---

useWorkerForLegalMoves?

optional useWorkerForLegalMoves: boolean

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

---

useWorkerForPgnParsing?

optional useWorkerForPgnParsing: boolean

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

---

variant?

optional variant: Variant

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