Get started - Get started with Comments using Liveblocks and Next.js

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding a commenting experience to your Next.js /app directory 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. When using Next.js’ /app directory, we recommend creating your room in a Room.tsx file in the same directory as your current route.

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

  5. Add the Liveblocks room to your page

    After creating your room file, it’s time to join it. Import your room into your page.tsx file, and place your collaborative app components inside it.

    app/page.tsx
    import { Room } from "./Room";import { CollaborativeApp } from "./CollaborativeApp";
    export default function Page() {  return (    <Room>      <CollaborativeApp />    </Room>  );}

  6. 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.

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

  7. Import default styles

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

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

  8. 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 Next.js application.

Examples using Next.js