https://github.com/alterx/gundb-react-hooks
A set of React hooks that wrap around GunDB core functionality
https://github.com/alterx/gundb-react-hooks
gundb hooks react react-hooks reactjs
Last synced: over 1 year ago
JSON representation
A set of React hooks that wrap around GunDB core functionality
- Host: GitHub
- URL: https://github.com/alterx/gundb-react-hooks
- Owner: alterx
- License: mit
- Created: 2020-05-22T15:40:04.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T16:57:49.000Z (over 1 year ago)
- Last Synced: 2025-03-22T11:16:18.088Z (over 1 year ago)
- Topics: gundb, hooks, react, react-hooks, reactjs
- Language: TypeScript
- Homepage:
- Size: 538 KB
- Stars: 23
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GunDB React hooks
This is a set of hooks that wrap around GunDB core functionality.
API is subject to change, but will more or less remain similar.
## Installing
Use `pnpm`, `npm` or `yarn` to install the dependencies:
```
$ npm i @altrx/gundb-react-hooks
```
## Preact
If you need support for [Preact](https://preactjs.com/) you can import from `@altrx/gundb-react-hooks/preact` instead.
## Hooks
- [useGun](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGun.md)
- [useGunNamespace](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunNamespace.md)
- [useGunKeyAuth](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunKeyAuth.md)
- [useGunKeys](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunKeys.md)
- [useGunOnNodeUpdated](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunOnNodeUpdated.md)
- [useGunState](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunState.md)
- [useGunCollectionState](https://github.com/alterx/gundb-react-hooks/blob/master/docs/useGunCollectionState.md)
## Full Example
To see a full example visit https://github.com/alterx/gun-react-todoapp
## License
Licensed under [MIT](https://github.com/alterx/gundb-react-hooks/blob/master/LICENSE.md).