Get started - Get started with Comments using Liveblocks and React
Liveblocks is a realtime 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-ui
.
Quickstart
Install Liveblocks
Every package should use the same version.
Initialize the
liveblocks.config.ts
fileWe can use this file later to define types for our application.
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 withRoomProvider
.App.tsxJoin 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.tsxUse 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 theThread
component to render them. Finally, we’ll add a way to create threads by adding aComposer
.Room.tsxImport 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
.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.