Get started – Get started with Liveblocks, Yjs, BlockNote, and React

Liveblocks is a realtime collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding collaboration to your React application using the APIs from the @liveblocks/yjs package.

Quickstart

1. Install Liveblocks, Yjs, and BlockNote

   Every Liveblocks package should use the same version.

   $npm install @liveblocks/client @liveblocks/react @liveblocks/yjs yjs @blocknote/core @blocknote/react @blocknote/mantine

2. Initialize the liveblocks.config.ts file

   We can use this file later to define types for our application.

   $npx create-liveblocks-app@latest --init --framework react

3. Set up the Liveblocks client

   Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate, and to create a realtime experience, multiple users must be connected to the same room. Set up a Liveblocks client with LiveblocksProvider, and join a room with RoomProvider.

   App.tsx

   "use client";
   import {  LiveblocksProvider,  RoomProvider,} from "@liveblocks/react/suspense";import { Editor } from "./Editor";
   export default function App() {  return (    <LiveblocksProvider publicApiKey={"pk_prod_xxxx…xxxxxxpk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"}>      <RoomProvider id="my-room">        {/* ... */}      </RoomProvider>    </LiveblocksProvider>  );}

4. Join a Liveblocks room

   After setting up the room, you can add collaborative components inside it, using ClientSideSuspense to add loading spinners to your app.

   App.tsx

   "use client";
   import {  LiveblocksProvider,  RoomProvider,  ClientSideSuspense,} from "@liveblocks/react/suspense";import { Editor } from "./Editor";
   export default function App() {  return (    <LiveblocksProvider publicApiKey={"pk_prod_xxxx…xxxxxxpk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"}>      <RoomProvider id="my-room">        <ClientSideSuspense fallback={<div>Loading…</div>}>          <Editor />        </ClientSideSuspense>      </RoomProvider>    </LiveblocksProvider>  );}

5. Set up the collaborative BlockNote text editor

   Now that we set up Liveblocks, we can start integrating BlockNote and Yjs in the Editor.tsx file.

   Editor.tsx

   import { useEffect, useState } from "react";import { BlockNoteEditor } from "@blocknote/core";import "@blocknote/core/fonts/inter.css";import { useCreateBlockNote } from "@blocknote/react";import { BlockNoteView } from "@blocknote/mantine";import "@blocknote/mantine/styles.css";import * as Y from "yjs";import { LiveblocksYjsProvider } from "@liveblocks/yjs";import { useRoom } from "@liveblocks/react/suspense";
   type EditorProps = {  doc: Y.Doc,  provider: any;}
   function Editor() {  const room = useRoom();  const [doc, setDoc] = useState<Y.Doc>();  const [provider, setProvider] = useState<any>();
     // Set up Liveblocks Yjs provider  useEffect(() => {    const yDoc = new Y.Doc();    const yProvider = new LiveblocksYjsProvider(room, yDoc);    setDoc(yDoc);    setProvider(yProvider);
       return () => {      yDoc?.destroy();      yProvider?.destroy();    };  }, [room]);
     if (!doc || !provider) {    return null;  }
     return <BlockNote doc={doc} provider={provider} />;}
   
   function BlockNote({ doc, provider }: EditorProps) {  const editor: BlockNoteEditor = useCreateBlockNote({    collaboration: {      provider,
         // Where to store BlockNote data in the Y.Doc:      fragment: doc.getXmlFragment("document-store"),
         // Information for this user:      user: {        name: "My Username",        color: "#ff0000",      },    },  });
     return <BlockNoteView editor={editor} />;}

6. Next: set up authentication

   By default, Liveblocks is configured to work without an authentication endpoint where everyone automatically has access to rooms. This approach is great for prototyping and marketing pages where setting up your own security isn’t always required. If you want to limit access to a room for certain users, you’ll need to set up an authentication endpoint to enable permissions.

   Set up authentication

What to read next

Congratulations! You now have set up the foundation for your collaborative BlockNote text editor inside your React application.

• Yjs guides
• @liveblocks/yjs API Reference
• BlockNote website

Examples using BlockNote

• 

  Collaborative Text Editor

  Next.js
• 

  Advanced Collaborative Text Editor

  Next.js