Get started - Get started with Liveblocks, Tiptap, 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/react-tiptap package.

Quickstart

1. Install Liveblocks and Tiptap

   Every Liveblocks package should use the same version.

   $npm install @liveblocks/client @liveblocks/react @liveblocks/react-ui @liveblocks/react-tiptap @tiptap/react @tiptap/starter-kit

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 Tiptap text editor

   Now that we set up Liveblocks, we can start integrating Tiptap and Liveblocks in the Editor.tsx file. To make the editor collaborative, we can add useLiveblocksExtension from @liveblocks/react-tiptap. FloatingToolbar adds a text selection toolbar.

   Editor.tsx

   "use client";
   import { useLiveblocksExtension, FloatingToolbar } from "@liveblocks/react-tiptap";import { useEditor, EditorContent } from "@tiptap/react";import StarterKit from "@tiptap/starter-kit";import { Threads } from "./Threads";
   export function Editor() {  const liveblocks = useLiveblocksExtension();
     const editor = useEditor({    extensions: [      liveblocks,      StarterKit.configure({        // The Liveblocks extension comes with its own history handling        history: false,      }),    ],  });
     return (    <div>      <EditorContent editor={editor} className="editor" />      <Threads editor={editor} />      <FloatingToolbar editor={editor} />    </div>  );}

6. Render threads and composer

   To add Comments to your text editor, we need to import a thread composer and list each thread on the page. Create a Threads.tsx file that uses FloatingComposer for creating new threads, alongside AnchoredThreads and FloatingThreads for displaying threads on desktop and mobile.

   Threads.tsx

   import { useThreads } from "@liveblocks/react/suspense";import {  AnchoredThreads,  FloatingComposer,  FloatingThreads,} from "@liveblocks/react-tiptap";import { Editor } from "@tiptap/react";
   export function Threads({ editor }: { editor: Editor | null }) {  const { threads } = useThreads({ query: { resolved: false } });
     return (    <>      <div className="anchored-threads">        <AnchoredThreads editor={editor} threads={threads} />      </div>      <FloatingThreads        editor={editor}        threads={threads}        className="floating-threads"      />      <FloatingComposer editor={editor} className="floating-composer" />    </>  );}

7. Style your editor

   Tiptap text editor is unstyled by default, so we can create some custom styles for it in a globals.css file. Import globals.css, alongside the default Liveblocks styles. You can import them into the root layout of your app or directly into a CSS file with @import.

   app/globals.css

   app/layout.tsx

   import "@liveblocks/react-ui/styles.css";import "@liveblocks/react-tiptap/styles.css";import "./globals.css";

8. Next: authenticate and add your users

   Text Editor is set up and working now, but each user is anonymous—the next step is to authenticate each user as they connect, and attach their name, color, and avatar, to their cursors and mentions.

   Add your users to Text Editor

9. Optional: add more features

   Tiptap is easy to extend, and a number of extensions are already available, making it possible to quickly create complex rich-text applications. For example you can enable features such as tables, text highlights, embedded images, and more. This is all supported using Liveblocks.

   Find more extensions

What to read next

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

• @liveblocks/react-tiptap API Reference
• Tiptap guides
• Tiptap website

Examples using Tiptap

• 

  Collaborative Text Editor

  Next.js
• 

  Advanced Collaborative Text Editor

  Next.js