@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.12.0

@liveblocks/react

• Add support for custom notification kinds.
• Add new useInboxNotificationThread hook to createLiveblocksContext, which can be used to retrieve threads within thread notifications for more flexibility.
• Add support for startsWith operator to useThreads when filtering based on metadata.

@liveblocks/react-comments

• Add support for custom notification kinds to the InboxNotification component via the kinds prop and the InboxNotification.Custom component.
• Add destructive color tokens. (--lb-destructive, --lb-destructive-foreground, and --lb-destructive-contrast)

@liveblocks/node

• Add triggerInboxNotification method that lets you trigger custom notification kinds.
• Enable filtering rooms by room ID in the getRooms method. This works via query.roomId, metadata is deprecated and is now query.metadata.
• Add support for our query language when filtering with the getRooms and getThreads methods.
• Add support for an alternative object-based query notation to the getRooms and getThreads methods, which supports exact matches and the startsWith operator.