@liveblocks/react-ui
@liveblocks/react-ui
provides React pre-built
components for the Liveblocks products.
Installation
npm install @liveblocks/client @liveblocks/react @liveblocks/react-ui
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.
- 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.
v3.0.0
Liveblocks 3.0 is our third major release, focusing on our newest product,
AI Copilots.
We’ve used this as an opportunity to tidy up some of our existing APIs, ensuring
consistency throughout our offering.
For full upgrade instructions and codemods, see the
3.0 upgrade guide.
All packages
@liveblocks/react
- Introduce hooks and APIs for AI Copilots:
useAiChats
, useAiChat
,
useDeleteAiChat
,useSendAiMessage
, RegisterAiTool
, RegisterAiKnowledge
,
etc.
- Rename
UPDATE_USER_NOTIFICATION_SETTINGS_ERROR
to
UPDATE_NOTIFICATION_SETTINGS_ERROR
when using useNotificationSettings
or
useUpdateNotificationSettings
.
@liveblocks/react-ui
- Introduce pre-built components for AI Copilots:
AiChat
, AiTool
, etc.
- The
onMentionClick
prop on Thread
and Comment
now receives a
MentionData
object instead of a userId
string.
- The
Mention
component on the Comment.Body
and Composer.Editor
primitives
now receives a mention
prop instead of a userId
one.
- The
MentionSuggestions
component on the Composer.Editor
primitive now
receives a mentions
prop instead of a userIds
one, and the
selectedUserId
prop has been renamed to selectedMentionId
.
- Rename
LiveblocksUIConfig
to LiveblocksUiConfig
for consistency with other
Liveblocks APIs.
@liveblocks/emails
- Remove deprecated
htmlBody
/reactBody
properties from
prepareThreadNotificationEmailAsHtml
/prepareThreadNotificationEmailAsReact
,
use body
instead.
- Remove
htmlContent
/reactContent
properties from
prepareTextMentionNotificationEmailAsHtml
/prepareTextMentionNotificationEmailAsReact
,
use content
instead.
- The
prepareTextMentionNotificationEmailAsReact
and
prepareTextMentionNotificationEmailAsHtml
functions’ returned data changed
slightly:
- The
id
property is now named textMentionId
, it refers to the mention’s
Text Mention ID, not the user ID used for the mention
- The
id
property now refers to the mention’s ID, as in the user ID used for
the mention
- The
element
prop received by the Mention
component in
prepareTextMentionNotificationEmailAsReact
now contains an id
property
instead of userId
, and a new kind
property to indicate the mention’s kind.
@liveblocks/client
and @liveblocks/node
- The
getMentionedIdsFromCommentBody
utility has been replaced by
getMentionsFromCommentBody
.