@automerge/automerge-repo-react-hooks
v1.1.9
Published
Hooks to access an Automerge Repo from your react app.
Downloads
2,984
Readme
React Hooks for Automerge Repo
These hooks are provided as helpers for using Automerge in your React project.
useLocalAwareness & useRemoteAwareness
These hooks implement ephemeral awareness/presence, similar to Yjs Awareness. They allow temporary state to be shared, such as cursor positions or peer online/offline status.
Ephemeral messages are replicated between peers, but not saved to the Automerge doc, and are used for temporary updates that will be discarded.
useRepo/RepoContext
Use RepoContext to set up react context for an Automerge repo. Use useRepo to lookup the repo from context. Most hooks depend on RepoContext being available.
useDocument
Return a document & updater fn, by ID.
useHandle
Return a handle, by ID.