JSPM

react-appwrite-hooks

0.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6
  • Score
    100M100P100Q27715F
  • License MIT

React hooks for Appwrite.

Package Exports

  • react-appwrite-hooks
  • react-appwrite-hooks/account
  • react-appwrite-hooks/database
  • react-appwrite-hooks/functions

Readme

react-appwrite-hooks

React hooks for Appwrite. This library is a work-in-progress (as is Appwrite), and was inspired by react-firebase-hooks. Expect bugs, missing functionality, and outdated docs as this project continues to be developed.

Unless stated otherwise, all hooks support realtime capabilities, so you don't have to do any manual refreshing yourself.

The hooks follow this format:

const [value, isLoading, error] = useHook(appwrite, ...)

All hooks take your appwrite instance as their first parameter.

Available Hooks

Contributing

  1. Install pnpm if you don't already have it.

  2. Install dependencies with pnpm i

  3. Execute pnpm run dev in the root folder and start editing.

Follow these extra instructions if you'd like to test with the provided example project.

  1. In the example folder, rename .env.local.example to .env.local, and replace the variables inside of it with variables from your own local Appwrite installation.

  2. Open up another terminal that is also in the example folder.

  3. Install dependencies with pnpm i

  4. Execute pnpm run dev and start editing.

License

MIT