@liveblocks/react

@liveblocks/react

@liveblocks/react provides React hooks and providers to integrate with Liveblocks—a platform to build, host, and scale collaborative applications with zero configuration, no maintenance required.

Installation

npm install @liveblocks/client @liveblocks/react

Documentation

Read the documentation for guides and API references.

Examples

Explore our collaborative examples to help you get started.

All examples are open-source and live in this repository, within /examples.

Releases

See the latest changes or learn more about upcoming releases.

Community

• Discord - To get involved with the Liveblocks community, ask questions and share tips.
• X - To receive updates, announcements, blog posts, and general Liveblocks tips.

License

Licensed under the Apache License 2.0, Copyright © 2021-present Liveblocks.

See LICENSE for more information.

Changelog

v1.10.0

This release introduces Notifications (and unread indicators) for Comments.

create-liveblocks-app

• Add createLiveblocksContext and Notifications to --init.
• Move resolver options from createRoomContext to createClient and add resolveRoomsInfo to the list of resolvers.

@liveblocks/client

• Add options to createClient: resolveUsers, resolveMentionSuggestions (both were previously defined on createRoomContext from @liveblocks/react), and the new resolveRoomsInfo.

@liveblocks/react

• Add new LiveblocksContext accessible with createLiveblocksContext, similarly to createRoomContext. This context is meant to live at the root since it handles things outside of rooms, like notifications. It contains LiveblocksProvider, useUser, useRoomInfo, useInboxNotifications, useUnreadInboxNotificationsCount, useMarkInboxNotificationAsRead, and useMarkAllInboxNotificationsAsRead.
• Add new hooks to createRoomContext: useMarkThreadAsRead, useThreadSubscription, useRoomInfo, useRoomNotificationSettings, and useUpdateRoomNotificationSettings.
• Make some hooks usable interchangeably between createLiveblocksContext and createRoomContext: useUser, and useRoomInfo.

@liveblocks/react-comments

• Add new default components: InboxNotification and InboxNotificationList.
• Add unread indicators to the default Thread component.
• Support "@" in mentions. (e.g. @[e-mail] is now a valid mention and will trigger resolveMentionSuggestions with "[e-mail]")

@liveblocks/node

• Add the Notifications REST APIs as fully typed methods. (includes getInboxNotification, getRoomNotificationSettings, updateRoomNotificationSettings, and deleteRoomNotificationSettings methods)
• Add notification webhook event: NotificationEvent.