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.
Run the following command to install the Lexical, Yjs, and Liveblocks packages:
The first step in connecting to Liveblocks is to set up an authentication
Here’s an example using the older API routes format in
Let’s initialize the
liveblocks.config.ts file in which you’ll set up the
Next, we can create the front end client which will be responsible for
communicating with the back end. You can do this by modifying
your config file, and passing the location of your endpoint.
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. Create a file in the current directory within
/app, and name
Now that we set up Liveblocks, we can start integrating Lexical and Yjs in the
And here is the
Editor.module.css file to make sure your multiplayer text
editor looks nice and tidy.
To add live cursors to the text editor, we can pass the current user’s
information from our authentication endpoint into
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:
Add some matching styles:
You can then import this into your editor to enable basic rich-text:
You can go a step further and theme your basic custom text styles by using the
theme property, and adding corresponding styles:
And then in your CSS module, you can style your rich-text:
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.
And here’s the styles:
You can then import this to your editor to see it in action:
Note that the cursors and avatars match in color and name, as the info for both is sourced from the Liveblocks authentication endpoint.
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.