Interface UseDocumentSuspendingParams

A hook which returns a document and a function to change it. Uses React Suspense for loading states, returning a tuple matching useState pattern.

Example

function Counter() {
  const [doc, changeDoc] = useDocument<{ count: number }>(docUrl)
  return (
    <button onClick={() => changeDoc(d => d.count++)}>
      Count: {doc.count}
    </button>
  )
}

// Must be wrapped in Suspense boundary
<Suspense fallback={<Loading />}>
  <Counter />
</Suspense>

interface UseDocumentSuspendingParams {
suspense: true;
}

Index

Properties

Properties

suspense

suspense: true