@frame/react

A React package providing a Frame context provider and hook.

Installation

npm install @frame/react
# or
yarn add @frame/react
# or
pnpm add @frame/react

Usage

import { FrameProvider, useFrame } from '@frame/react';

function App() {
  return (
    <FrameProvider>
      <YourComponent />
    </FrameProvider>
  );
}

function YourComponent() {
  const { isConnected, connect, disconnect } = useFrame();

  return (
    <div>
      <p>Connected: {isConnected ? 'Yes' : 'No'}</p>
      <button onClick={connect}>Connect</button>
      <button onClick={disconnect}>Disconnect</button>
    </div>
  );
}

API

FrameProvider

A context provider component that manages the Frame state.

Props

• children: React nodes to be wrapped by the provider
• initialValue: Optional initial state values

useFrame

A hook to access the Frame context.

Returns

• isConnected: boolean indicating connection status
• address: string | undefined - connected address
• connect: function to establish connection
• disconnect: function to terminate connection