createClassicEditorOfdPlugin
Registers native OFD export from shared fixed-layout content, with explicit font/resource policy.
Registers native OFD export from shared fixed-layout content, with explicit font/resource policy.
@quirekit/classic-ofd · Commercial
Editor compatibility
Layer:Classic product integration
| Editor | Status | Assembly and boundaries |
|---|---|---|
| Classic | Supported | Install this Classic product plugin in createClassicEditor plugins. Supply its required models, host ports and services as documented below. |
| Block | Unsupported | Block 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-ofd 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.
import { createClassicEditorOfdPlugin } from '@quirekit/classic-ofd'
const ofd = createClassicEditorOfdPlugin({ fileName: 'report.ofd' })
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.
import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument } from '@quirekit/classic-docx'
import { createClassicWordPreset } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'
import { createClassicEditorOfdPlugin } from '@quirekit/classic-ofd'
const instance = createClassicEditor({
element,
preset: createClassicWordPreset(),
document: createClassicWordDefaultDocument(),
plugins: [createClassicEditorOfdPlugin()],
})Block · Unsupported
Block does not consume Classic product contributions, plugins or paginated assembly. Use shared capabilities and Block adapters instead of copying this entry's Classic configuration.
Configuration
Pass these fields to the factory options. Required ports come from the host. undefined means no explicit option; documented factory fallbacks apply.
pluginId
Plugin id used when more than one product assembly is present.
Type:string
Default:"classic.ofd"
serviceId
Registered document-service id.
Type:string
Default:"ofd"
fileName
Suggested export file name including the .ofd extension.
Type:string
Default:"document.ofd"
pageGeometry
Explicit page geometry; document Word section geometry wins when omitted.
Type:QuirePageGeometry
Default:undefined
textMeasurer
Text measurer used by targetless full-document layout.
Type:QuireTextMeasurer
Default:undefined
fonts
Explicit embeddable OFD font faces.
Type:readonly QuireOfdFontSource[]
Default:undefined
fontEmbedding
Complete-face or Unicode-subset embedding policy.
Type:"full" | "subset"
Default:undefined
loadFonts
Lazy font loader that overrides fonts when supplied.
Type:(context: ClassicEditorServiceContext): readonly QuireOfdFontSource[] | Promise<readonly QuireOfdFontSource[]>
Default:undefined
resolveImage
Host-owned image resolver.
Type:(command: QuireImageCommand): Promise<QuireOfdResolvedImage | undefined> | QuireOfdResolvedImage | undefined
Default:createClassicEditorOfdImageResolver( context.instance.media.resolver )
metadata
Optional OFD document information.
Type:QuireOfdMetadata
Default:undefined
fallbackMode
Loss policy passed to the native OFD backend.
Type:"diagnostic" | "strict"
Default:undefined
onReport
Optional structured report callback invoked after export completes.
Type:(detail: ClassicEditorOfdExportReportDetail): void
Default:undefined
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.