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

函式: useBoard()

useBoard(): Board

定義於: hooks/useBoardify.tsx:419

Hook to access the Board instance from context.

回傳

Board

The Board instance from context

備註

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.

拋出

Error if used outside of BoardProvider

範例

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>;
}

參閱

BoardProvider for providing the board instance