Flow React SDK
Build React apps on Flow with TypeScript-first hooks and components. Built on TanStack Query for automatic caching, retries, and background updates.
Quick Start
npm install @onflow/react-sdk
import { FlowProvider, Connect, useFlowQuery } from '@onflow/react-sdk';
function App() {
return (
<FlowProvider config={{ accessNodeUrl: 'https://access-mainnet.onflow.org', flowNetwork: 'mainnet' }}>
<Connect />
<MyComponent />
</FlowProvider>
);
}
Navigation Map
| Task | Reference |
|---|---|
| Installation, FlowProvider, Next.js, theming, dark mode | setup.md |
| Cadence hooks: query, mutate, auth, events, accounts, blocks, NFT metadata | hooks.md |
| Cross-VM hooks: EVM batch tx, token/NFT bridging, cross-chain balances | cross-vm.md |
| UI components: Connect, TransactionButton, TransactionDialog, NftCard | components.md |
Companion Skills
cadence-lang— Consult when writing Cadence scripts/transactions used inuseFlowQueryanduseFlowMutate. The Cadence code passed to hooks must follow all language rules (access control, entitlements, resource handling).flow-project-setup— Consult forflow.jsonconfiguration that FlowProvider loads viaflowJsonprop. Contract addresses and network config must be aligned.flow-cli— Use to test scripts and transactions via CLI before integrating them into React hooks.cadence-tokens— Consult when usinguseFlowNftMetadataor building NFT/FT frontends for the correct MetadataViews and collection paths.