@glyphlab/diagram-react 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Subtubes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @glyphlab/diagram-react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The default React canvas for a `@glyphlab/diagram-core` controller: pan and zoom, nodes, groups and edges, drag and resize, connect by dragging, edit in place, colours, a right-click menu, and a read-only viewer. Peer dependencies: `react`, `zustand`, `@glyphlab/diagram-core`.
+
+```tsx
+import { createDiagramController } from '@glyphlab/diagram-core'
+import { DiagramCanvas, DiagramProvider, createDiagramInstance } from '@glyphlab/diagram-react'
+import '@glyphlab/diagram-react/theme.css'     // default colours; skip it if the host defines the variables itself
+import '@glyphlab/diagram-react/diagram.css'
+
+const controller = createDiagramController()
+const instance = createDiagramInstance(controller)   // one per diagram on the page
+
+<DiagramProvider instance={instance} slots={{ renderMarkdown }}>
+  <DiagramCanvas title="Orders" designKey="orders" empty={<strong>Nothing here yet</strong>} />
+</DiagramProvider>
+```
+
+- **What a person does is a change to the diagram**: each drag, resize, connect, edit, colour choice and delete is one `controller.apply({ source: 'user' })`. A host sees them all in `controller.onChange`.
+- **`DiagramInstance`** = a controller and the canvas state for it (view, selection, edit in progress, connect, highlights). When the diagram changes or another is loaded, the canvas lets go of what it can no longer show.
+- **Slots**: `renderMarkdown(source)` draws a node's content (plain text without it).
+  Optional `openNodeContent(id, section?)` adds a keyboard-accessible expand icon to editable nodes and calls the host to show the
+  full content, without dragging the node or starting inline editing. The host owns its drawer and edit/save UI.
+  The `empty` prop is what the canvas says when there is nothing on it.
+- **Hooks** for building around it: `useDiagram`, `useNodes`, `useEdges`, `useGroups`, `useMeta`, `useSelection`, `useViewport`, ... Each reads one slice of one store. `bindStore(api)` makes a global-style hook for code written that way.
+- **`DiagramViewer`**: a diagram from a file with no controller: pan, zoom, highlights. For saved copies, previews, pages that only show.
+- **Theme**: the canvas reads CSS variables only. `theme.css` lists them with light and dark values. Colour presets are `--c-red` ... `--c-gray`; a node's own `#rrggbb` is used as it is.
+
+Known issues: [docs/known-issues.md](docs/known-issues.md).