kritzel-vue 0.3.15 → 0.3.17

package/LICENSE.md

@@ -0,0 +1,50 @@
+# Software License Agreement
+
+**IMPORTANT NOTICE:** This is a source-available, non-commercial license. 
+* **Hobbyists & Personal Use:** 100% Free. You are welcome to use, modify, and experiment with this software for personal, hobby, or educational projects.
+* **Commercial & Professional Use:** Strictly Prohibited. If you want to use this software in a corporate environment, for professional client work, or as part of a revenue-generating product, you must obtain a commercial license.
+
+To purchase a commercial license, please visit: https://kritzel.io
+
+---
+
+## PolyForm Noncommercial License 1.0.0
+
+### Acceptance
+By using or distributing this software, you accept this license.
+
+### User
+You is the person or organization who accepts this license. You can accept this license for only yourself or for an organization.
+
+### Software
+Software is the software that includes this license text.
+
+### Practice
+Practice is to use, copy, modify, distribute, or make derivative works of the Software.
+
+### Grant
+You may Practice the Software for noncommercial purposes.
+
+### Noncommercial Purposes
+Noncommercial purposes are purposes that are not commercial purposes.
+
+### Commercial Purposes
+Commercial purposes are purposes intended for or directed toward commercial advantage or monetary compensation. Commercial purposes include, but are not limited to, using the Software to provide services to others for a fee, using the Software as part of a product sold or licensed to others, or using the Software inside a business or for professional work.
+
+### Redistribution
+You may redistribute copies of the Software, with or without modification, provided that you include this license text with every copy.
+
+### Notices
+You must ensure that any copy of the Software you distribute includes all copyright notices, trademark notices, and other legal notices included in the Software.
+
+### No Other Rights
+This license does not grant any patent rights or trademark rights.
+
+### Termination
+If you violate any term of this license, your rights under this license terminate immediately.
+
+### Defensive Patent Claims
+If you make a patent claim against anyone alleging that the Software infringes a patent, your rights under this license terminate immediately.
+
+### No Warranty
+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,31 +1,95 @@
-# Setup
+# Kritzel for Vue
 
-Install the kritzel-vue package.
-```
-npm i kritzel-vue
+Build infinite canvas and collaborative whiteboard experiences in Vue with Kritzel's native wrapper and TypeScript-first API.
+
+Kritzel 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.
+
+Kritzel 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.
+
+📖 **Full documentation:** [kritzel.io/docs/vue/overview](https://kritzel.io/docs/vue/overview)
+
+## Installation
+
+```bash
+npm install kritzel-vue
 ```
 
-Import the ComponentLibrary and register it as a plugin.
-```typescript
-import { createApp } from 'vue'
-import App from './App.vue'
-import { ComponentLibrary } from 'kritzel-vue'
+## Setup
 
-createApp(App).use(ComponentLibrary).mount('#app')
+Render Kritzel in your component:
+
+```html
+<script setup lang="ts">
+import { KritzelEditor } from 'kritzel-vue'
+</script>
 
+<template>
+  <KritzelEditor style="display: block; width: 100%; height: 100vh" />
+</template>
 ```
 
-Import Kritzel components to use them in your template.
+This renders the editor with the **full default toolbar**: selection, brush, eraser, line, shape, text, and image tools.
+
+## Optional Enhancements
+
+### Persist Canvas State
+
+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`.
+
 ```html
 <script setup lang="ts">
-import { KritzelEngine, KritzelControls } from 'kritzel-vue';
+import { KritzelEditor, IndexedDBSyncProvider } from 'kritzel-vue'
+
+const syncConfig = {
+  providers: [IndexedDBSyncProvider],
+}
 </script>
 
 <template>
-  <KritzelEngine></KritzelEngine>
-  <KritzelControls></KritzelControls>
+  <KritzelEditor :syncConfig="syncConfig" style="display: block; width: 100%; height: 100vh" />
 </template>
+```
+
+### Apply Full Viewport Styling
+
+To ensure the Kritzel editor occupies the entire viewport and prevents unwanted scrolling, add the following CSS to your global stylesheet (e.g. `styles.css`):
 
-<style scoped>
-</style>
+```css
+html,
+body,
+#app {
+  width: 100dvw;
+  height: 100dvh;
+  margin: 0;
+  padding: 0;
+  overflow: hidden;
+}
 ```
+
+### Include Mobile Viewport Meta Tag
+
+For optimal rendering and responsiveness on mobile devices, add this meta tag within the `<head>` section of your `index.html`:
+
+```html
+<meta
+  name="viewport"
+  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"
+/>
+```
+
+## Core Concepts
+
+Kritzel is composed of a small set of core concepts that work together to power your canvas experience:
+
+- **Components** — Two entry points, a batteries-included editor and a headless engine, to match any integration style.
+- **Tools** — State-machine interaction handlers that define how users draw, select, and manipulate the canvas.
+- **Objects** — The visual building blocks on the canvas, such as paths, shapes, text, and images with shared spatial properties.
+- **Workspaces** — Containers that manage an entire canvas collection, view state, and editor configuration.
+- **Theming** — Built-in light and dark themes with full CSS variable customization to match your brand.
+- **Collaboration** — Real-time multi-user sync powered by Yjs CRDTs with pluggable transport providers.
+
+Learn more in the [full documentation](https://kritzel.io/docs/vue/overview).
+
+## License
+
+See [LICENSE.md](./LICENSE.md). Kritzel is free for personal, hobby, and educational use. Commercial use requires a license — visit [kritzel.io](https://kritzel.io) for details.

package/dist/components.d.ts

@@ -6,6 +6,7 @@ export declare const KritzelButton: StencilVueComponent<JSX.KritzelButton>;
 export declare const KritzelCurrentUserDialog: StencilVueComponent<JSX.KritzelCurrentUserDialog>;
 export declare const KritzelDialog: StencilVueComponent<JSX.KritzelDialog>;
 export declare const KritzelEditor: StencilVueComponent<JSX.KritzelEditor>;
+export declare const KritzelEngine: StencilVueComponent<JSX.KritzelEngine>;
 export declare const KritzelExport: StencilVueComponent<JSX.KritzelExport>;
 export declare const KritzelInput: StencilVueComponent<JSX.KritzelInput>;
 export declare const KritzelLineEndings: StencilVueComponent<JSX.KritzelLineEndings>;
@@ -15,3 +16,5 @@ export declare const KritzelNumericInput: StencilVueComponent<JSX.KritzelNumeric
 export declare const KritzelOpacitySlider: StencilVueComponent<JSX.KritzelOpacitySlider>;
 export declare const KritzelPillTabs: StencilVueComponent<JSX.KritzelPillTabs>;
 export declare const KritzelSettings: StencilVueComponent<JSX.KritzelSettings>;
+export declare const KritzelWatermark: StencilVueComponent<JSX.KritzelWatermark>;
+export declare const KritzelZoomPanel: StencilVueComponent<JSX.KritzelZoomPanel>;

package/dist/components.js

@@ -8,6 +8,7 @@ import { defineCustomElement as defineKritzelButton } from '../../kritzel-stenci
 import { defineCustomElement as defineKritzelCurrentUserDialog } from '../../kritzel-stencil/dist/components/kritzel-current-user-dialog.js';
 import { defineCustomElement as defineKritzelDialog } from '../../kritzel-stencil/dist/components/kritzel-dialog.js';
 import { defineCustomElement as defineKritzelEditor } from '../../kritzel-stencil/dist/components/kritzel-editor.js';
+import { defineCustomElement as defineKritzelEngine } from '../../kritzel-stencil/dist/components/kritzel-engine.js';
 import { defineCustomElement as defineKritzelExport } from '../../kritzel-stencil/dist/components/kritzel-export.js';
 import { defineCustomElement as defineKritzelInput } from '../../kritzel-stencil/dist/components/kritzel-input.js';
 import { defineCustomElement as defineKritzelLineEndings } from '../../kritzel-stencil/dist/components/kritzel-line-endings.js';
@@ -17,6 +18,8 @@ import { defineCustomElement as defineKritzelNumericInput } from '../../kritzel-
 import { defineCustomElement as defineKritzelOpacitySlider } from '../../kritzel-stencil/dist/components/kritzel-opacity-slider.js';
 import { defineCustomElement as defineKritzelPillTabs } from '../../kritzel-stencil/dist/components/kritzel-pill-tabs.js';
 import { defineCustomElement as defineKritzelSettings } from '../../kritzel-stencil/dist/components/kritzel-settings.js';
+import { defineCustomElement as defineKritzelWatermark } from '../../kritzel-stencil/dist/components/kritzel-watermark.js';
+import { defineCustomElement as defineKritzelZoomPanel } from '../../kritzel-stencil/dist/components/kritzel-zoom-panel.js';
 export const KritzelAwarenessCursors = /*@__PURE__*/ defineContainer('kritzel-awareness-cursors', defineKritzelAwarenessCursors, [
     'core',
     'showEdgeIndicators',
@@ -38,7 +41,8 @@ export const KritzelButton = /*@__PURE__*/ defineContainer('kritzel-button', def
     'buttonClick'
 ]);
 export const KritzelCurrentUserDialog = /*@__PURE__*/ defineContainer('kritzel-current-user-dialog', defineKritzelCurrentUserDialog, [
-    'user'
+    'user',
+    'terms'
 ]);
 export const KritzelDialog = /*@__PURE__*/ defineContainer('kritzel-dialog', defineKritzelDialog, [
     'isOpen',
@@ -65,7 +69,6 @@ export const KritzelEditor = /*@__PURE__*/ defineContainer('kritzel-editor', def
     'viewportBoundaryRight',
     'viewportBoundaryTop',
     'viewportBoundaryBottom',
-    'wheelEnabled',
     'debugInfo',
     'user',
     'activeUsers',
@@ -74,11 +77,18 @@ export const KritzelEditor = /*@__PURE__*/ defineContainer('kritzel-editor', def
     'objectContextMenuItems',
     'themes',
     'theme',
+    'licenseKey',
+    'locale',
+    'locales',
+    'fallbackLocale',
     'customSvgIcons',
+    'isPanningEnabled',
+    'isZoomingEnabled',
     'isControlsVisible',
     'isUtilityPanelVisible',
     'isWorkspaceManagerVisible',
     'isMoreMenuVisible',
+    'isZoomPanelVisible',
     'isObjectDistanceFadingActive',
     'syncConfig',
     'assetStorageConfig',
@@ -95,6 +105,7 @@ export const KritzelEditor = /*@__PURE__*/ defineContainer('kritzel-editor', def
     'objectsUpdated',
     'undoStateChange',
     'themeChange',
+    'localeChange',
     'viewportChange',
     'logout',
     'login',
@@ -109,14 +120,74 @@ export const KritzelEditor = /*@__PURE__*/ defineContainer('kritzel-editor', def
     'objectsUpdated',
     'undoStateChange',
     'themeChange',
+    'localeChange',
     'viewportChange',
     'logout',
     'login',
     'isPublicChange',
     'awarenessChange'
 ]);
+export const KritzelEngine = /*@__PURE__*/ defineContainer('kritzel-engine', defineKritzelEngine, [
+    'workspace',
+    'editorId',
+    'activeWorkspaceId',
+    'syncConfig',
+    'assetStorageConfig',
+    'user',
+    'globalContextMenuItems',
+    'objectContextMenuItems',
+    'scaleMax',
+    'scaleMin',
+    'cursorTarget',
+    'lockDrawingScale',
+    'isObjectDistanceFadingActive',
+    'theme',
+    'licenseKey',
+    'themes',
+    'locale',
+    'locales',
+    'fallbackLocale',
+    'viewportBoundaryLeft',
+    'viewportBoundaryRight',
+    'viewportBoundaryTop',
+    'viewportBoundaryBottom',
+    'debugInfo',
+    'isPanningEnabled',
+    'isZoomingEnabled',
+    'isLoading',
+    'isEngineReady',
+    'activeToolChange',
+    'objectsSelectionChange',
+    'workspacesChange',
+    'activeWorkspaceChange',
+    'longpress',
+    'objectsChange',
+    'objectsAdded',
+    'objectsRemoved',
+    'objectsUpdated',
+    'undoStateChange',
+    'objectsInViewportChange',
+    'viewportChange',
+    'awarenessChange'
+], [
+    'isEngineReady',
+    'activeToolChange',
+    'objectsSelectionChange',
+    'workspacesChange',
+    'activeWorkspaceChange',
+    'longpress',
+    'objectsChange',
+    'objectsAdded',
+    'objectsRemoved',
+    'objectsUpdated',
+    'undoStateChange',
+    'objectsInViewportChange',
+    'viewportChange',
+    'awarenessChange'
+]);
 export const KritzelExport = /*@__PURE__*/ defineContainer('kritzel-export', defineKritzelExport, [
     'workspaceName',
+    'terms',
     'exportPng',
     'exportSvg',
     'exportJson'
@@ -190,9 +261,26 @@ export const KritzelPillTabs = /*@__PURE__*/ defineContainer('kritzel-pill-tabs'
 ]);
 export const KritzelSettings = /*@__PURE__*/ defineContainer('kritzel-settings', defineKritzelSettings, [
     'availableThemes',
+    'availableLocales',
     'shortcuts',
+    'terms',
     'settings',
     'settingsChange'
 ], [
     'settingsChange'
 ]);
+export const KritzelWatermark = /*@__PURE__*/ defineContainer('kritzel-watermark', defineKritzelWatermark, [
+    'core',
+    'label'
+]);
+export const KritzelZoomPanel = /*@__PURE__*/ defineContainer('kritzel-zoom-panel', defineKritzelZoomPanel, [
+    'visible',
+    'disabled',
+    'zoomPercent',
+    'terms',
+    'zoomIn',
+    'zoomOut'
+], [
+    'zoomIn',
+    'zoomOut'
+]);

package/dist/composables.d.ts

@@ -21,8 +21,17 @@
  * </script>
  *
  * <template>
- *   <KritzelEditor ref="editorComponent" @isReady="onReady" />
+ *   <KritzelEditor ref="editor" @isReady="onReady" />
  * </template>
  * ```
  */
 export declare function getEditorRef(componentRef: string): import("vue").ComputedRef<HTMLKritzelEditorElement | null>;
+/**
+ * Resolves the native Kritzel engine element from a specific Vue template ref.
+ *
+ * Because `<KritzelEngine>` is a Vue component (not a raw custom element),
+ * a template ref points to the component instance rather than the DOM element.
+ * Pass the same ref that is bound in your template to make sure the resolved
+ * engine always belongs to that exact component instance.
+ */
+export declare function getEngineRef(componentRef: string): import("vue").ComputedRef<HTMLKritzelEngineElement | null>;

package/dist/composables.js

@@ -22,7 +22,7 @@ import { computed, useTemplateRef, } from "vue";
  * </script>
  *
  * <template>
- *   <KritzelEditor ref="editorComponent" @isReady="onReady" />
+ *   <KritzelEditor ref="editor" @isReady="onReady" />
  * </template>
  * ```
  */
@@ -39,3 +39,24 @@ export function getEditorRef(componentRef) {
             : value;
     });
 }
+/**
+ * Resolves the native Kritzel engine element from a specific Vue template ref.
+ *
+ * Because `<KritzelEngine>` is a Vue component (not a raw custom element),
+ * a template ref points to the component instance rather than the DOM element.
+ * Pass the same ref that is bound in your template to make sure the resolved
+ * engine always belongs to that exact component instance.
+ */
+export function getEngineRef(componentRef) {
+    const engineComponent = useTemplateRef(componentRef);
+    return computed(() => {
+        var _a;
+        const value = engineComponent.value;
+        if (!value) {
+            return null;
+        }
+        return "$el" in value
+            ? ((_a = value.$el) !== null && _a !== void 0 ? _a : null)
+            : value;
+    });
+}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './components';
 export * from './composables';
 export * from './plugin';
-export { KritzelBaseObject, KritzelText, KritzelPath, KritzelImage, KritzelLine, KritzelShape, KritzelGroup, KritzelBrushTool, KritzelTextTool, KritzelLineTool, KritzelShapeTool, KritzelEraserTool, KritzelSelectionTool, KritzelImageTool, KritzelWorkspace, InMemorySyncProvider, IndexedDBSyncProvider, BroadcastSyncProvider, WebSocketSyncProvider, HocuspocusSyncProvider, KritzelThemeManager, ShapeType, KritzelAlignment, lightTheme, darkTheme, DEFAULT_BRUSH_CONFIG, DEFAULT_TEXT_CONFIG, } from 'kritzel-stencil';
-export type { KritzelToolbarControl, KritzelBrushToolConfig, KritzelLineToolConfig, KritzelShapeToolConfig, KritzelTextToolConfig, KritzelSyncConfig, KritzelTheme, KritzelViewportState, ContextMenuItem, ThemeAwareColor, ThemeName, LoginEvent, EditorIsReadyEvent, ActiveWorkspaceChangeEvent, ObjectsAddedEvent, ObjectsRemovedEvent, ObjectsUpdatedEvent, } from 'kritzel-stencil';
+export { KritzelBaseObject, KritzelText, KritzelPath, KritzelImage, KritzelLine, KritzelShape, KritzelGroup, KritzelBaseTool, KritzelBrushTool, KritzelTextTool, KritzelLineTool, KritzelShapeTool, KritzelEraserTool, KritzelSelectionTool, KritzelImageTool, KritzelWorkspace, InMemorySyncProvider, IndexedDBSyncProvider, BroadcastSyncProvider, WebSocketSyncProvider, HocuspocusSyncProvider, KritzelThemeManager, KritzelLocalizationManager, KritzelLicenseManager, ShapeType, KritzelAlignment, lightTheme, darkTheme, EN_LOCALE, DE_LOCALE, FR_LOCALE, DEFAULT_BRUSH_CONFIG, DEFAULT_TEXT_CONFIG, } from 'kritzel-stencil';
+export type { HTMLKritzelEditorElement, HTMLKritzelEngineElement, KritzelToolbarControl, KritzelBrushToolConfig, KritzelLineToolConfig, KritzelShapeToolConfig, KritzelTextToolConfig, KritzelSyncConfig, KritzelTheme, KritzelViewportState, ContextMenuItem, ThemeAwareColor, ThemeName, KritzelLocale, LocaleCode, KritzelTerms, KritzelTermKey, KritzelTermVars, LoginEvent, EditorIsReadyEvent, ActiveWorkspaceChangeEvent, ObjectsAddedEvent, ObjectsRemovedEvent, ObjectsUpdatedEvent, ObjectsInViewportChangeEvent, KritzelUndoState, IKritzelIsPublicChangedEvent, KritzelEngineState, KritzelDebugInfo, IKritzelUser, } from 'kritzel-stencil';

package/dist/index.js

@@ -1,4 +1,4 @@
 export * from './components';
 export * from './composables';
 export * from './plugin';
-export { KritzelBaseObject, KritzelText, KritzelPath, KritzelImage, KritzelLine, KritzelShape, KritzelGroup, KritzelBrushTool, KritzelTextTool, KritzelLineTool, KritzelShapeTool, KritzelEraserTool, KritzelSelectionTool, KritzelImageTool, KritzelWorkspace, InMemorySyncProvider, IndexedDBSyncProvider, BroadcastSyncProvider, WebSocketSyncProvider, HocuspocusSyncProvider, KritzelThemeManager, ShapeType, KritzelAlignment, lightTheme, darkTheme, DEFAULT_BRUSH_CONFIG, DEFAULT_TEXT_CONFIG, } from 'kritzel-stencil';
+export { KritzelBaseObject, KritzelText, KritzelPath, KritzelImage, KritzelLine, KritzelShape, KritzelGroup, KritzelBaseTool, KritzelBrushTool, KritzelTextTool, KritzelLineTool, KritzelShapeTool, KritzelEraserTool, KritzelSelectionTool, KritzelImageTool, KritzelWorkspace, InMemorySyncProvider, IndexedDBSyncProvider, BroadcastSyncProvider, WebSocketSyncProvider, HocuspocusSyncProvider, KritzelThemeManager, KritzelLocalizationManager, KritzelLicenseManager, ShapeType, KritzelAlignment, lightTheme, darkTheme, EN_LOCALE, DE_LOCALE, FR_LOCALE, DEFAULT_BRUSH_CONFIG, DEFAULT_TEXT_CONFIG, } from 'kritzel-stencil';

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "kritzel-vue",
-  "version": "0.3.15",
-  "homepage": "https://github.com/kasual1/kritzel#readme",
-  "license": "ISC",
+  "version": "0.3.17",
+  "homepage": "https://kritzel.io/",
+  "description": "Build infinite canvas experiences in minutes.",
+  "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "directories": {
@@ -12,10 +13,6 @@
   "files": [
     "dist"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/kasual1/kritzel.git"
-  },
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1",
     "build": "npm run tsc",
@@ -34,6 +31,6 @@
     "@stencil/vue-output-target": "0.11.8"
   },
   "peerDependencies": {
-    "kritzel-stencil": "^0.3.15"
+    "kritzel-stencil": "^0.3.17"
   }
 }