Skip to content

provideEditor ​

provideEditor(editor) makes an 4B Pen editor available to descendant composables and headless primitives through Vue injection.

This is the foundation for useEditor().

Usage ​

ts
import { provideEditor } from '@open-pencil/vue'

provideEditor(editor)

Basic example ​

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>

Notes ​

The current SDK uses provideEditor() and useEditor() directly. Some older examples and error messages still refer to an OpenPencilProvider component, but the injection model is the real API surface to prefer in docs and app code.

Released under the MIT License.