@progressdb/react
v0.2.1
Published
React hooks and provider for ProgressDB frontend SDK
Readme
@progressdb/react
ProgressDB React SDK with provider and hooks.
Installation
npm install @progressdb/react @progressdb/jsQuick Start
import React from 'react';
import ProgressDBProvider, { useMessages } from '@progressdb/react';
function MessagesView({ threadId }: { threadId: string }){
const { messages, loading, refresh, create } = useMessages(threadId);
// ... render messages
}
export default function App(){
return (
<ProgressDBProvider
options={{ baseUrl: 'https://api.example.com', apiKey: 'FRONTEND_API_KEY' }}
getUserSignature={async () => ({ userId: 'user123', signature: 'signature' })}
>
<MessagesView threadId="t1" />
</ProgressDBProvider>
);
}API
Provider
ProgressDBProvider- Wrap app with provider
Hooks
useProgressClient()- Get client instanceuseUserSignature()- Get user signatureuseMessages(threadKey, query)- List messages in threaduseMessage(threadKey, messageKey)- Get single messageuseThreads(query)- List threadsuseHealthz()- Basic health checkuseReadyz()- Readiness check with version
