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.
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.
React Hooks for Automerge Repo
These hooks are provided as helpers for using Automerge in your React project.
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 the current state of a document (or undefined) and a change function.
useHandle
Return a DocHandle by passing in a DocumentURL.
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.