@upmade/vue-editor 0.6.2 → 0.6.3

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.
Files changed (3) hide show
  1. package/LICENSE.md +21 -21
  2. package/README.md +95 -95
  3. package/package.json +42 -42
package/LICENSE.md CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 Lukas Mühlenbeck
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Lukas Mühlenbeck
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,95 +1,95 @@
1
- # Upmade Editor for Vue
2
-
3
- Build infinite canvas and collaborative whiteboard experiences in Vue with Upmade's native wrapper and TypeScript-first API.
4
-
5
- Upmade is a framework-agnostic infinite canvas and collaborative whiteboard engine. It provides web components that work natively in any framework, with a first-class Vue wrapper for idiomatic template integration.
6
-
7
- Upmade handles the hard parts of canvas-based applications — infinite pan and zoom, hit-testing, CRDT-based collaboration, undo and redo, and cross-browser rendering — so you can focus on your product's domain logic.
8
-
9
- **Full documentation:** [upmade.io/docs/vue/getting-started/quick-start](https://upmade.io/docs/vue/getting-started/quick-start)
10
-
11
- ## Installation
12
-
13
- ```bash
14
- npm install @upmade/vue-editor
15
- ```
16
-
17
- ## Setup
18
-
19
- Render Upmade in your component:
20
-
21
- ```html
22
- <script setup lang="ts">
23
- import { UpmadeEditor } from '@upmade/vue-editor'
24
- </script>
25
-
26
- <template>
27
- <UpmadeEditor style="display: block; width: 100%; height: 100vh" />
28
- </template>
29
- ```
30
-
31
- This renders the editor with the **full default toolbar**: selection, brush, eraser, line, shape, text, and image tools.
32
-
33
- ## Optional Enhancements
34
-
35
- ### Persist Canvas State
36
-
37
- By default, the editor uses an empty sync provider list, so canvas state is reset on reload. To persist objects locally across page reloads, configure `syncConfig` explicitly with `IndexedDBSyncProvider`.
38
-
39
- ```html
40
- <script setup lang="ts">
41
- import { UpmadeEditor, IndexedDBSyncProvider } from '@upmade/vue-editor'
42
-
43
- const syncConfig = {
44
- providers: [IndexedDBSyncProvider],
45
- }
46
- </script>
47
-
48
- <template>
49
- <UpmadeEditor :syncConfig="syncConfig" style="display: block; width: 100%; height: 100vh" />
50
- </template>
51
- ```
52
-
53
- ### Apply Full Viewport Styling
54
-
55
- To ensure the Upmade editor occupies the entire viewport and prevents unwanted scrolling, add the following CSS to your global stylesheet (e.g. `styles.css`):
56
-
57
- ```css
58
- html,
59
- body,
60
- #app {
61
- width: 100dvw;
62
- height: 100dvh;
63
- margin: 0;
64
- padding: 0;
65
- overflow: hidden;
66
- }
67
- ```
68
-
69
- ### Include Mobile Viewport Meta Tag
70
-
71
- For optimal rendering and responsiveness on mobile devices, add this meta tag within the `<head>` section of your `index.html`:
72
-
73
- ```html
74
- <meta
75
- name="viewport"
76
- content="viewport-fit=cover, width=device-width, initial-scale=1.0, user-scalable=no, maximum-scale=1.0, minimum-scale=1.0, interactive-widget=resizes-content"
77
- />
78
- ```
79
-
80
- ## Fundamentals
81
-
82
- Upmade is composed of a small set of core concepts that work together to power your canvas experience:
83
-
84
- - **[Components](https://upmade.io/docs/vue/getting-started/basic-usage)** — Two entry points, a batteries-included editor and a headless engine, to match any integration style.
85
- - **[Tools](https://upmade.io/docs/vue/fundamentals/tools)** — State-machine interaction handlers that define how users draw, select, and manipulate the canvas.
86
- - **[Objects](https://upmade.io/docs/vue/fundamentals/objects)** — The visual building blocks on the canvas, such as paths, shapes, text, and images with shared spatial properties.
87
- - **[Workspaces](https://upmade.io/docs/vue/fundamentals/workspaces)** — Containers that manage an entire canvas collection, view state, and editor configuration.
88
- - **[Theming](https://upmade.io/docs/vue/customization/themes)** — Built-in light and dark themes with full CSS variable customization to match your brand.
89
- - **[Collaboration](https://upmade.io/docs/vue/advanced/collaboration)** — Real-time multi-user sync powered by Yjs CRDTs with pluggable transport providers.
90
-
91
- Learn more in the [full documentation](https://upmade.io/docs/vue/getting-started/basic-usage).
92
-
93
- ## License
94
-
95
- Upmade is released under the [MIT License](./LICENSE.md).
1
+ # Upmade Editor for Vue
2
+
3
+ Build infinite canvas and collaborative whiteboard experiences in Vue with Upmade's native wrapper and TypeScript-first API.
4
+
5
+ Upmade is a framework-agnostic infinite canvas and collaborative whiteboard engine. It provides web components that work natively in any framework, with a first-class Vue wrapper for idiomatic template integration.
6
+
7
+ Upmade handles the hard parts of canvas-based applications — infinite pan and zoom, hit-testing, CRDT-based collaboration, undo and redo, and cross-browser rendering — so you can focus on your product's domain logic.
8
+
9
+ **Full documentation:** [upmade.io/docs/vue/getting-started/quick-start](https://upmade.io/docs/vue/getting-started/quick-start)
10
+
11
+ ## Installation
12
+
13
+ ```bash
14
+ npm install @upmade/vue-editor
15
+ ```
16
+
17
+ ## Setup
18
+
19
+ Render Upmade in your component:
20
+
21
+ ```html
22
+ <script setup lang="ts">
23
+ import { UpmadeEditor } from '@upmade/vue-editor'
24
+ </script>
25
+
26
+ <template>
27
+ <UpmadeEditor style="display: block; width: 100%; height: 100vh" />
28
+ </template>
29
+ ```
30
+
31
+ This renders the editor with the **full default toolbar**: selection, brush, eraser, line, shape, text, and image tools.
32
+
33
+ ## Optional Enhancements
34
+
35
+ ### Persist Canvas State
36
+
37
+ By default, the editor uses an empty sync provider list, so canvas state is reset on reload. To persist objects locally across page reloads, configure `syncConfig` explicitly with `IndexedDBSyncProvider`.
38
+
39
+ ```html
40
+ <script setup lang="ts">
41
+ import { UpmadeEditor, IndexedDBSyncProvider } from '@upmade/vue-editor'
42
+
43
+ const syncConfig = {
44
+ providers: [IndexedDBSyncProvider],
45
+ }
46
+ </script>
47
+
48
+ <template>
49
+ <UpmadeEditor :syncConfig="syncConfig" style="display: block; width: 100%; height: 100vh" />
50
+ </template>
51
+ ```
52
+
53
+ ### Apply Full Viewport Styling
54
+
55
+ To ensure the Upmade editor occupies the entire viewport and prevents unwanted scrolling, add the following CSS to your global stylesheet (e.g. `styles.css`):
56
+
57
+ ```css
58
+ html,
59
+ body,
60
+ #app {
61
+ width: 100dvw;
62
+ height: 100dvh;
63
+ margin: 0;
64
+ padding: 0;
65
+ overflow: hidden;
66
+ }
67
+ ```
68
+
69
+ ### Include Mobile Viewport Meta Tag
70
+
71
+ For optimal rendering and responsiveness on mobile devices, add this meta tag within the `<head>` section of your `index.html`:
72
+
73
+ ```html
74
+ <meta
75
+ name="viewport"
76
+ content="viewport-fit=cover, width=device-width, initial-scale=1.0, user-scalable=no, maximum-scale=1.0, minimum-scale=1.0, interactive-widget=resizes-content"
77
+ />
78
+ ```
79
+
80
+ ## Fundamentals
81
+
82
+ Upmade is composed of a small set of core concepts that work together to power your canvas experience:
83
+
84
+ - **[Components](https://upmade.io/docs/vue/getting-started/basic-usage)** — Two entry points, a batteries-included editor and a headless engine, to match any integration style.
85
+ - **[Tools](https://upmade.io/docs/vue/fundamentals/tools)** — State-machine interaction handlers that define how users draw, select, and manipulate the canvas.
86
+ - **[Objects](https://upmade.io/docs/vue/fundamentals/objects)** — The visual building blocks on the canvas, such as paths, shapes, text, and images with shared spatial properties.
87
+ - **[Workspaces](https://upmade.io/docs/vue/fundamentals/workspaces)** — Containers that manage an entire canvas collection, view state, and editor configuration.
88
+ - **[Theming](https://upmade.io/docs/vue/customization/themes)** — Built-in light and dark themes with full CSS variable customization to match your brand.
89
+ - **[Collaboration](https://upmade.io/docs/vue/advanced/collaboration)** — Real-time multi-user sync powered by Yjs CRDTs with pluggable transport providers.
90
+
91
+ Learn more in the [full documentation](https://upmade.io/docs/vue/getting-started/basic-usage).
92
+
93
+ ## License
94
+
95
+ Upmade is released under the [MIT License](./LICENSE.md).
package/package.json CHANGED
@@ -1,42 +1,42 @@
1
- {
2
- "name": "@upmade/vue-editor",
3
- "version": "0.6.2",
4
- "homepage": "https://upmade.io/",
5
- "description": "Upmade helps you build infinite canvas experiences with Vue.",
6
- "keywords": [
7
- "infinite canvas",
8
- "collaboration",
9
- "whiteboard",
10
- "drawing",
11
- "vue"
12
- ],
13
- "license": "MIT",
14
- "main": "dist/index.js",
15
- "types": "dist/index.d.ts",
16
- "directories": {
17
- "lib": "lib",
18
- "test": "__tests__"
19
- },
20
- "files": [
21
- "dist"
22
- ],
23
- "scripts": {
24
- "test": "echo \"Error: run tests from root\" && exit 1",
25
- "build": "npm run tsc",
26
- "tsc": "tsc -p . --outDir ./dist",
27
- "clean": "rimraf dist node_modules",
28
- "bump": "npm version patch",
29
- "release": "npm publish"
30
- },
31
- "bugs": {
32
- "url": "https://github.com/kasual1/kritzel/issues"
33
- },
34
- "publishConfig": {
35
- "access": "public"
36
- },
37
- "dependencies": {
38
- "@upmade/editor": "^0.6.2",
39
- "@upmade/engine": "^0.6.2",
40
- "@stencil/vue-output-target": "0.11.8"
41
- }
42
- }
1
+ {
2
+ "name": "@upmade/vue-editor",
3
+ "version": "0.6.3",
4
+ "homepage": "https://upmade.io/",
5
+ "description": "Upmade helps you build infinite canvas experiences with Vue.",
6
+ "keywords": [
7
+ "infinite canvas",
8
+ "collaboration",
9
+ "whiteboard",
10
+ "drawing",
11
+ "vue"
12
+ ],
13
+ "license": "MIT",
14
+ "main": "dist/index.js",
15
+ "types": "dist/index.d.ts",
16
+ "directories": {
17
+ "lib": "lib",
18
+ "test": "__tests__"
19
+ },
20
+ "files": [
21
+ "dist"
22
+ ],
23
+ "scripts": {
24
+ "test": "echo \"Error: run tests from root\" && exit 1",
25
+ "build": "npm run tsc",
26
+ "tsc": "tsc -p . --outDir ./dist",
27
+ "clean": "rimraf dist node_modules",
28
+ "bump": "npm version patch",
29
+ "release": "npm publish"
30
+ },
31
+ "bugs": {
32
+ "url": "https://github.com/kasual1/kritzel/issues"
33
+ },
34
+ "publishConfig": {
35
+ "access": "public"
36
+ },
37
+ "dependencies": {
38
+ "@upmade/editor": "^0.6.3",
39
+ "@upmade/engine": "^0.6.3",
40
+ "@stencil/vue-output-target": "0.11.8"
41
+ }
42
+ }