Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Kits and bundlesView Markdown ↗

TextStyleKit

Bundles TextStyle and its typography/color/language companions. Highlight and font resources are separate.

Bundles TextStyle and its typography/color/language companions. Highlight and font resources are separate.

@quirekit/extension-text-style · MIT

Editor compatibility

Layer:Shared document capability

EditorStatusAssembly and boundaries
ClassicRequires integrationClassicEditorFormatting — Classic uses ClassicEditorFormatting for text styles and controls. Start with the default preset and configure its adapter fields instead of adding a duplicate TextStyleKit.
BlockSupportedcreateBlockEditorPreset — The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

“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

Install in Editor extensions. The host supplies a view, container and persistence; see Quick start.

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 · Requires integration

Classic uses ClassicEditorFormatting for text styles and controls. Start with the default preset and configure its adapter fields instead of adding a duplicate TextStyleKit.

ClassicEditorFormatting
ts

Configuration

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

doubleStrike

Double-strike extension options, or false to disable.

Type:false | Partial<DoubleStrikeOptions>

Default:{}

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

superscript

Superscript extension options, or false to disable.

Type:false | Partial<ScriptPositionOptions>

Default:{}

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

subscript

Subscript extension options, or false to disable.

Type:false | Partial<ScriptPositionOptions>

Default:{}

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

fontFamily

Font family extension options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

color

Color extension options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

backgroundColor

Background color extension options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

fontSize

Font size extension options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

letterSpacing

Word-compatible character-spacing options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

language

Word-compatible run-language options, or false to disable.

Type:false | Partial<TextStyleAttributeExtensionOptions>

Default:{}

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

textStyle

TextStyle mark options, or false to disable.

Type:false | Partial<TextStyleOptions>

Default:{}

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

Other public exports

  • textStyleKitExtension · @quirekit/extension-text-style

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.

QuireKitQuireKit · Core, plugins and Classic docs