14325280d9
- 78 SDK pages per language (components, composables, advanced API, guides, architecture, getting-started) - vector-edit.md user guide page (5 languages) - Update stale ru/programmable/cli/inspecting.md - Fix YAML frontmatter quoting for colons in descriptions 474 files, 0 missing pages across de/es/fr/it/pl/ru. VitePress build verified — all 546 SDK pages render.
130 lines
2.7 KiB
Markdown
130 lines
2.7 KiB
Markdown
---
|
||
title: SDK – Erste Schritte
|
||
description: "@open-pencil/vue mit createEditor, provideEditor und einem Canvas einrichten."
|
||
---
|
||
|
||
# SDK – Erste Schritte
|
||
|
||
## Installation
|
||
|
||
```bash
|
||
bun add @open-pencil/core @open-pencil/vue canvaskit-wasm
|
||
```
|
||
|
||
Das SDK befindet sich heute im Monorepo und wird auch als `@open-pencil/vue` veröffentlicht.
|
||
|
||
```ts
|
||
import { createEditor } from '@open-pencil/core/editor'
|
||
import { provideEditor, useCanvas } from '@open-pencil/vue'
|
||
```
|
||
|
||
## Mentales Modell
|
||
|
||
Es gibt drei Schichten:
|
||
|
||
1. `@open-pencil/core` — framework-agnostische Editor-Engine
|
||
2. `@open-pencil/vue` — Vue Composables und headless Primitive
|
||
3. Ihre App — Styling, Routing, Datei-Flows, produktspezifische UI
|
||
|
||
## Minimales Setup
|
||
|
||
### 1. Einen Editor erstellen
|
||
|
||
```ts
|
||
import { createEditor } from '@open-pencil/core/editor'
|
||
|
||
const editor = createEditor({
|
||
width: 1200,
|
||
height: 800,
|
||
})
|
||
```
|
||
|
||
### 2. Vue bereitstellen
|
||
|
||
```vue
|
||
<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>
|
||
```
|
||
|
||
Diese Schicht fungiert als Provider für den Editor-Baum. Die Dokumentation bevorzugt `provideEditor()` direkt, da dies die aktuelle echte API-Oberfläche ist.
|
||
|
||
### 3. Einen Canvas anbinden
|
||
|
||
```vue
|
||
<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
|
||
|
||
Sobald der Editor bereitgestellt ist, können Kind-Komponenten die Auswahl lesen und Befehle ausgeben:
|
||
|
||
```ts
|
||
import { useEditorCommands, useSelectionState } from '@open-pencil/vue'
|
||
|
||
const selection = useSelectionState()
|
||
const commands = useEditorCommands()
|
||
```
|
||
|
||
## Einfaches Beispiel
|
||
|
||
```vue
|
||
<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](./architecture)
|
||
- [API-Referenz](./api/)
|
||
- [useEditor](./api/composables/use-editor)
|
||
- [useCanvas](./api/composables/use-canvas)
|
||
- [useI18n](./api/composables/use-i18n)
|