Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove useBootstrap #285

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions packages/automerge-repo-react-hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

These hooks are provided as helpers for using Automerge in your React project.

#### [useBootstrap](./src/useBootstrap.ts)

This hook is used to load a document based on the URL hash, for example `//myapp/#documentId=[document ID]`.
It can also load the document ID from localStorage, or create a new document if none is specified.

#### [useLocalAwareness](./src/useLocalAwareness.ts) & [useRemoteAwareness](./src/useRemoteAwareness.ts)

These hooks implement ephemeral awareness/presence, similar to [Yjs Awareness](https://docs.yjs.dev/getting-started/adding-awareness).
Expand Down
5 changes: 0 additions & 5 deletions packages/automerge-repo-react-hooks/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
*
* These hooks are provided as helpers for using Automerge in your React project.
*
* #### {@link useBootstrap}
* This hook is used to load a document based on the URL hash, for example `//myapp/#documentId=[document ID]`.
* It can also load the document ID from localStorage, or create a new document if none is specified.
*
* #### {@link useLocalAwareness} & {@link useRemoteAwareness}
* These hooks implement ephemeral awareness/presence, similar to [Yjs Awareness](https://docs.yjs.dev/getting-started/adding-awareness).
* They allow temporary state to be shared, such as cursor positions or peer online/offline status.
Expand Down Expand Up @@ -86,7 +82,6 @@
*/
export { useDocument } from "./useDocument.js"
export { useDocuments } from "./useDocuments.js"
export { useBootstrap, type UseBootstrapOptions } from "./useBootstrap.js"
export { useHandle } from "./useHandle.js"
export { RepoContext, useRepo } from "./useRepo.js"
export {
Expand Down
111 changes: 0 additions & 111 deletions packages/automerge-repo-react-hooks/src/useBootstrap.ts

This file was deleted.