ClassicWordKit

Assembles Word domains, layout and product controls. Most consumers use createClassicWordPreset; this layer supports custom presets.

@quirekit/classic-docx · Commercial

Editor compatibility

Layer：Classic product integration

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See status and integration rules. Licensing is shown separately.

Installation

The current @quirekit/classic-docx manifest is private. This site uses workspace source; external projects need the relevant distribution package rather than assuming public npm availability.

This entry is a commercial component. Obtain distribution access and authorization first; installation commands require that distribution source.

Use the Word preset. Individual adapters support custom assembly or replacement without duplicate names.

import { ClassicWordKit } from '@quirekit/classic-docx'

const word = ClassicWordKit.configure({ ruler: false, proofing: false })

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see support and licensing.

Integration by editor

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument, createClassicWordPreset } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'

const instance = createClassicEditor({
  element,
  preset: createClassicWordPreset(),
  document: createClassicWordDefaultDocument(),
})

Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.

page

Page authoring capabilities, including a font service for headless watermark creation.

Type：WordPageOptions

Default：{}

See WordPage for child settings. Only pass false when this field's type permits it.

paragraphTypes

Paragraph-like nodes shared by formatting, styles, numbering and revision owners.

Type：readonly string[]

Default：["paragraph", "heading"]

blockInteraction

Same-section block controls, or false to omit their schema identity and commands.

Type：false | { readonly requirePortableIdentity?: boolean; }

Default：{}

See BlockInteraction for child settings. Only pass false when this field's type permits it.

contentControl

Whether inline content-control schema, actions, and optional ribbon UI are installed.

Type：boolean

Default：true

contentControlDisplayMode

Initial editor-only content-control chrome policy.

Type："alwaysShow" | "automatic" | "hide"

Default："automatic"

contentControlAuthoringMode

Initial transient content-control template/fill authoring mode.

Type："fill" | "template"

Default："template"

table

Whether Word table schema and editing behavior are installed.

Type：boolean

Default：true

See WordTable for child settings. Only pass false when this field's type permits it.

drawing

Whether floating-object schema and Canvas drawing behavior are installed.

Type：boolean

Default：true

featureExtensions

Replacements for the default engine-only comment, revision and content-control extensions.

Type：Partial<ClassicWordKitFeatureExtensions> | null

Default：null

symbol

Whether Unicode symbol insertion and its optional ribbon gallery are installed.

Type：boolean

Default：true

link

Whether the safe Link Mark and its optional ribbon editor are installed.

Type：boolean

Default：true

See Link for child settings. Only pass false when this field's type permits it.

linkColor

Derived Link glyph color supplied by the owning Classic product theme.

Type：string

Default："#4b67f2"

toolbar

Whether capabilities contribute their compact-toolbar placements.

Type：boolean

Default：true

ribbon

Whether the cross-feature Classic Word ribbon placement is installed.

Type：boolean

Default：true

contextMenu

Opts into legacy Table context-menu placements; false by default because selection tools own table editing.

Type：boolean

Default：false

ruler

Whether the interactive Classic Word ruler is installed.

Type：boolean

Default：true

styleUserDefaultsStore

Optional host-owned persistence for user-default paragraph styles.

Type：WordParagraphStyleUserDefaultsStore | null

Default：null

proofing

Spelling checker options over the Word policy and the shared Hunspell provider, or false to leave it out.

Type：false | Partial<ProofingExtensionOptions>

Default：{}

See Proofing for child settings. Only pass false when this field's type permits it.

Commands and runtime

This entry declares no directly enumerable commands. Children supply bundle commands; product plugins use contributions or document services.

Next steps

Return to all plugins, or read configuration to distinguish options, attributes and commands.

Continue with Classic quick start and configuration/lifetime. See product plugin development for your own UI and services.