Erste Schritte mit dem SDK

Installation

bun add @open-pencil/core @open-pencil/vue canvaskit-wasm

Das SDK befindet sich im 4B-Pen-Monorepo und wird als Paket @open-pencil/vue veröffentlicht.

import { createEditor } from '@open-pencil/core/editor'
import { provideEditor, useCanvas } from '@open-pencil/vue'

Anwendungsebenen

Eine Anwendung auf Grundlage des SDK besteht aus drei Ebenen:

1. @open-pencil/core — die vom Framework unabhängige Editor-Engine;
2. @open-pencil/vue — Composables und Komponenten ohne vorgegebenes Erscheinungsbild für Vue;
3. die Anwendung — Gestaltung, Routing, Dateiverwaltung und produktspezifische Oberfläche.

Minimale Einrichtung

1. Editor erstellen

import { createEditor } from '@open-pencil/core/editor'

const editor = createEditor({
  width: 1200,
  height: 800,
})

2. Editor für untergeordnete Komponenten bereitstellen

<script setup lang="ts">
import { provideEditor } from '@open-pencil/vue'

import type { Editor } from '@open-pencil/core/editor'

const props = defineProps<{
  editor: Editor
}>()

provideEditor(props.editor)
</script>

<template>
  <slot />
</template>

provideEditor() stellt die Editor-Instanz allen darunterliegenden Komponenten zur Verfügung. Die Dokumentation ruft diese Funktion direkt auf, da sie zur aktuellen öffentlichen API gehört.

3. Arbeitsfläche anbinden

<script setup lang="ts">
import { ref } from 'vue'

import { useCanvas, useEditor } from '@open-pencil/vue'

const canvasRef = ref<HTMLCanvasElement | null>(null)
const editor = useEditor()

useCanvas(canvasRef, editor)
</script>

<template>
  <canvas ref="canvasRef" class="size-full" />
</template>

Composables verwenden

Nach dem Aufruf von provideEditor() können untergeordnete Komponenten die Auswahl auslesen und Editor-Befehle ausführen:

import { useEditorCommands, useSelectionState } from '@open-pencil/vue'

const selection = useSelectionState()
const commands = useEditorCommands()

Einfaches Beispiel

<script setup lang="ts">
import { ref } from 'vue'

import { useCanvas, useEditor, useSelectionState } from '@open-pencil/vue'

const canvasRef = ref<HTMLCanvasElement | null>(null)
const editor = useEditor()
const { selectedCount } = useSelectionState()

useCanvas(canvasRef, editor, {
  onReady: () => {
    console.log('Canvas ready')
  },
})
</script>

<template>
  <div class="grid h-full grid-rows-[1fr_auto]">
    <canvas ref="canvasRef" class="size-full" />
    <div class="border-t px-3 py-2 text-xs text-muted">
      Ausgewählt: {{ selectedCount }}
    </div>
  </div>
</template>

Nächste Schritte

• Architektur
• API-Referenz
• useEditor
• useCanvas
• useI18n