diff options
| author | nexxeln <[email protected]> | 2025-11-22 07:04:05 +0000 |
|---|---|---|
| committer | nexxeln <[email protected]> | 2025-11-22 07:04:05 +0000 |
| commit | 895f37ac899597dc66c40fb94f9e5bb43d60a42a (patch) | |
| tree | d0825db4ba52cdf5f404058135a8f88961f77a6a /apps/memory-graph-playground/README.md | |
| parent | package the graph (#563) (diff) | |
| download | supermemory-proxy-graph-requests.tar.xz supermemory-proxy-graph-requests.zip | |
runtime styles injection + let user proxy requests for data in graph package + new playground (#588)proxy-graph-requests
Diffstat (limited to 'apps/memory-graph-playground/README.md')
| -rw-r--r-- | apps/memory-graph-playground/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/apps/memory-graph-playground/README.md b/apps/memory-graph-playground/README.md new file mode 100644 index 00000000..5c143d9b --- /dev/null +++ b/apps/memory-graph-playground/README.md @@ -0,0 +1,52 @@ +# Memory Graph Playground + +A demo app showcasing the `@supermemory/memory-graph` package. + +## Getting Started + +```bash +bun install +bun dev +``` + +Open [http://localhost:3000](http://localhost:3000) and enter your Supermemory API key. + +## Usage Example + +```tsx +import { MemoryGraph, type DocumentWithMemories } from '@supermemory/memory-graph' + +function App() { + const [documents, setDocuments] = useState<DocumentWithMemories[]>([]) + + return ( + <MemoryGraph + documents={documents} + isLoading={false} + isLoadingMore={false} + error={null} + hasMore={false} + loadMoreDocuments={() => {}} + totalLoaded={documents.length} + variant="console" + showSpacesSelector={true} + > + <div>No memories found</div> + </MemoryGraph> + ) +} +``` + +## Props + +| Prop | Type | Description | +|------|------|-------------| +| `documents` | `DocumentWithMemories[]` | Array of documents to display | +| `isLoading` | `boolean` | Initial loading state | +| `isLoadingMore` | `boolean` | Loading more documents state | +| `error` | `Error \| null` | Error to display | +| `hasMore` | `boolean` | Whether more documents can be loaded | +| `loadMoreDocuments` | `() => void` | Callback to load more documents | +| `totalLoaded` | `number` | Total number of loaded documents | +| `variant` | `"default" \| "console"` | Visual theme variant | +| `showSpacesSelector` | `boolean` | Show space filter dropdown | |