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

Function: BoardProvider()

BoardProvider(props): Element

Defined in: hooks/useBoardify.tsx:383

Provider component for sharing a Board instance across the component tree.

Parameters

props

Component props

children

ReactNode

Child components that will have access to the board

Returns

Element

Remarks

This component creates a single Board instance and makes it available to all child components via the useBoard hook. This is the recommended way to use the board in React applications when you need to access it from multiple components.

The board instance is created once when the provider mounts and persists for the lifetime of the provider.

Example

function App() {
  return (
    <BoardProvider>
      <Board width={800} height={600} />
      <CameraControls />
      <CameraStateDisplay />
    </BoardProvider>
  );
}

See

useBoard for accessing the board instance