@eigenpal/docx-editor-vue/plugin-api
Generic plugin interface and host component for integrating external plugins with the Vue editor. Pairs with the framework-agnostic plugin types exported from @eigenpal/docx-editor-core/plugin-api.
Interfaces (1)
VueEditorPlugininterfaceSource ↗
Vue-specific editor plugin interface.
Extends EditorPluginCore with: - Panel: Vue component for rendering in the annotation panel - renderOverlay: Function returning VNode for overlay rendering
export interface VueEditorPlugin<TState = any> extends EditorPluginCore<TState>| Member | Type | Summary |
|---|---|---|
| Panel? | Component<PluginPanelProps<TState>> | Vue component to render in the annotation panel area. |
| renderOverlay? | (context: RenderedDomContext, state: TState, editorView: EditorView | null) => VNode | null | Render an overlay on top of the rendered pages. |
Type aliases (1)
EditorPlugintypeSource ↗
Canonical alias — EditorPlugin is VueEditorPlugin inside the Vue adapter. The package name already encodes the framework; importing EditorPlugin from @eigenpal/docx-editor-vue/plugin-api reads as cleanly as the React import. Mirrors React's EditorPlugin alias.
export type EditorPlugin<TState = any> = VueEditorPlugin<TState>;