@flowspine/viewer
v0.1.1-beta.20260407.1
Published
Embeddable React viewer for Flowspine catalogs (beta, not production-ready)
Downloads
74
Maintainers
Readme
@flowspine/viewer
Embeddable React viewer for Flowspine catalogs.
Status
Beta / experimental. Not production-ready yet.
Install
pnpm add @flowspine/viewer@betaPeer dependencies:
pnpm add react react-domWhat It Does
- renders Flowspine process graphs from catalog data
- supports compact layouts and orientation switching
- provides node sidebar with summary/edges/issues/tests
- supports live catalog polling mode for local development
Basic Usage
import { FlowspineViewer } from "@flowspine/viewer";
export default function Page() {
return <FlowspineViewer />;
}The package auto-loads viewer styles and @xyflow/react base styles.
Runtime Requirements
The viewer expects catalog data compatible with Flowspine extractor/CLI output.
Recommended generation path:
pnpm exec flowspine build --glob "processes/**/*.ts" --out ".flowspine/catalog.json"Local Dev (Live Mode)
Terminal 1 (generate + watch):
pnpm exec flowspine watch --glob "processes/**/*.ts" --out "apps/viewer/public/catalog.json" --polling --poll-interval 250Terminal 2 (viewer app in this monorepo):
pnpm --filter @flowspine/viewer devInside viewer UI:
- set file URL to
/catalog.json - enable live update mode
- set polling interval as needed
Exports
FlowspineViewerAppShelluseViewerStore- viewer types
@flowspine/viewer/styles.css
Build And Test
pnpm --filter @flowspine/viewer build
pnpm --filter @flowspine/viewer testRelated
- Root docs:
README.md - Skills repo:
https://github.com/noarax/flowspine-skills.git
License
Apache 2.0
Copyright
Copyright (c) 2026 Flowspine contributors.
