Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Product presets and servicesView Markdown ↗

createClassicWordDocxPlugin

Registers Word document/template import and export services and menus in Classic plugins, not Core extensions.

Registers Word document/template import and export services and menus in Classic plugins, not Core extensions.

@quirekit/classic-docx · Commercial

Editor compatibility

Layer:Classic product integration

EditorStatusAssembly and boundaries
ClassicSupportedInstall this Classic product plugin in createClassicEditor plugins. Supply its required models, host ports and services as documented below.
BlockUnsupportedBlock does not consume Classic product contributions, plugins or paginated assembly. Use shared capabilities and Block adapters instead of copying this entry's Classic configuration.

“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.

Install the product plugin in createClassicEditor plugins rather than Core extensions. Required host ports are listed below.

ts

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.

Classic · Supported

Install this Classic product plugin in createClassicEditor plugins. Supply its required models, host ports and services as documented below.

ts

Configuration

Pass these fields to the factory options. Required ports come from the host. undefined means no explicit option; documented factory fallbacks apply.

codec

Optional codec override; the workspace lit-docx runtime is the default.

Type:DocxCodec | undefined

Default:createWorkspaceLitDocxCodec()

pluginId

Plugin id used when more than one product assembly is present.

Type:string | undefined

Default:"classic.docx"

serviceId

Registered document-service id.

Type:string | undefined

Default:"docx"

fileName

Suggested export file name including the .docx extension.

Type:string | undefined

Default:"document.docx"

templateServiceId

Registered Word template (.dotx) service id.

Type:string | undefined

Default:"dotx"

templateFileName

Suggested template export file name including the .dotx extension.

Type:string | undefined

Default:"template.dotx"

onReport

Optional structured report callback invoked after every completed conversion.

Type:((detail: ClassicWordDocxReportDetail) => void) | undefined

Default:undefined

Commands and runtime

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

Other public exports

  • createClassicWordDocxPlugin · @quirekit/classic-docx/docx

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.

QuireKitQuireKit · Core, plugins and Classic docs