# QuireKit developer documentation

A document editor framework extending Tiptap Core: Core concepts and APIs, plugin integration and effects, and Classic integration, free use and commercial use.

[简体中文](/llms.txt)

- [Core documentation](/raw/en/index.md): Start with Core concepts and APIs, then build your own editor.
- [Quick start](/raw/en/guide/quick-start.md): Install the basics, create an editor and try input, formatting and undo.
- [The Tiptap relationship](/raw/en/guide/tiptap.md): Familiar Core APIs with explicit package identity and view boundaries.
- [The ProseMirror relationship](/raw/en/guide/prosemirror.md): Documents, transactions and plugins share one runtime identity.
- [Vue integration](/raw/en/guide/vue.md): Let Vue supply the container and create and release Editor with component lifecycle.
- [Read, replace and validate content](/raw/en/guide/content.md): Choose between insertion, body replacement and opening a document, while preserving the original input.
- [Build your own editor](/raw/en/build.md): Progress from a first editor to models, pagination, controls, extensions and file operations.
- [Build your first editor](/raw/en/build/project.md): Start with one Vue component and understand creation, mounting and cleanup.
- [Understand the document model](/raw/en/build/model.md): Learn nodes, formatting and Schema, then choose a structure for articles or Word documents.
- [Display content with Canvas/SVG](/raw/en/build/view.md): Replace DOM with Canvas and understand scrolling, zoom and pagination responsibilities.
- [Connect your toolbar](/raw/en/build/commands.md): Start with a Bold button, then understand commands, enabled state and interface updates.
- [Add your own content type](/raw/en/build/extension.md): Build a note group by understanding nodes, commands, display and selection step by step.
- [Add product features to Classic](/raw/en/build/product-plugin.md): Distinguish content extensions from interface plugins, then add actions, sidebars and file services.
- [Save and open documents](/raw/en/build/files.md): Start with JSON, then add validation, asynchronous state and DOCX conversion.
- [Add images, fonts and other capabilities](/raw/en/build/resources.md): Find the resource and service integrations a complete product needs beyond editing.
- [Check your editor](/raw/en/build/verification.md): Exercise real editing, file recovery and cleanup workflows.
- [Complete workspace reference](/raw/en/build/reference.md): Find complete workspace, model, extension and file-operation implementations by purpose.
- [Documents and Schema](/raw/en/concepts/document.md): Understand nodes, marks, attributes and content rules through one bold paragraph.
- [Extension model](/raw/en/concepts/extensions.md): Learn how behavior, document structures and text formatting join an editor.
- [Commands and transactions](/raw/en/concepts/commands.md): Use commands first, then understand how changes share document history.
- [Lifecycle and events](/raw/en/concepts/lifecycle.md): Own Editor in a component and subscribe to content, selection or transaction changes as needed.
- [Views and rendering](/raw/en/concepts/views.md): Understand content versus display and choose from four views: DOM, HTML, Canvas and SVG.
- [Persistence](/raw/en/guide/persistence.md): Save JSON, choose storage and understand versioning and restoration.
- [Selections and document positions](/raw/en/concepts/selection.md): Read caret ranges, select text or nodes, and preserve the toolbar's editing target.
- [Write a behavior extension](/raw/en/guide/behavior.md): Learn options, storage, commands and lifecycle through a small greeting command.
- [Input rules and state plugins](/raw/en/guide/rules.md): Turn ==text== into a mark and observe selection through a PM plugin without duplicating content.
- [Build an interactive NodeView](/raw/en/guide/node-view.md): Add a button to a persistent counter node and connect rendering, positions, transactions and cleanup.
- [HTML and Markdown conversion](/raw/en/guide/formats.md): Choose browser or server conversion APIs and understand Schema, format rules and data loss.
- [Core API](/raw/en/api/core.md): Generated from the public TypeScript exports of @quirekit/core.
- [Editor: state, commands and lifetime](/raw/en/api/editor.md): Task-oriented arguments, results, state shape and lifecycle effects.
- [Extensions: configuration and capability contracts](/raw/en/api/extensions.md): Practical responsibilities from nodes/marks and commands to profiles, layout and selection.
- [Support and licensing](/raw/en/support.md): Understand capabilities, distribution and integration requirements by package.
- [View: adapters and workspace options](/raw/en/api/view.md): Backend choice, runtime options, geometry queries and freshness.
- [Editor options and events](/raw/en/api/options.md): Look up creation options, replacement settings and the complete public event map.
- [All plugins](/raw/en/plugins.md): Find shared extensions and product adapters by Classic, Block and capability, with support status, installation and configuration.
- [Configure plugins](/raw/en/plugins/configuration.md): Choose the installation layer and distinguish options, document attributes, commands and runtime state.
- [StarterKit](/raw/en/plugins/starter-kit.md): A configurable bundle of common nodes, marks and editing behavior.
- [Choose an editor and integration](/raw/en/plugins/compatibility.md): Distinguish shared document capabilities from Classic and Block adapters, and select the required preset and installation path.
- [Text formatting](/raw/en/plugins/text-formatting.md): Use Bold, Italic and Underline to format inline text.
- [Document structure](/raw/en/plugins/structure.md): Organize content with Heading, Paragraph and List.
- [Custom plugins](/raw/en/plugins/custom.md): Connect your own behavior to Core without a second editing state.
- [Word capabilities and product assembly](/raw/en/plugins/word.md): Choose Word document capabilities above Core and understand the product UI boundary.
- [ListKit](/raw/en/plugins/reference/list-kit.md): Bundles BulletList, OrderedList, ListItem and ListKeymap. These children are already included in StarterKit.
- [StarterKit](/raw/en/plugins/reference/starter-kit.md): Bundles common nodes, marks and editing behavior. Configure or disable individual children instead of installing duplicate names.
- [TextStyleKit](/raw/en/plugins/reference/text-style-kit.md): Bundles TextStyle and its typography/color/language companions. Highlight and font resources are separate.
- [Blockquote](/raw/en/plugins/reference/blockquote.md): Wraps quoted content in a block container while retaining paragraphs and other nested blocks.
- [BulletList](/raw/en/plugins/reference/bullet-list.md): Adds nested bullet lists and requires ListItem. Word's flat paragraph numbering is provided separately by WordNumbering.
- [CodeBlock](/raw/en/plugins/reference/code-block.md): Stores multiline code and a language attribute, with configurable exit and indentation behavior. It does not install a syntax highlighter.
- [Document](/raw/en/plugins/reference/document.md): Defines the document root and its block content. A minimal schema also needs Paragraph and Text.
- [HardBreak](/raw/en/plugins/reference/hard-break.md): Inserts a line break within a paragraph. keepMarks controls whether active formatting continues after it.
- [Heading](/raw/en/plugins/reference/heading.md): Adds headings. The levels option restricts parsing, commands and shortcuts as well as the levels offered by your UI.
- [HorizontalRule](/raw/en/plugins/reference/horizontal-rule.md): Inserts a separator block with canonical line styling. nextNodeType controls the following editable block at the document end.
- [ListItem](/raw/en/plugins/reference/list-item.md): Defines list items containing paragraphs and nested blocks. Parent type names must match the installed list extensions.
- [OrderedList](/raw/en/plugins/reference/ordered-list.md): Adds ordered-list containers, items and start numbers. Requires ListItem; use WordNumbering for Word numbering semantics.
- [Paragraph](/raw/en/plugins/reference/paragraph.md): Provides ordinary body paragraphs and their HTML p representation.
- [Text](/raw/en/plugins/reference/text.md): Provides leaf text nodes. Character formatting is represented by marks rather than child nodes.
- [BackgroundColor](/raw/en/plugins/reference/background-color.md): Stores character shading on textStyle, separate from Highlight's semantic highlight colors.
- [Bold](/raw/en/plugins/reference/bold.md): Adds semantic bold formatting with set, unset and toggle commands. The host supplies toolbar controls.
- [Code](/raw/en/plugins/reference/code.md): Marks inline code within a paragraph. Use CodeBlock for multiline code.
- [Color](/raw/en/plugins/reference/color.md): Stores foreground color on textStyle. types selects target marks; setColor supplies the actual color.
- [DoubleStrike](/raw/en/plugins/reference/double-strike.md): Adds double strikethrough as character formatting, separate from tracked deletion.
- [FontFamily](/raw/en/plugins/reference/font-family.md): Sets a shared font family or independent Latin, East Asian and complex-script families. The host must still provide font resources.
- [FontSize](/raw/en/plugins/reference/font-size.md): Stores font size on textStyle and provides set, clear, grow and shrink commands.
- [Highlight](/raw/en/plugins/reference/highlight.md): Adds semantic text highlighting. defaultColor applies to newly created highlights without an explicit color.
- [Italic](/raw/en/plugins/reference/italic.md): Adds italic formatting. At a collapsed caret, formatting commands affect subsequent input.
- [Language](/raw/en/plugins/reference/language.md): Stores independent script-language slots for text semantics and proofing. It does not translate content or change UI language.
- [LetterSpacing](/raw/en/plugins/reference/letter-spacing.md): Stores character spacing through validated commands, separate from paragraph line spacing.
- [LineHeight](/raw/en/plugins/reference/line-height.md): Retains the legacy CSS lineHeight attribute. It does not express Word paragraph line spacing; use WordParagraph for that model.
- [Link](/raw/en/plugins/reference/link.md): Stores link destinations and provides insert, update and removal commands. Completed typed URLs can become links; the host owns link UI and navigation.
- [Strike](/raw/en/plugins/reference/strike.md): Adds single strikethrough formatting. It does not represent tracked deletion; tracked changes belong to WordRevision.
- [Subscript](/raw/en/plugins/reference/subscript.md): Adds subscript formatting for formulas and indices without changing the underlying text.
- [Superscript](/raw/en/plugins/reference/superscript.md): Adds semantic superscript formatting rather than approximating it with manual font size and offsets.
- [TextStyle](/raw/en/plugins/reference/text-style.md): Stores direct character formatting on one textStyle mark. Install attribute extensions such as FontFamily or Color alongside it.
- [Underline](/raw/en/plugins/reference/underline.md): Adds underline formatting. It does not create a hyperlink; install Link when text needs a destination.
- [AutoCorrect](/raw/en/plugins/reference/auto-correct.md): Applies replacement-table and sentence-capitalization rules during input, with optional host persistence.
- [BaseKeymap](/raw/en/plugins/reference/base-keymap.md): Installs the base ProseMirror editing keymap. Included in StarterKit and available for custom minimal schemas.
- [BlockInteraction](/raw/en/plugins/reference/block-interaction.md): Assigns stable block identities and provides select, move and insert commands. Product UI supplies drag handles.
- [CharacterCount](/raw/en/plugins/reference/character-count.md): Exposes character and word counts through editor.storage.characterCount and can limit input. Customize the default string-length and space-separated counters when needed.
- [Focus](/raw/en/plugins/reference/focus.md): Adds focus classes along the selected block path without changing canonical content.
- [Formatting](/raw/en/plugins/reference/formatting.md): Provides format painting and clearing. Configure which marks and textStyle attributes survive clear-format operations.
- [Gapcursor](/raw/en/plugins/reference/gapcursor.md): Allows a caret between otherwise non-text-editable blocks. The mounted view supplies interaction and presentation.
- [ListKeymap](/raw/en/plugins/reference/list-keymap.md): Adds list-aware Backspace and Delete behavior. Update listTypes when using custom list and item type names.
- [Placeholder](/raw/en/plugins/reference/placeholder.md): Adds transient placeholder decorations and attributes to empty nodes. DOM hosts provide CSS; other views need corresponding presentation support.
- [Proofing](/raw/en/plugins/reference/proofing.md): Checks text through a host-supplied proofing provider and displays transient findings. The default null provider performs no checking.
- [Search](/raw/en/plugins/reference/search.md): Maintains find/replace matches and transient highlights. Hosts can restrict scopes, guard replacement and reveal active matches.
- [Selection](/raw/en/plugins/reference/selection.md): Preserves a visible text-selection decoration after blur. The host or view supplies its appearance.
- [TextCase](/raw/en/plugins/reference/text-case.md): Changes the case of selected text. checkChangeable can reject protected or business-locked ranges.
- [TrailingNode](/raw/en/plugins/reference/trailing-node.md): Keeps an editable block at the document end. Without node, it uses the schema default block and then paragraph.
- [UndoRedo](/raw/en/plugins/reference/undo-redo.md): Provides local document history and undo/redo. Disable it when collaboration supplies its own history.
- [DataView](/raw/en/plugins/reference/data-view.md): Stores portable data-view documents. Hosts inject interactive rendering, a workspace and layout registrations.
- [FloatingObject](/raw/en/plugins/reference/floating-object.md): Adds generic floating objects with an independently editable text root. Layout-provider support is required; Word uses a separate anchor model.
- [Flowchart](/raw/en/plugins/reference/flowchart.md): Stores flowchart source and its matching preview. The host injects editing and offscreen rendering.
- [HtmlSandbox](/raw/en/plugins/reference/html-sandbox.md): Stores explicit HTML source. A host mount port enables an isolated preview; static export preserves escaped source rather than an active iframe.
- [MindMap](/raw/en/plugins/reference/mind-map.md): Stores mind-map data and previews with captured-target checks. The host supplies a workspace and renderer.
- [TextDiagram](/raw/en/plugins/reference/text-diagram.md): Stores Mermaid, PlantUML or DOT source with a matching preview. The host supplies editing and rendering and commits source and preview together.
- [Whiteboard](/raw/en/plugins/reference/whiteboard.md): Stores whiteboard scenes, titles and previews. Editing, renaming, selection actions and rendering are explicit host integrations.
- [Accessibility](/raw/en/plugins/reference/accessibility.md): Provides bounded input context and segmented reading on a mounted view. Localize labels and supply semantics for custom blocks.
- [CollaborationFlat](/raw/en/plugins/reference/collaboration-flat.md): Binds Core to a shared CRDT replica with local-author undo. Supply doc, disable ordinary UndoRedo and provide transport and authorization.
- [CollaborationSteps](/raw/en/plugins/reference/collaboration-steps.md): Attaches Core to versioned step collaboration. The host creates the binding and owns connection/recovery; ready controls editing before readiness.
- [canvasViewExtension](/raw/en/plugins/reference/canvas-view-extension.md): Registers the canvas mounted runtime. Hosts still provide container geometry, base styles and a document model.
- [DomViewExtension](/raw/en/plugins/reference/dom-view-extension.md): Registers native contenteditable in dom mode, without the retained layout and pagination engine.
- [htmlViewExtension](/raw/en/plugins/reference/html-view-extension.md): Registers the retained html view with browser flow layout and View-owned input/selection. It is distinct from native dom mode.
- [svgViewExtension](/raw/en/plugins/reference/svg-view-extension.md): Registers the svg runtime, sharing document and layout contracts with Canvas. Change modes through the editor rather than recreating content.
- [LitAstPreservation](/raw/en/plugins/reference/lit-ast-preservation.md): Preserves imported LitAST state between DOCX conversion and canonical documents. It is not a codec or export service.
- [WordBlockContentControl](/raw/en/plugins/reference/word-block-content-control.md): Stores block-level structured document tags with content, placeholders, locks and binding semantics.
- [WordBlockInteraction](/raw/en/plugins/reference/word-block-interaction.md): Adds Word-aware admission and integrity rules to generic structural block interaction.
- [WordBookmark](/raw/en/plugins/reference/word-bookmark.md): Maintains named bookmark ranges and navigation. Use bookmark commands to preserve paired endpoints.
- [WordBookmarkEnd](/raw/en/plugins/reference/word-bookmark-end.md): Stores the matching bookmark endpoint and participates in range integrity.
- [WordBookmarkStart](/raw/en/plugins/reference/word-bookmark-start.md): Stores a bookmark start identity, normally created by WordBookmark commands.
- [WordChart](/raw/en/plugins/reference/word-chart.md): Maintains native chart data and source preservation. Preview availability does not imply full native round-trip support.
- [WordColumnBreak](/raw/en/plugins/reference/word-column-break.md): Stores explicit column breaks for column-aware section layout, distinct from page breaks.
- [WordComment](/raw/en/plugins/reference/word-comment.md): Stores comment ranges, threads and replies with commands. Review UI is supplied separately by Classic Pro or the host.
- [WordCommentEnd](/raw/en/plugins/reference/word-comment-end.md): Marks a comment range endpoint/reference and works with its thread and start marker.
- [WordCommentStart](/raw/en/plugins/reference/word-comment-start.md): Marks the start of a comment range and is managed by the comment lifecycle.
- [WordContentControlDataBindingExtension](/raw/en/plugins/reference/word-content-control-data-binding-extension.md): Connects content controls to canonical binding data under content-control protection and lifecycle rules.
- [WordDocumentSettingsExtension](/raw/en/plugins/reference/word-document-settings-extension.md): Preserves Word document-level settings across file round trips, separate from host UI preferences.
- [WordField](/raw/en/plugins/reference/word-field.md): Stores and recalculates Word fields such as page numbers, references and contents.
- [WordFieldRangeEnd](/raw/en/plugins/reference/word-field-range-end.md): Marks the end of a complex field range, preserving the relationship between instructions and results.
- [WordFieldRangeStart](/raw/en/plugins/reference/word-field-range-start.md): Marks the start of a complex field range and is managed together with field commands and its endpoint.
- [WordFloatingObjectAnchor](/raw/en/plugins/reference/word-floating-object-anchor.md): Stores Word floating-object positioning, wrapping and anchor relationships. The host supplies manipulation UI.
- [WordHeaderFooter](/raw/en/plugins/reference/word-header-footer.md): Resolves section-specific header/footer variants and materializes the corresponding stories.
- [WordHeading](/raw/en/plugins/reference/word-heading.md): Expresses headings through Word paragraph styles and outline levels rather than a generic Heading node.
- [WordInlineContentControl](/raw/en/plugins/reference/word-inline-content-control.md): Stores inline content controls. Display and authoring modes are session preferences rather than persisted Word attributes.
- [WordLayout](/raw/en/plugins/reference/word-layout.md): Registers Word document-profile facets with the generic engine. It does not mount a view.
- [WordMath](/raw/en/plugins/reference/word-math.md): Stores formula source, OMML preservation and editability state. Editing depends on supported source/model capabilities.
- [WordMathKit](/raw/en/plugins/reference/word-math-kit.md): Assembles Word formula nodes and commands; the product or host supplies authoring UI and rendering.
- [WordNote](/raw/en/plugins/reference/word-note.md): Owns footnote/endnote references, stories and numbering throughout insertion, deletion, copying and export.
- [WordNoteReference](/raw/en/plugins/reference/word-note-reference.md): Stores note references in body text and requires WordNote and the corresponding stories.
- [WordNoteRegistryExtension](/raw/en/plugins/reference/word-note-registry-extension.md): Maintains document-level note registry data as part of the note capability.
- [WordNumbering](/raw/en/plugins/reference/word-numbering.md): Maintains Word numbering definitions and level references on flat paragraphs rather than nested list wrappers.
- [WordPage](/raw/en/plugins/reference/word-page.md): Owns page decoration semantics and page-authoring commands, with an optional watermark text measurer.
- [WordPageBreak](/raw/en/plugins/reference/word-page-break.md): Stores explicit page breaks interpreted by the Word profile and layout runtime.
- [WordParagraph](/raw/en/plugins/reference/word-paragraph.md): Adds Word paragraph formatting to selected paragraph types, including indentation and spacing.
- [WordParagraphNode](/raw/en/plugins/reference/word-paragraph-node.md): Provides the Word paragraph node definition, separate from WordParagraph's formatting behavior.
- [WordPermission](/raw/en/plugins/reference/word-permission.md): Maintains permission ranges and document protection. Host authorization decides whether the current identity may write.
- [WordPermissionEnd](/raw/en/plugins/reference/word-permission-end.md): Stores a permission-range endpoint managed by permission commands and import normalization.
- [WordPermissionStart](/raw/en/plugins/reference/word-permission-start.md): Stores a permission-range start, used with its matching endpoint and authorization policy.
- [WordRevision](/raw/en/plugins/reference/word-revision.md): Tracks authored text, format and structural changes. Tracking policy and presentation are distinct from accepting or rejecting revisions.
- [WordRuby](/raw/en/plugins/reference/word-ruby.md): Stores base text and phonetic-guide units with alignment. canModify integrates host write policy.
- [WordRunFormatRevision](/raw/en/plugins/reference/word-run-format-revision.md): Stores canonical run-format revision marks coordinated by WordRevision and formatting owners.
- [WordSection](/raw/en/plugins/reference/word-section.md): Stores sections and page settings. Margins, paper size and orientation belong to the section model.
- [WordSectionTrailingNode](/raw/en/plugins/reference/word-section-trailing-node.md): Maintains an editable block at section boundaries. Complete Word assembly installs the section-aware behavior.
- [WordStory](/raw/en/plugins/reference/word-story.md): Stores auxiliary story content such as headers, footers and notes within one canonical document.
- [WordStoryExtensions](/raw/en/plugins/reference/word-story-extensions.md): An array combining document settings, story store and story nodes. Spread it into extensions for auxiliary-story assembly.
- [WordStoryStore](/raw/en/plugins/reference/word-story-store.md): Contains named auxiliary stories used by header/footer and note features.
- [WordStructuralContentControl](/raw/en/plugins/reference/word-structural-content-control.md): Adds structured content-control semantics to table rows and cells alongside the table schema.
- [WordStyles](/raw/en/plugins/reference/word-styles.md): Maintains named paragraph styles and effective formatting, separate from direct formatting and host preferences.
- [WordTable](/raw/en/plugins/reference/word-table.md): Defines Word tables and their commands. Rows, cells, layout and interaction must be assembled together.
- [WordTableCell](/raw/en/plugins/reference/word-table-cell.md): Stores cell content, formatting and merge semantics. Table commands preserve structural integrity.
- [WordTableExtensions](/raw/en/plugins/reference/word-table-extensions.md): An extension array combining Word table, row and cell nodes. Higher-level assembly still supplies layout profiles and product controls.
- [WordTableLayoutProfile](/raw/en/plugins/reference/word-table-layout-profile.md): Registers table-only layout semantics for partial assemblies such as continuous flow. Provided by AGPL classic-table-model and re-exported by classic-layout as WordTableLayout.
- [WordTableRow](/raw/en/plugins/reference/word-table-row.md): Defines table rows and their attributes as part of the WordTable structure.
- [BlockAsset](/raw/en/plugins/reference/block-asset.md): Attachment, audio and video blocks from local files or URLs that keep name, type, size and caption, with replace and download.
- [BlockColumn](/raw/en/plugins/reference/block-column.md): One column inside BlockColumns that owns its own editable child blocks.
- [BlockColumns](/raw/en/plugins/reference/block-columns.md): A two-to-four column container for continuous documents. It stores column content and ratios in document order and supports dragging or keyboard resizing; install it with BlockColumn.
- [BlockContainer](/raw/en/plugins/reference/block-container.md): Highlight and callout containers with an optional title or emoji. They hold any blocks and share MSFE's Prose container anatomy.
- [BlockDefinitions](/raw/en/plugins/reference/block-definitions.md): Editable term and description pairs, with item insertion and unwrapping, without generated placeholder text.
- [BlockFootnotes](/raw/en/plugins/reference/block-footnotes.md): Footnote references and definitions for continuous documents, numbered automatically with two-way navigation; independent of paginated Word footnotes.
- [BlockImageGallery](/raw/en/plugins/reference/block-image-gallery.md): Several images in one block with reordering, captions and layouts, plus full-size preview from the document.
- [BlockInlineAttachment](/raw/en/plugins/reference/block-inline-attachment.md): Attachments placed inside paragraphs that take part in ordinary text editing without losing their file identity.
- [BlockInlineContent](/raw/en/plugins/reference/block-inline-content.md): Typed inline dates that keep their time meaning, plus shared emoji authoring.
- [BlockMath](/raw/en/plugins/reference/block-math.md): Inline and display formulas using the independent formula core and visual formula editor.
- [BlockRichContent](/raw/en/plugins/reference/block-rich-content.md): Host services and the insertion contract shared by columns, templates, web cards and resources: per-file size limit, file storage and web metadata resolution. Without storage, files are kept as data URLs in the document.
- [BlockSections](/raw/en/plugins/reference/block-sections.md): Heading-based sections with folding and section-level operations; folding is transient view state and never changes content.
- [BlockWebCard](/raw/en/plugins/reference/block-web-card.md): Card and embed presentations of an ordinary web link with editable title and description; embeds load on demand in an isolated iframe.
- [createBlockEditorPreset](/raw/en/plugins/reference/create-block-editor-preset.md): Returns the Block content extension array for independent Core or custom products. It does not mount HTML View; unset children use preset defaults and false disables them.
- [createBlockNumberingExtensions](/raw/en/plugins/reference/create-block-numbering-extensions.md): Returns canonical Word numbering adapted to continuous HTML flow without pagination or the Classic shell.
- [createBlockParagraphExtensions](/raw/en/plugins/reference/create-block-paragraph-extensions.md): Returns paragraph alignment, indentation and spacing on the MIT Word paragraph model, projected to continuous HTML styles without page or column breaks. The Block preset already includes it; install it separately only after turning off the preset's paragraphFormat.
- [createBlockTableExtensions](/raw/en/plugins/reference/create-block-table-extensions.md): Returns table schema, table-only layout and Block insertion integration without Word sections, header/footer or full pagination.
- [ClassicDataView](/raw/en/plugins/reference/classic-data-view.md): Connects DataView to Classic UI, with replaceable workspace and layout ports.
- [ClassicEditorBackgroundColor](/raw/en/plugins/reference/classic-editor-background-color.md): Adds Classic product controls for BackgroundColor, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorBold](/raw/en/plugins/reference/classic-editor-bold.md): Adds Classic product controls for Bold, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorClipboard](/raw/en/plugins/reference/classic-editor-clipboard.md): Adds product clipboard actions and a plain-text paste shortcut, subject to browser clipboard capabilities.
- [ClassicEditorColor](/raw/en/plugins/reference/classic-editor-color.md): Adds Classic product controls for Color, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorFontFamily](/raw/en/plugins/reference/classic-editor-font-family.md): Adds Classic product controls for FontFamily, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorFontSize](/raw/en/plugins/reference/classic-editor-font-size.md): Adds Classic product controls for FontSize, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorFormatting](/raw/en/plugins/reference/classic-editor-formatting.md): Connects marks and text-style extensions to product controls. Disabling textStyle also affects dependent typography and color capabilities.
- [ClassicEditorFormattingTools](/raw/en/plugins/reference/classic-editor-formatting-tools.md): Adds Classic controls for Formatting while retaining its clear-format preservation policy.
- [ClassicEditorHistoryControls](/raw/en/plugins/reference/classic-editor-history-controls.md): Adds undo/redo controls without installing history storage, allowing a replacement history provider.
- [ClassicEditorHorizontalRule](/raw/en/plugins/reference/classic-editor-horizontal-rule.md): Adds Classic product controls for HorizontalRule, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorItalic](/raw/en/plugins/reference/classic-editor-italic.md): Adds Classic product controls for Italic, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorKit](/raw/en/plugins/reference/classic-editor-kit.md): Assembles generic content and Classic formatting, clipboard, search and history controls without Word or DOCX.
- [ClassicEditorSearch](/raw/en/plugins/reference/classic-editor-search.md): Adds Classic product controls for Search, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorStrike](/raw/en/plugins/reference/classic-editor-strike.md): Adds Classic product controls for Strike, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorSubscript](/raw/en/plugins/reference/classic-editor-subscript.md): Adds Classic product controls for Subscript, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorSuperscript](/raw/en/plugins/reference/classic-editor-superscript.md): Adds Classic product controls for Superscript, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorTextCase](/raw/en/plugins/reference/classic-editor-text-case.md): Adds Classic product controls for TextCase, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorTextStyle](/raw/en/plugins/reference/classic-editor-text-style.md): Adds Classic product controls for TextStyle, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorUnderline](/raw/en/plugins/reference/classic-editor-underline.md): Adds Classic product controls for Underline, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicEditorUndoRedo](/raw/en/plugins/reference/classic-editor-undo-redo.md): Adds Classic product controls for UndoRedo, retaining its public options. Do not add it again when ClassicEditorKit already installs it.
- [ClassicFlowchart](/raw/en/plugins/reference/classic-flowchart.md): Assembles flowchart content and a shared workspace, using editable Word pictures when available and block nodes otherwise.
- [ClassicMindMap](/raw/en/plugins/reference/classic-mind-map.md): Assembles mind-map authoring, including editable Word-picture integration when available. The host persists files and media.
- [ClassicTextDiagram](/raw/en/plugins/reference/classic-text-diagram.md): Connects text-diagram authoring to Classic and optional editable Word pictures, preserving source/preview consistency.
- [ClassicWhiteboard](/raw/en/plugins/reference/classic-whiteboard.md): Assembles whiteboard scenes, renaming and a workspace with default offscreen rendering.
- [ClassicWordChart](/raw/en/plugins/reference/classic-word-chart.md): Adds product chart insertion/editing UI while the chart domain owns native models and preservation.
- [ClassicWordComment](/raw/en/plugins/reference/classic-word-comment.md): Adds Pro comment/review UI and a host identity provider for newly authored comments and replies.
- [ClassicWordContentControl](/raw/en/plugins/reference/classic-word-content-control.md): Adds Pro content-control authoring UI, normally supplied through the professional preset's Word-kit seams.
- [ClassicWordDrawing](/raw/en/plugins/reference/classic-word-drawing.md): Adds picture, shape and drawing UI over canonical floating-object capabilities. Instance media services retain assets.
- [ClassicWordField](/raw/en/plugins/reference/classic-word-field.md): Adds product field actions while retaining WordField automatic recalculation behavior.
- [ClassicWordHeaderFooter](/raw/en/plugins/reference/classic-word-header-footer.md): Adds header/footer product entry points tied to the current section and auxiliary stories.
- [ClassicWordKit](/raw/en/plugins/reference/classic-word-kit.md): Assembles Word domains, layout and product controls. Most consumers use createClassicWordPreset; this layer supports custom presets.
- [ClassicWordLink](/raw/en/plugins/reference/classic-word-link.md): Adds Classic link editing controls over Link. The color option affects presentation rather than the stored target.
- [ClassicWordNumbering](/raw/en/plugins/reference/classic-word-numbering.md): Adds Word numbering controls. types targets Word paragraphs rather than generic list containers.
- [ClassicWordPage](/raw/en/plugins/reference/classic-word-page.md): Connects page authoring to product interactions, using an optional watermark text measurer.
- [ClassicWordParagraph](/raw/en/plugins/reference/classic-word-paragraph.md): Connects paragraph formatting to product panels and optional host-persisted style defaults, separate from document formatting.
- [ClassicWordProofing](/raw/en/plugins/reference/classic-word-proofing.md): Adds product UI to Proofing. Its direct default provider is null; ClassicWordKit may supply a preset-level provider.
- [ClassicWordRibbon](/raw/en/plugins/reference/classic-word-ribbon.md): Registers Word ribbon organization. Installed domains supply actions; the ribbon alone does not install capabilities.
- [ClassicWordRuler](/raw/en/plugins/reference/classic-word-ruler.md): Mounts rulers connected to page, section and paragraph commands without owning a second layout model.
- [ClassicWordSection](/raw/en/plugins/reference/classic-word-section.md): Adds product section interactions over canonical section semantics, normally through ClassicWordKit.
- [ClassicWordSymbol](/raw/en/plugins/reference/classic-word-symbol.md): Adds a grouped symbol catalog and insertion UI, with replaceable punctuation, math, currency and legal/unit groups.
- [ClassicWordTable](/raw/en/plugins/reference/classic-word-table.md): Adds table toolbar, ribbon and context-menu controls as independent presentation options.
- [OfficialDocument](/raw/en/plugins/reference/official-document.md): Provides composeOfficialDocument, which validates official-document data and replaces the whole document in one undoable edit.
- [classicEditorPreset](/raw/en/plugins/reference/classic-editor-preset.md): The default product-neutral Classic preset value, combining generic content, paginated views and the shell without Word or DOCX.
- [classicWordInsertCatalogPlugin](/raw/en/plugins/reference/classic-word-insert-catalog-plugin.md): A product-plugin value contributing community Word actions to the shared insert catalog. It does not install their document models; avoid duplicate catalog installation.
- [classicWordProInsertCatalogPlugin](/raw/en/plugins/reference/classic-word-pro-insert-catalog-plugin.md): Extends the community insert catalog with Pro content-control authoring actions. Requires the corresponding domains and professional capabilities without duplicate contributions.
- [createClassicAi](/raw/en/plugins/reference/create-classic-ai.md): Asynchronously returns a first-party AI plugin and a page-level destroy function. The host supplies browser Document and preference-storage ports.
- [createClassicAiPlugin](/raw/en/plugins/reference/create-classic-ai-plugin.md): Creates an AI plugin from host model/workspace ports. Installing it does not provide a model service or persistent sessions.
- [createClassicAiSidebarPlugin](/raw/en/plugins/reference/create-classic-ai-sidebar-plugin.md): Adds an AI sidebar using a host createWorkspace port per editor attachment. The host owns models, authorization mode and persistence.
- [createClassicDocumentTemplatePlugin](/raw/en/plugins/reference/create-classic-document-template-plugin.md): Adds a full-document template library. The provider reads templates and createDocument opens an independent copy, separate from export styling templates.
- [createClassicEditorOfdPlugin](/raw/en/plugins/reference/create-classic-editor-ofd-plugin.md): Registers native OFD export from shared fixed-layout content, with explicit font/resource policy.
- [createClassicEditorPdfPlugin](/raw/en/plugins/reference/create-classic-editor-pdf-plugin.md): Registers PDF export and optional printing. Hosts provide fonts, images and semantic contributions and present export reports.
- [createClassicOfficialDocumentPlugin](/raw/en/plugins/reference/create-classic-official-document-plugin.md): Installs composeOfficialDocument, which generates a complete official document from protocol data for hosts and Agents alike. No UI or subscriptions.
- [createClassicWordDocxPlugin](/raw/en/plugins/reference/create-classic-word-docx-plugin.md): Registers Word document/template import and export services and menus in Classic plugins, not Core extensions.
- [createClassicWordPreset](/raw/en/plugins/reference/create-classic-word-preset.md): Creates the community Word preset for createClassicEditor. Optional file services remain explicit product plugins.
- [createClassicWordProPreset](/raw/en/plugins/reference/create-classic-word-pro-preset.md): Extends the community preset with professional review, content-control and protection UI. Review UI follows the resolved review feature.
- [ClipboardTextSerializer](/raw/en/plugins/reference/clipboard-text-serializer.md): Controls plain-text clipboard serialization, normally configured through Editor coreExtensionOptions.
- [CommandsExtension](/raw/en/plugins/reference/commands-extension.md): Provides Core commands and is installed by Editor by default. Configure built-ins through Editor options.
- [Delete](/raw/en/plugins/reference/delete.md): Observes committed changes and emits deletion events. filterTransaction filters notifications rather than preventing deletion.
- [Drop](/raw/en/plugins/reference/drop.md): Connects Core drop-event notifications while the active view owns hit testing and data reception.
- [Editable](/raw/en/plugins/reference/editable.md): Connects Editor editability to the view. Change read-only state through Editor APIs.
- [FocusEvents](/raw/en/plugins/reference/focus-events.md): Forwards view focus/blur events to Editor, separate from Focus decorations.
- [Keymap](/raw/en/plugins/reference/keymap.md): Provides Core-owned key behavior and document-boundary handling, distinct from StarterKit's BaseKeymap.
- [Paste](/raw/en/plugins/reference/paste.md): Connects paste events to Core lifecycle; parsing, filtering and uploads belong to their respective owners.
- [Tabindex](/raw/en/plugins/reference/tabindex.md): Sets view tabindex, normally through coreExtensionOptions.tabindex.value.
- [TextDirection](/raw/en/plugins/reference/text-direction.md): Handles default text direction, normally set through Editor textDirection rather than document language attributes.
- [Classic documentation](/raw/en/classic.md): Embed the paginated editor and configure its interface, plugins and licensing for your product.
- [Classic quick start](/raw/en/classic/quick-start.md): Compose Core, paginated views and product UI into a complete editing experience.
- [Configuration and lifetime](/raw/en/classic/configuration.md): Separate initial content, product settings and host services, then update and dispose the editor correctly.
- [Free evaluation and community licenses](/raw/en/classic/free.md): Evaluation is free with no time limit; open-source projects, individuals, education and non-profits can use it free; production needs a license.
- [Commercial use](/raw/en/classic/commercial.md): Confirm product lines, version coverage and deployment scope before installing capabilities.
- [License keys and deployment](/raw/en/classic/license.md): Set a key before creating the product and check each product line in the real deployment environment.
- [Save, open and convert files](/raw/en/classic/files.md): Connect unsaved state, versioned JSON and DOCX services while handling storage failures and conversion loss.
- [Product plugins](/raw/en/classic/plugins.md): Compose Classic file services, professional capabilities and interface plugins, or build your own product features.
- [Classic API](/raw/en/classic/api.md): Public composition, context, actions and resource lifetime.
- [Instance and configuration reference](/raw/en/classic/reference.md): Look up public Classic creation settings, updates, instance methods and UI controls.
- [Images and durable media](/raw/en/classic/media.md): Persist image bytes with canonical references for restoration, undo and DOCX conversion.
- [Font loading and substitution](/raw/en/classic/fonts.md): Connect application or external fonts and separate logical families, rendered faces and export resources.
- [Develop Word document actions](/raw/en/classic/word-tasks.md): Connect styles, numbering, tables and page numbers to product controls and distinguish sections from pages.
- [Generate and read back official documents](/raw/en/classic/official-document.md): A business system submits official-document JSON and gets an editable document laid out to GB/T 9704; after editing, the same data format reads back.