- 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.
3.3 KiB
3.3 KiB
| title | description |
|---|---|
| Начало работы с SDK | Настройка @open-pencil/vue с createEditor, provideEditor и холстом. |
Начало работы с SDK
Установка
bun add @open-pencil/core @open-pencil/vue canvaskit-wasm
SDK находится в монорепозитории и также опубликован как @open-pencil/vue.
import { createEditor } from '@open-pencil/core/editor'
import { provideEditor, useCanvas } from '@open-pencil/vue'
Концептуальная модель
Три уровня:
@open-pencil/core— не зависящий от фреймворка движок редактора@open-pencil/vue— Vue-компосаблы и headless-примитивы- ваше приложение — стили, маршрутизация, файловые потоки, UI под конкретный продукт
Минимальная настройка
1. Создайте редактор
import { createEditor } from '@open-pencil/core/editor'
const editor = createEditor({
width: 1200,
height: 800,
})
2. Передайте его в 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>
Это слой-провайдер для дерева редактора. В документации предпочтителен вызов provideEditor() напрямую — это актуальная поверхность API.
3. Подключите холст
<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>
Использование компосаблов
После того как редактор передан через провайдер, дочерние компоненты могут читать выделение и вызывать команды:
import { useEditorCommands, useSelectionState } from '@open-pencil/vue'
const selection = useSelectionState()
const commands = useEditorCommands()
Базовый пример
<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">
Selected: {{ selectedCount }}
</div>
</div>
</template>