gongo-client-react
TypeScript icon, indicating that this package has built-in type declarations

0.5.2 • Public • Published

gongo-client-react

React hooks for gongo-client

Copyright(c) 2020 by Gadi Cohen dragon@wastelands.net. MIT licensed.

Project

Main project page https://github.com/gongojs/project

Quickstart

import React from 'react';
import { useGongoLive } from 'gongo-client-react';

function App() {
  // That's it.  The component will update on any relevant change.
  const data = useGongoLive( () => db.collection('test').find() );

  return (
    <ol>
      { data.map(row => <li><code>{JSON.strinigfy(row)}</code></li> }      
    </ol>
  );
}

Hooks

useGongoLive( funcThatReturnsACursor )

LiveQuery on a result set, returns an array.

Example:

const data = useGongoLive( db => db.collection('test').find() );

useGongoOne( funcThatReturnsACursor )

LiveQuery for a single result.

Example:

const user = useGongoOne( db => db.collection('users').find({ _id: userId }) );

useGongoUserId()

LiveQuery on current userId... non-null if user is logged in.

// const opts = {
//   db: force a specific database
// };
const userId = useGongoUserId(/* opts */);

Package Sidebar

Install

npm i gongo-client-react

Weekly Downloads

5

Version

0.5.2

License

MIT

Unpacked Size

39.4 kB

Total Files

29

Last publish

Collaborators

  • gadicc