YjsReactLexicalTutorialsText editors

How to create a collaborative text editor with Lexical, Yjs, Next.js, and Liveblocks

In this tutorial, we’ll be building a collaborative text editor using Lexical, Yjs, Next.js, and Liveblocks.

This guide assumes that you’re already familiar with React, Next.js, TypeScript, and Lexical.

Install Lexical, Yjs, and Liveblocks into your React application

Run the following command to install the Lexical, Yjs, and Liveblocks packages:

$npm install lexical @lexical/react @lexical/yjs @liveblocks/client @liveblocks/react @liveblocks/yjs yjs

Set up access token authentication

The first step in connecting to Liveblocks is to set up an authentication endpoint in /app/api/liveblocks-auth/route.ts.

import { Liveblocks } from "@liveblocks/node";import { NextRequest } from "next/server";
const API_KEY = "";
const liveblocks = new Liveblocks({  secret: API_KEY!,});
export async function POST(request: NextRequest) {  // Get the current user's info from your database  const user = {    id: "charlielayne@example.com",    info: {      name: "Charlie Layne",      color: "#D583F0",      picture: "https://liveblocks.io/avatars/avatar-1.png",    },  };
  // Create a session for the current user  // userInfo is made available in Liveblocks presence hooks, e.g. useOthers  const session = liveblocks.prepareSession(user.id, {    userInfo: user.info,  });
  // Give the user access to the room  const { room } = await request.json();  session.allow(room, session.FULL_ACCESS);
  // Authorize the user and return the result  const { body, status } = await session.authorize();  return new Response(body, { status });}

Here’s an example using the older API routes format in /pages.

Initialize your Liveblocks config file

Let’s initialize the liveblocks.config.ts file in which you’ll set up the Liveblocks client.

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

Set up the client

Next, we can create the front end client which will be responsible for communicating with the back end. You can do this by modifying createClient in your config file, and passing the location of your endpoint.

const client = createClient({  authEndpoint: "/api/liveblocks-auth",});

Join a Liveblocks room

Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate. To create a realtime experience, multiple users must be connected to the same room. Create a file in the current directory within /app, and name it Room.tsx.

/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={roomId}      initialPresence={{        cursor: null,      }}    >      <ClientSideSuspense fallback={<div>Loading…</div>}>        {() => children}      </ClientSideSuspense>    </RoomProvider>  );}

Set up the Lexical editor

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

Editor.tsx
"use client";
import { LiveblocksYjsProvider } from "@liveblocks/yjs";import * as Y from "yjs";import { useRoom } from "@/liveblocks.config";import styles from "./Editor.module.css";import {  $createParagraphNode,  $createTextNode,  $getRoot,  LexicalEditor,} from "lexical";import { LexicalComposer } from "@lexical/react/LexicalComposer";import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";import { ContentEditable } from "@lexical/react/LexicalContentEditable";import LexicalErrorBoundary from "@lexical/react/LexicalErrorBoundary";import { CollaborationPlugin } from "@lexical/react/LexicalCollaborationPlugin";import { Provider } from "@lexical/yjs";
// Set up editor configconst initialConfig = {  // NOTE: This is critical for collaboration plugin to set editor state to null. It  // would indicate that the editor should not try to set any default state  // (not even empty one), and let collaboration plugin do it instead  editorState: null,  namespace: "Demo",  nodes: [],  onError: (error: unknown) => {    throw error;  },};
// Define initial editor statefunction initialEditorState(editor: LexicalEditor): void {  const root = $getRoot();  const paragraph = $createParagraphNode();  const text = $createTextNode();  paragraph.append(text);  root.append(paragraph);}
// Collaborative text editor with simple rich text
export default function Editor() {  // Get Liveblocks room  const room = useRoom();
  return (    <div className={styles.container}>      <LexicalComposer initialConfig={initialConfig}>        <div className={styles.editorContainer}>          <RichTextPlugin            contentEditable={<ContentEditable className={styles.editor} />}            placeholder={              <p className={styles.placeholder}>Start typing here…</p>            }            ErrorBoundary={LexicalErrorBoundary}          />          <CollaborationPlugin            id="yjs-plugin"            providerFactory={(id, yjsDocMap) => {              // Set up Liveblocks Yjs provider              const doc = new Y.Doc();              yjsDocMap.set(id, doc);              const provider = new LiveblocksYjsProvider(room, doc) as Provider;              return provider;            }}            initialEditorState={initialEditorState}            shouldBootstrap={true}          />        </div>      </LexicalComposer>    </div>  );}

And here is the Editor.module.css file to make sure your multiplayer text editor looks nice and tidy.

Add live cursors

To add live cursors to the text editor, we can pass the current user’s information from our authentication endpoint into CollaborationPlugin.

Editor.tsx
import { useSelf } from "../liveblocks.config";// ...
export default function Editor() {  // Get Liveblocks room, and user info from Liveblocks authentication endpoint  const room = useRoom();  const userInfo = useSelf((me) => me.info);
  return (    <div className={styles.container}>      <LexicalComposer initialConfig={initialConfig}>        <div className={styles.editorContainer}>          <RichTextPlugin            contentEditable={<ContentEditable className={styles.editor} />}            placeholder={              <p className={styles.placeholder}>Start typing here…</p>            }            ErrorBoundary={LexicalErrorBoundary}          />          <CollaborationPlugin            id="yjs-plugin"            cursorColor={userInfo.color}            username={userInfo.name}            providerFactory={(id, yjsDocMap) => {              // Set up Liveblocks Yjs provider              const doc = new Y.Doc();              yjsDocMap.set(id, doc);              const provider = new LiveblocksYjsProvider(room, doc) as Provider;              return provider;            }}            initialEditorState={initialEditorState}            shouldBootstrap={true}          />        </div>      </LexicalComposer>    </div>  );}

Add a toolbar

From this point onwards, you can build your Lexical app as normal! For example, should you wish to add a basic text-style toolbar to your app:

Toolbar.tsx
import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";import { FORMAT_TEXT_COMMAND } from "lexical";import styles from "./Toolbar.module.css";
export function Toolbar() {  const [editor] = useLexicalComposerContext();
  return (    <div className={styles.toolbar}>      <button        className={styles.buttonBold}        onClick={() => {          editor.dispatchCommand(FORMAT_TEXT_COMMAND, "bold");        }}        aria-label="Format bold"      >        B      </button>      <button        className={styles.buttonItalic}        onClick={() => {          editor.dispatchCommand(FORMAT_TEXT_COMMAND, "italic");        }}        aria-label="Format italic"      >        i      </button>      <button        className={styles.buttonUnderline}        onClick={() => {          editor.dispatchCommand(FORMAT_TEXT_COMMAND, "underline");        }}        aria-label="Format underline"      >        u      </button>    </div>  );}

Add some matching styles:

You can then import this into your editor to enable basic rich-text:

Editor.tsx
import { Toolbar } from "./Toolbar";// ...
export default function Editor() {  // ...
  return (    <div className={styles.container}>      <LexicalComposer initialConfig={initialConfig}>        <div className={styles.editorHeader}>          <Toolbar />        </div>        <div className={styles.editorContainer}>{/* ... */}</div>      </LexicalComposer>    </div>  );}

Theme your text styles

You can go a step further and theme your basic custom text styles by using the theme property, and adding corresponding styles:

Editor.tsx
import styles from "./Editor.module.css";// ...
// Set up editor config and themeconst initialConfig = {  // NOTE: This is critical for collaboration plugin to set editor state to null. It  // would indicate that the editor should not try to set any default state  // (not even empty one), and let collaboration plugin do it instead  editorState: null,  namespace: "Demo",  nodes: [],  onError: (error: unknown) => {    throw error;  },  theme: {    text: {      bold: styles.textBold,      italic: styles.textItalic,      underline: styles.textUnderline,    },    paragraph: styles.paragraph,  },};
// ...

And then in your CSS module, you can style your rich-text:

Create live avatars with Liveblocks hooks

Along with building out your text editor, you can now use other Liveblocks features, such as Presence. The useOthers hook allows us to view information about each user currently online, and we can turn this into a live avatars component.

Avatars.tsx
import { useOthers, useSelf } from "@/liveblocks.config";import styles from "./Avatars.module.css";
export function Avatars() {  const users = useOthers();  const currentUser = useSelf();
  return (    <div className={styles.avatars}>      {users.map(({ connectionId, info }) => {        return (          <Avatar key={connectionId} picture={info.picture} name={info.name} />        );      })}
      {currentUser && (        <div className="relative ml-8 first:ml-0">          <Avatar            picture={currentUser.info.picture}            name={currentUser.info.name}          />        </div>      )}    </div>  );}
export function Avatar({ picture, name }: { picture: string; name: string }) {  return (    <div className={styles.avatar} data-tooltip={name}>      <img        src={picture}        className={styles.avatar_picture}        data-tooltip={name}      />    </div>  );}

And here’s the styles:

You can then import this to your editor to see it in action:

Editor.tsx
import { Avatars } from "./Avatars";// ...
export default function Editor() {  // ...
  return (    <div className={styles.container}>      <LexicalComposer initialConfig={initialConfig}>        <div className={styles.editorHeader}>          <Toolbar />          <Avatars />        </div>        <div className={styles.editorContainer}>{/* ... */}</div>      </LexicalComposer>    </div>  );}

Note that the cursors and avatars match in color and name, as the info for both is sourced from the Liveblocks authentication endpoint.

Try it out

You should now see the complete editor, along with live cursors, live avatars, and some basic rich-text features! On GitHub we have a working example of this multiplayer text editor.

Related guides

We use cookies to collect data to improve your experience on our site. Read our Privacy Policy to learn more.