React Hooks for Typesaurus, type-safe Firestore ODM
npm install reactopodReact Hooks for Typesaurus, type-safe Firestore ODM.
The library is available as an npm package.
To install Reactopod run:
``shReact:
npm install reactopod --saveOr using Yarn:
yarn add reactopod
_Note that Reactopod has Typesaurus listed as a peer dependency which also requires
package to work in the web environment. The latter isn't listed in dependencies, so make sure you did install both. For more info about Typesaurus dependencies, refer to its Installation section of README. Also, if you have to have react or preact installed for reactopod and preactopod respectively._Get started
$3
To start working with Reactopod, initialize Firebase normally:
`ts
import * as firebase from 'firebase/app'
import 'firebase/firestore'firebase.initializeApp({
// Project configuration
})
`See Firebase docs for more info.
$3
Use
hook to fetch document with the given id.`ts
import React from 'react'
import { useGet } from 'reactopod'
import { collection } from 'typesaurus'type User = { name: string }
const users = collection('users')
function Component({ userId }: { userId: string }) {
const user = useGet(users, userId)
return user ?
Hello, {user.data.name} : Loading...
}
`Use
hook to subscribe to a document with the given id. When the document changes you'll receive the new data automatically.`ts
import React from 'react'
import { useOnGet } from 'reactopod'
import { collection } from 'typesaurus'type User = { name: string }
const users = collection('users')
function Component({ userId }: { userId: string }) {
const user = useGet(users, userId)
return user ?
Hello, {user.data.name} : Loading...
}
`$3
Use
hook to fetch all documents from a collection.`ts
import React from 'react'
import { useAll } from 'reactopod'
import { collection } from 'typesaurus'type User = { name: string }
const users = collection('users')
function Component() {
const allUsers = useAll(users)
return allUsers ? (
{allUsers.map(user => (
- {user.data.name}
))}
) : (
Loading...
)
}
`Use
hook to subscribe to all documents within a collection. When a document in the collection changes you'll receive the new data.`ts
import React from 'react'
import { useOnAll } from 'reactopod'
import { collection } from 'typesaurus'type User = { name: string }
const users = collection('users')
function Component() {
const allUsers = useOnAll(users)
return allUsers ? (
{allUsers.map(user => (
- {user.data.name}
))}
) : (
Loading...
)
}
`$3
Use
hook to query documents from a collection using using query objects.`ts
import React from 'react'
import { useQuery } from 'reactopod'
import { collection, where } from 'typesaurus'type Game = { title: string; platform: 'switch' | 'xbox' | 'ps' | 'pc' }
const games = collection('games')
function Component() {
const switchGames = useQuery(games, [where('platform', '==', 'switch')])
return switchGames ? (
{switchGames.map(game => (
- {game.data.title}
))}
) : (
Loading...
)
}
`Use
hook to subscribe to a query results. When the result changes you'll receive the new data.`ts
import React from 'react'
import { useOnQuery } from 'reactopod'
import { collection, where } from 'typesaurus'type Game = { title: string; platform: 'switch' | 'xbox' | 'ps' | 'pc' }
const games = collection('games')
function Component() {
const switchGames = useOnQuery(games, [where('platform', '==', 'switch')])
return switchGames ? (
{switchGames.map(game => (
- {game.data.title}
))}
) : (
Loading...
)
}
`See Typesaurus documentation for more info about the query objects:
- Creates order query object with given field, ordering method and pagination cursors.
- limit - Creates a limit query object. It's used to paginate queries.
- where - Creates where query with array-contains filter operation.Pagination helpers:
endAt - Ends the query results on the given value.
- endBefore - Ends the query results before the given value.
- startAfter - Start the query results after the given value.
- startAt - Start the query results on the given value.$3
Use
useInfiniteQuery to query documents with pagination.The function returns an array where the first element is the result and the second is
loadMore. loadMore is undefined when the result is loading. loadMore is null when there're no more data to load. Otherwise loadMore is a function that triggers loading of the next page.`ts
import React from 'react'
import { useInfiniteQuery } from 'reactopod'
import { collection, where } from 'typesaurus'type Game = {
title: string
platform: 'switch' | 'xbox' | 'ps' | 'pc'
publishedAt: Date
}
const games = collection('games')
function Component() {
const [switchGames, loadMore] = useInfiniteQuery(
games,
[where('platform', '==', 'switch')],
{ field: 'publishedAt', method: 'desc', limit: 10 }
)
return switchGames ? (
{switchGames.map(game => (
- {game.data.title}
))}
{loadMore === undefined ? (
Loading more...
) : loadMore === null ? null : (
)}
) : (
Loading...
)
}
`Combine
with useInfiniteScroll to implement the infinite scroll.useInfiniteScroll accepts two arguments. The first is the scroll threshold. If you pass 1.5, then more results will load when the scroll position is more than full height minus 1.5 x screen height. The second argument is loadMore function returned from useInfiniteQuery.`ts
import React from 'react'
import { useInfiniteQuery, useInfiniteScroll } from 'reactopod'
import { collection, where } from 'typesaurus'type Game = {
title: string
platform: 'switch' | 'xbox' | 'ps' | 'pc'
publishedAt: Date
}
const games = collection('games')
function Component() {
const [switchGames, loadMore] = useInfiniteQuery(
games,
[where('platform', '==', 'switch')],
{ field: 'publishedAt', method: 'desc', limit: 10 }
)
useInfiniteScroll(1.5, loadMore)
return switchGames ? (
{switchGames.map(game => (
- {game.data.title}
))}
) : (
Loading...
)
}
``See the changelog.