Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Classic product extensionsView Markdown ↗

ClassicEditorFormatting

Connects marks and text-style extensions to product controls. Disabling textStyle also affects dependent typography and color capabilities.

Connects marks and text-style extensions to product controls. Disabling textStyle also affects dependent typography and color capabilities.

@quirekit/classic-editor · AGPL-3.0-only

Editor compatibility

Layer:Classic product integration

EditorStatusAssembly and boundaries
ClassicSupportedclassicEditorPreset — Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model.
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

sh

Use the Classic kit. Individual adapters support custom assembly or replacement without duplicate names.

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

Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model.

classicEditorPreset
ts

Configuration

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

doubleStrike

Double-strike options, or false to omit the Word-compatible mark.

Type:false | Partial<DoubleStrikeOptions>

Default:{}

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

superscript

Superscript options, or false to omit the semantic mark.

Type:false | Partial<ScriptPositionOptions>

Default:{}

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

subscript

Subscript options, or false to omit the semantic mark.

Type:false | Partial<ScriptPositionOptions>

Default:{}

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

bold

Bold Mark options, or false to omit Bold from the formatting group.

Type:StarterKitExtensionOption<BoldOptions> | undefined

Default:{}

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

italic

Italic Mark options, or false to omit Italic from the formatting group.

Type:StarterKitExtensionOption<ItalicOptions> | undefined

Default:{}

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

highlight

Semantic Highlight options, or false to omit OOXML-compatible highlighting.

Type:false | Partial<HighlightOptions>

Default:{}

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

underline

Underline Mark options, or false to omit Underline from the formatting group.

Type:StarterKitExtensionOption<UnderlineOptions> | undefined

Default:{}

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

strike

Strike Mark options, or false to omit Strike from the formatting group.

Type:StarterKitExtensionOption<StrikeOptions> | undefined

Default:{}

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

textStyle

TextStyle Mark options, or false to omit direct text-style storage.

Type:false | Partial<TextStyleOptions>

Default:{}

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

fontFamily

FontFamily options, or false to omit direct family commands and picker.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

fontSize

FontSize options, or false to omit size commands and controls.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

letterSpacing

LetterSpacing options, or false to omit Word-compatible tracking commands.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

language

Run-language options, or false to omit Word-compatible language commands.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

color

Text Color options, or false to omit foreground color commands and controls.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

backgroundColor

BackgroundColor options, or false to omit character shading controls.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

See BackgroundColor 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.

QuireKitQuireKit · Core, plugins and Classic docs