Get started - Get started with Notifications using Liveblocks and Next.js
Liveblocks is a realtime collaboration infrastructure for building performant
collaborative experiences. Follow the following steps to start adding
notifications to your Next.js /app
directory 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.
Create a Liveblocks provider
Liveblocks Notifications uses the concept of projects, which relate to projects in your dashboard. Notifications are sent between users in the same project. To connect and receive notifications, you must add
LiveblocksProvider
to a client component in your app.app/NotificationsProvider.tsxAdd the provider to your layout
After creating your provider file, it’s time to join it. Import your room into your
layout.tsx
file, and place your collaborative app components inside it.app/layout.tsxUse the Liveblocks hooks and components
Now that we’ve set up the provider, we can start using the Liveblocks hooks and components. We’ll add
useInboxNotifications
to get the current project’s notifications, then we’ll useInboxNotification
andInboxNotificationList
to render them.app/MyApp.tsxImport 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.tsxNext: authenticate and add your users
Notifications 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 notifications.
Add your users to Notifications
What to read next
Congratulations! You’ve set up the foundation to start building a notifications experience for your React application.