@ue-too/board-react-adapter / useBoard

Function: useBoard()

useBoard(): Board

Defined in: hooks/useBoardify.tsx:418

Hook to access the Board instance from context.

Returns

Board

The Board instance from context

Remarks

This hook retrieves the Board instance provided by BoardProvider. It must be used within a component that is a descendant of BoardProvider, otherwise it will throw an error.

Throws

Error if used outside of BoardProvider

Example

function MyComponent() {
  const board = useBoard();

  useEffect(() => {
    // Configure board
    board.camera.boundaries = { min: { x: -1000, y: -1000 }, max: { x: 1000, y: 1000 } };
  }, [board]);

  return <div>Board ready</div>;
}

See

BoardProvider for providing the board instance