useCanvas

useCanvas() łączy edytor z elementem <canvas>.

Obsługuje:

• inicjalizację CanvasKit;
• tworzenie surface;
• planowanie rendering;
• zmianę rozmiaru;
• opcjonalne rulers;
• wywołanie function po przygotowaniu renderer.

Użycie

import { ref } from 'vue'

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

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

useCanvas(canvasRef, editor)

Przykład

<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, {
  showRulers: true,
  onReady: () => {
    console.log('Renderer ready')
  },
})
</script>

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

Wyłączenie rulers w osadzonym preview

useCanvas(canvasRef, editor, {
  showRulers: false,
})

Zachowanie drawing buffer dla zrzutów

useCanvas(canvasRef, editor, {
  preserveDrawingBuffer: true,
})

Uwagi

• useCanvas() pracuje z renderer i jest przeznaczone dla browser.
• Zarządza działającym obszarem roboczym, ale nie otwieraniem ani zapisywaniem plików.
• Do obsługi działań użytkownika zwykle uzupełnia je useCanvasInput().

Zobacz też

• useEditor
• useCanvasInput
• useTextEdit

Typ

interface UseCanvasOptions {
  showRulers?: boolean
  preserveDrawingBuffer?: boolean
  onReady?: () => void
}

function useCanvas(
  canvasRef: Ref<HTMLCanvasElement | null>,
  editor: Editor,
  options?: UseCanvasOptions,
): void