@canvus/core 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,8 +3,14 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@canvus/core)
|
|
4
4
|
[](LICENSE)
|
|
5
5
|
|
|
6
|
+
> ⚠️ **Beta Release (v0.1.2)**: Canvus is currently in active development (public beta). APIs and configuration options may evolve before the v1.0.0 stable release.
|
|
7
|
+
|
|
6
8
|
Canvus is a headless, framework-agnostic vanilla TypeScript SDK for building visual layout editing workspaces. By separating rendering and visual handles, it enables developers to construct CMS page-builder canvases, A/B testing editors, and high-performance visual IDE tools with web-native performance.
|
|
7
9
|
|
|
10
|
+
[Documentation](https://canvus.io/)
|
|
11
|
+
|
|
12
|
+
[Demo](https://canvus.io/playground)
|
|
13
|
+
|
|
8
14
|
---
|
|
9
15
|
|
|
10
16
|
## 🚀 Key Features
|
|
@@ -25,6 +31,9 @@ canvus/
|
|
|
25
31
|
├── demo/ # Dev Workbench (Interactive local testing site)
|
|
26
32
|
├── dist/ # Compiled SDK ESM build and type declarations
|
|
27
33
|
├── docs/ # Developer documentation & Architecture Decision Records (ADRs)
|
|
34
|
+
├── packages/ # Workspace monorepo packages
|
|
35
|
+
│ ├── react/ # React bindings (@canvus/react)
|
|
36
|
+
│ └── react-demo/ # React Demo App
|
|
28
37
|
├── src/ # SDK Core source code (TypeScript)
|
|
29
38
|
├── skills/ # Custom Agent/AI skills for codebase tasks
|
|
30
39
|
└── package.json # Scripts, build rules, and dependencies
|
|
@@ -37,12 +46,20 @@ For a detailed walkthrough of each source file and their individual roles, see t
|
|
|
37
46
|
## 🛠️ Quick Start
|
|
38
47
|
|
|
39
48
|
### 1. Installation
|
|
40
|
-
|
|
49
|
+
|
|
50
|
+
Install the core SDK:
|
|
41
51
|
```bash
|
|
42
52
|
npm install @canvus/core
|
|
43
53
|
```
|
|
44
54
|
|
|
55
|
+
Or install the React bindings:
|
|
56
|
+
```bash
|
|
57
|
+
npm install @canvus/react @canvus/core
|
|
58
|
+
```
|
|
59
|
+
|
|
45
60
|
### 2. Basic Usage
|
|
61
|
+
|
|
62
|
+
#### Vanilla TS/JS
|
|
46
63
|
Import and initialize a workspace in your project:
|
|
47
64
|
```ts
|
|
48
65
|
import { Workspace } from "@canvus/core";
|
|
@@ -55,6 +72,20 @@ const workspace = new Workspace(container, {
|
|
|
55
72
|
});
|
|
56
73
|
```
|
|
57
74
|
|
|
75
|
+
#### React
|
|
76
|
+
See the [@canvus/react README](packages/react/README.md) for full instructions:
|
|
77
|
+
```tsx
|
|
78
|
+
import { Canvus } from "@canvus/react";
|
|
79
|
+
|
|
80
|
+
function App() {
|
|
81
|
+
return (
|
|
82
|
+
<Canvus style={{ width: "100%", height: "100vh" }}>
|
|
83
|
+
{/* Canvas workspace children */}
|
|
84
|
+
</Canvus>
|
|
85
|
+
);
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
58
89
|
The SDK exports all core primitives — see the [API Reference](docs/api.md) for the full surface.
|
|
59
90
|
|
|
60
91
|
### 3. Development (Contributing)
|