Get started - Get started with Comments using Liveblocks and React

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding a commenting experience to your React application using the hooks from @liveblocks/react and the components from @liveblocks/react-comments.

Quickstart

  1. Install Liveblocks

    $npm install @liveblocks/client @liveblocks/react @liveblocks/react-comments

  2. Initialize the liveblocks.config.ts file

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

  3. Set up the Liveblocks client

    The first step in connecting to Liveblocks is creating a client which will be responsible for communicating with the back end. You can do this by modifying createClient in your config file, and passing your public API key.

    liveblocks.config.ts
    const client = createClient({  publicApiKey: "",});

  4. Join a Liveblocks room

    Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate. To create a real-time experience, multiple users must be connected to the same room.

    App.tsx
    "use client";
    import { RoomProvider } from "./liveblocks.config";import { Room } from "./Room";import { ClientSideSuspense } from "@liveblocks/react";
    export default function App() {  return (    <RoomProvider id="my-room" initialPresence={{}}>      <ClientSideSuspense fallback={<div>Loading…</div>}>        {() => <Room />}      </ClientSideSuspense>    </RoomProvider>  );}

  5. Use the Liveblocks hooks and components

    Now that we’re connected to a room, we can start using the Liveblocks hooks and components. We’ll add useThreads to get the threads in the room, then we’ll use the Thread component to render them. Finally, we’ll add a way to create threads by adding a Composer.

    Room.tsx
    "use client";
    import { useThreads } from "./liveblocks.config";import { Composer, Thread } from "@liveblocks/react-comments";
    export function Room() {  const { threads } = useThreads();
      return (    <div>      {threads.map((thread) => (        <Thread key={thread.id} thread={thread} />      ))}      <Composer />    </div>  );}

  6. Import default styles

    The default components come with default styles, you can import them into the root of your app or directly into a CSS file with @import.

    import "@liveblocks/react-comments/styles.css";

  7. Next: authenticate and add your users

    Comments 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 and avatar to their comments.

    Add your users to Comments

What to read next

Congratulations! You’ve set up the foundation to start building a commenting experience for your React application.

Examples using React