@liveblocks/yjs
Advanced tools
An integration with . Liveblocks is the all-in-one toolkit to build collaborative products like Figma, Notion, and more.
@liveblocks/yjs@liveblocks/yjs is a Yjs provider to integrate
Yjs applications with Liveblocks—a platform to
build, host, and scale collaborative applications with zero configuration, no
maintenance required.
npm install @liveblocks/client @liveblocks/yjs
Read the documentation for guides and API references.
Explore our collaborative examples to help you get started.
All examples are open-source and live in this repository, within
/examples.
See the latest changes or learn more about upcoming releases.
Licensed under the Apache License 2.0, Copyright © 2021-present Liveblocks.
See LICENSE for more information.
2.12.0
This release adds support for tracking synchronization status of pending local changes for any part of Liveblocks. Whether you use Storage, Text Editors, Threads, or Notifications.
If the client’s sync status is synchronized, it means all local pending
changes have been persisted by our servers. If there are pending local changes
in any part of Liveblocks you’re using, then the client’s sync status will be
synchronizing.
Also, we’re introducing a way to prevent browser tabs from being closed while
local changes are not yet synchronized. To opt-in to this protection, enable
preventUnsavedChanges option on the client:
<LiveblocksProvider preventUnsavedChanges />createClient({ preventUnsavedChanges: true })@liveblocks/clientclient.getSyncStatus()
method.preventUnsavedChanges.ToImmutable<T> helper type.@liveblocks/reactuseSyncStatus
that can be used to tell whether Liveblocks is synchronizing local changes to
the server. Useful to display a "Saving..." spinner in your application, when
used with useSyncStatus({ smooth: true }).useStorageStatus is now deprecated in favor of useSyncStatus.@liveblocks/react-uipreventUnsavedChanges option is
set.@liveblocks/react-lexicaluseIsEditorReady which can be used to show a skeleton UI before
the editor has received the initial text from the server.useEditorStatus is now deprecated in favor of useIsEditorReady (or
useSyncStatus).FAQs
An integration with . Liveblocks is the all-in-one toolkit to build collaborative products like Figma, Notion, and more.
We found that @liveblocks/yjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.