@eigenpal/docx-editor-core/prosemirror-template-prosemirror-plugin — API Reference

API Referencev1.0.2

@eigenpal/docx-editor-core/prosemirror/template/prosemirror-plugin

Template ProseMirror Plugin

Simple plugin that finds template tags using regex and creates decorations. No separate parsing layer - everything happens here.

Functions(4)

createTemplatePlugin

packages/core/src/prosemirror/template/prosemirror-plugin.ts:209

Create the template plugin

declare function createTemplatePlugin(): Plugin<TemplatePluginState>;

getTemplateTags

packages/core/src/prosemirror/template/prosemirror-plugin.ts:314

Get tags from editor state

declare function getTemplateTags(state: prosemirror_state.EditorState): TemplateTag[];

setHoveredElement

packages/core/src/prosemirror/template/prosemirror-plugin.ts:321

Set hovered tag

declare function setHoveredElement(view: EditorView, id: string | undefined): void;

setSelectedElement

packages/core/src/prosemirror/template/prosemirror-plugin.ts:328

Set selected tag

declare function setSelectedElement(view: EditorView, id: string | undefined): void;

Interfaces(1)

interface

TemplateTag

packages/core/src/prosemirror/template/prosemirror-plugin.ts:23

A found template tag

interface TemplateTag

Member	Type	Summary
from	`number`
id	`string`
insideSection?	`boolean`	True if this variable is inside a section (shown in section's nested vars)
name	`string`
nestedVars?	`string[]`	For sections: nested variable names
rawTag	`string`
to	`number`
type	`TagType`

Type aliases(1)

type

TagType

packages/core/src/prosemirror/template/prosemirror-plugin.ts:18

Template tag types

type TagType = 'variable' | 'sectionStart' | 'sectionEnd' | 'invertedStart' | 'raw';

Variables(2)

const

TEMPLATE_DECORATION_STYLES

packages/core/src/prosemirror/template/prosemirror-plugin.ts:335

CSS styles for template decorations

TEMPLATE_DECORATION_STYLES = "\n.docx-template-tag {\n  cursor: pointer;\n  transition: background-color 0.1s;\n}\n\n.docx-template-tag:hover,\n.docx-template-tag.hovered {\n  filter: brightness(0.95);\n}\n\n.docx-template-tag.selected {\n  box-shadow: 0 0 0 2px rgba(59, 130, 246, 0.5);\n}\n"

const

templatePluginKey

packages/core/src/prosemirror/template/prosemirror-plugin.ts:54

Plugin key

templatePluginKey: PluginKey<TemplatePluginState>