@mocanvas/editor 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Symbio Digital
+
+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

@@ -0,0 +1,64 @@
+# @mocanvas/editor
+
+The editor core of [mocanvas](https://github.com/SYMBIO/mocanvas), without the
+default shapes, tools and UI: the `Editor` facade, `ShapeUtil` and
+`BindingUtil`, the `StateNode` tool state machine, geometry, snapping, history,
+textures, and the `<Canvas />` React renderer with its WebGL2 backend.
+
+Use this package when you want to build your own shape set and UI. If you want
+a canvas that works out of the box, use `mocanvas`.
+
+## Install
+
+```bash
+npm install @mocanvas/editor react react-dom
+```
+
+`react` and `react-dom` (>= 18) are peer dependencies.
+
+## Use
+
+```tsx
+import { Canvas, Editor, createStore, loadEngine } from "@mocanvas/editor"
+import { useEffect, useRef, useState } from "react"
+
+export function MyCanvas() {
+  const container = useRef<HTMLDivElement>(null)
+  const [editor, setEditor] = useState<Editor | null>(null)
+
+  useEffect(() => {
+    let disposed = false
+    loadEngine().then((engine) => {
+      if (disposed) return engine.dispose()
+      setEditor(
+        new Editor({
+          store: createStore(),
+          shapeUtils: [], // your ShapeUtils
+          tools: [], // your StateNodes
+          engine,
+          getContainer: () => container.current!,
+        }),
+      )
+    })
+    return () => {
+      disposed = true
+    }
+  }, [])
+
+  return (
+    <div ref={container} style={{ position: "absolute", inset: 0 }}>
+      {editor && <Canvas editor={editor} />}
+    </div>
+  )
+}
+```
+
+Writing a shape util and its tool is covered in
+[docs/CUSTOM_SHAPES.md](https://github.com/SYMBIO/mocanvas/blob/main/docs/CUSTOM_SHAPES.md).
+
+ESM only. The WebAssembly engine is loaded from `@mocanvas/wasm`; see that
+package's README for how the `.wasm` file is resolved by your bundler.
+
+## License
+
+MIT