ClassicWordNumbering
Adds Word numbering controls. types targets Word paragraphs rather than generic list containers.
Adds Word numbering controls. types targets Word paragraphs rather than generic list containers.
@quirekit/classic-docx · Commercial
Editor compatibility
Layer:Classic product integration
| 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 | 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-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 { ClassicWordNumbering } from '@quirekit/classic-docx'
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.
createClassicWordPresetimport { 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(),
})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
These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.
ribbon
Whether the capability contributes its default Classic ribbon items.
Type:boolean
Default:false
types
Paragraph-like node names that receive flat numbering references.
Type:readonly string[]
Default:Object.freeze([ "paragraph", "heading" ])
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 |
|---|---|
updateWordNumberingDefinition | updateWordNumberingDefinition(options: UpdateWordNumberingDefinitionOptions) |
mergeWordNumberingRegistry | mergeWordNumberingRegistry(options: MergeWordNumberingRegistryOptions) |
applyWordNumberingPreset | applyWordNumberingPreset(options: ApplyWordNumberingPresetOptions) |
applyWordNumberingTemplate | applyWordNumberingTemplate(options: ApplyWordNumberingTemplateOptions) |
toggleWordOrderedList | toggleWordOrderedList(options?: ToggleWordOrderedListOptions | undefined) |
toggleWordBulletList | toggleWordBulletList() |
toggleWordTaskList | toggleWordTaskList(options?: ToggleWordTaskListOptions | undefined) |
clearWordList | clearWordList() |
clearWordListAtPosition | clearWordListAtPosition(options: WordNumberingAtPositionOptions) |
increaseWordListLevel | increaseWordListLevel() |
decreaseWordListLevel | decreaseWordListLevel() |
toggleWordTaskChecked | toggleWordTaskChecked() |
setWordTaskChecked | setWordTaskChecked(options: SetWordTaskCheckedOptions) |
toggleWordTaskAtPosition | toggleWordTaskAtPosition(options: ToggleWordTaskAtPositionOptions) |
restartWordNumbering | restartWordNumbering(options: RestartWordNumberingOptions) |
continueWordNumbering | continueWordNumbering() |
restartWordNumberingAtPosition | restartWordNumberingAtPosition(options: RestartWordNumberingAtPositionOptions) |
continueWordNumberingAtPosition | continueWordNumberingAtPosition(options: WordNumberingAtPositionOptions) |
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.
Continue with Classic quick start and configuration/lifetime. See product plugin development for your own UI and services.