useEditor

useEditor() devuelve el editor de OpenPencil actualmente inyectado.

Es el punto de entrada principal para los composables del SDK y los primitivos headless que necesitan acceso al editor.

Uso

useEditor() debe llamarse dentro de un subárbol donde provideEditor(editor) ya haya sido llamado.

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

const editor = useEditor()

Ejemplo básico

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

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

const editor = useEditor()
const pageId = computed(() => editor.state.currentPageId)
</script>

<template>
  <div>Página actual: {{ pageId }}</div>
</template>

Ejemplos prácticos

Leer los nodos seleccionados

const editor = useEditor()
const selected = editor.getSelectedNodes()

Ejecutar comandos

const editor = useEditor()
editor.zoomToFit()
editor.undoAction()

Comportamiento de error

Si se llama fuera de un árbol con proveedor de editor, useEditor() lanza un error con un mensaje descriptivo.

Esto es intencional — esta API debe fallar de forma ruidosa cuando falta el contexto del editor.

APIs relacionadas

• provideEditor
• useCanvas
• useSelectionState
• useEditorCommands

Tipo

function useEditor(): Editor