Skip to content

AI-native design editor. Open-source Figma alternative.

3.1 KB
Raw Blame

title: Pierwsze kroki z SDK description: Podłącz @open-pencil/vue, utwórz edytor i skonfiguruj obszar roboczy.

Pierwsze kroki z SDK

Instalacja

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

SDK znajduje się w monorepo OpenPencil i jest publikowany jako pakiet @open-pencil/vue.

import { createEditor } from '@open-pencil/core'
import { provideEditor } from '@open-pencil/vue'
import { useCanvas } from '@open-pencil/vue/canvas/surface'

Warstwy aplikacji

Aplikacja oparta na SDK składa się z trzech warstw:

  1. @open-pencil/core — silnik edytora niezależny od frameworka;
  2. @open-pencil/vue — composables i komponenty bez narzuconego wyglądu dla Vue;
  3. aplikacja — wygląd, routing, obsługa plików i interfejs produktu.

Minimalna konfiguracja

1. Utwórz edytor

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

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

2. Udostępnij edytor komponentom potomnym

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

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

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

provideEditor(props.editor)
</script>

<template>
  <slot />
</template>

provideEditor() udostępnia instancję edytora wszystkim komponentom znajdującym się niżej w drzewie. Dokumentacja wywołuje tę funkcję bezpośrednio, ponieważ należy ona do aktualnego publicznego API.

3. Podłącz obszar roboczy

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

import { useCanvas } from '@open-pencil/vue/canvas/surface'
import { 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>

Korzystanie z composables

Po wywołaniu provideEditor() komponenty potomne mogą odczytywać zaznaczenie i wykonywać polecenia edytora:

import { useEditorCommands } from '@open-pencil/vue/editor/commands'
import { useSelectionState } from '@open-pencil/vue/editor/selection-state'

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

Prosty przykład

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

import { useCanvas } from '@open-pencil/vue/canvas/surface'
import { useEditor } from '@open-pencil/vue'
import { useSelectionState } from '@open-pencil/vue/editor/selection-state'

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">
      Zaznaczono: {{ selectedCount }}
    </div>
  </div>
</template>

Co dalej