Premiers pas avec le SDK
Installation
bash
bun add @open-pencil/core @open-pencil/vue @open-pencil/canvaskitLe canevas charge à l’exécution canvaskit.wasm depuis @open-pencil/canvaskit/dist/ et les polices fournies ; la manière de les servir est décrite dans Serve the engine’s files (en anglais).
Le SDK se trouve dans le monorepo OpenPencil et est publié sous forme de package @open-pencil/vue.
ts
import { createEditor } from '@open-pencil/core'
import { provideEditor } from '@open-pencil/vue'
import { useCanvas } from '@open-pencil/vue/canvas/surface'Couches de l'application
Une application basée sur le SDK se compose de trois couches :
@open-pencil/core— le moteur de l'éditeur, indépendant du framework ;@open-pencil/vue— les composables et composants sans styles pour Vue ;- l'application — la présentation, le routage, la gestion des fichiers et l'interface propre au produit.
Configuration minimale
1. Créez un éditeur
ts
import { createEditor } from '@open-pencil/core'
const editor = createEditor({
width: 1200,
height: 800,
})2. Rendez l'éditeur accessible aux composants descendants
vue
<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() rend l'instance de l'éditeur accessible à tous les composants situés plus bas dans l'arbre. La documentation appelle directement cette fonction, car elle fait partie de l'API publique actuelle.
3. Connectez la zone de travail
vue
<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>Utiliser les composables
Après l'appel à provideEditor(), les composants descendants peuvent consulter la sélection et exécuter des commandes de l'éditeur :
ts
import { useEditorCommands } from '@open-pencil/vue/editor/commands'
import { useSelectionState } from '@open-pencil/vue/editor/selection-state'
const selection = useSelectionState()
const commands = useEditorCommands()Exemple simple
vue
<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 prêt')
},
})
</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">
Sélection : {{ selectedCount }}
</div>
</div>
</template>