React: Installing

The React hooks ship in the kizunasync package as the kizunasync/react subpath, and React 19 or later is an optional peer. The other subpaths build the client the hooks read: kizunasync holds the engine and the config helpers, kizunasync/supabase composes the client over Supabase, and kizunasync/web is the browser driver. @supabase/supabase-js is Supabase's JavaScript client, which kizunasync/supabase takes as a peer and src/supabase-client.ts creates.

Install from npm#

npm install kizunasync @supabase/supabase-js

pnpm add kizunasync @supabase/supabase-js

yarn add kizunasync @supabase/supabase-js

bun add kizunasync @supabase/supabase-js

TypeScript resolves KizunaSyncProvider from kizunasync/react. On a native host, swap kizunasync/web for kizunasync/expo and follow Expo: Installing; the hooks are the same either way.

Related reference#

• Introduction
• Initializing
• Vue: Installing
• Expo: Installing
• JavaScript: Installing