WordHeaderFooter · QuireKit

Resolves section-specific header/footer variants and materializes the corresponding stories.

@quirekit/classic-header-footer · Commercial

Editor compatibility

Layer：Shared document capability

Editor	Status	Assembly and boundaries
Classic	Supported	createClassicWordPreset — Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.
Block	Unsupported	This entry depends on Word pagination, sections or auxiliary-story layout, which the current continuous-flow Block product does not provide.

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

The current @quirekit/classic-header-footer 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.

Start a Word product with the Word preset. This export supports independent Core or custom presets; assemble companion nodes, commands and layout, without duplicate names.

import { WordHeaderFooter } from '@quirekit/classic-header-footer'

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

Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.

createClassicWordPreset

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.

sectionNodeName

Structural Word section node name.

Type：string

Default："wordSection"

storyStoreNodeName

Top-level auxiliary-story store node name.

Type：string

Default："wordStoryStore"

storyNodeName

Persisted auxiliary-story node name.

Type：string

Default："wordStory"

emptyBlockNodeName

Empty block created when no inherited story exists.

Type：string

Default："paragraph"

Commands and runtime

These commands are supplied directly by this extension. Availability depends on the installed schema, selection and protection policy; query editor.can() first.

Command	Parameter signature
`editWordHeaderFooterStoryContent`	`editWordHeaderFooterStoryContent(options: EditWordHeaderFooterStoryContentOptions)`
`materializeWordHeaderFooterStory`	`materializeWordHeaderFooterStory(options: MaterializeWordHeaderFooterStoryOptions)`
`setWordHeaderFooterDistance`	`setWordHeaderFooterDistance(options: SetWordHeaderFooterDistanceOptions)`
`ensureWordHeaderFooterVariantStories`	`ensureWordHeaderFooterVariantStories(options: EnsureWordHeaderFooterVariantStoriesOptions)`
`setWordHeaderFooterDifferentFirstPage`	`setWordHeaderFooterDifferentFirstPage(options: SetWordHeaderFooterDifferentFirstPageOptions)`
`setWordHeaderFooterDifferentOddEven`	`setWordHeaderFooterDifferentOddEven(options: SetWordHeaderFooterDifferentOddEvenOptions)`
`setWordHeaderFooterLinkToPrevious`	`setWordHeaderFooterLinkToPrevious(options: SetWordHeaderFooterLinkToPreviousOptions)`

These are parameter signatures. See commands and controls to connect UI while retaining one transaction/history authority.

Next steps

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

See extension development for custom capabilities and Build a product for complete hosting.