Back to Pglite

PGlite React.js Hooks

packages/pglite-react/README.md

0.1.81.2 KB
Original Source

PGlite React.js Hooks

This package implements React hooks for PGLite on top of the live query plugin. Full documentation is available at pglite.dev/docs/framework-hooks.

To install:

sh
npm install @electric-sql/pglite-react

The hooks this package provides are:

  • PGliteProvider: A Provider component to pass a PGlite instance to all child components for use with the other hooks.
  • usePGlite: Retrieve the provided PGlite instance.
  • makePGliteProvider: Create typed instances of PGliteProvider and usePGlite.
  • useLiveQuery: Reactively re-render your component whenever the results of a live query change
  • useLiveIncrementalQuery: Reactively re-render your component whenever the results of a live query change by offloading the diff to PGlite