ClassicEditorFormatting · Classic 文字格式装配

把文字标记与样式扩展接到产品控件。子项可设为 false；关闭 textStyle 时需要同时检查依赖它的字体和颜色能力。

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

编辑器适用范围

层次：Classic 产品适配

“直接支持”指已有上述产品装配；具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。

接入

pnpm add @quirekit/classic-editor@alpha

先使用 Classic 基础装配。这里的单项适配器用于自定义预设或替换子项；不能向已有装配再追加同名扩展。

import { ClassicEditorFormatting } from '@quirekit/classic-editor'

安装时按包声明选择兼容版本，外部可用版本以分发源为准。本站使用工作区 Alpha；许可标签来自入口所属包，使用条件见支持与许可。

按编辑器接入

以下片段沿用已挂载的宿主元素 element，宿主负责容器尺寸与保存；退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加；需要宿主端口的入口应先完成下方配置。

import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'

const instance = createClassicEditor({ element })

配置

下面是扩展自身的默认选项。预设可以覆盖这些值；它们不等于当前文档属性。配置方法见配置插件。

doubleStrike

配置 DoubleStrike 子扩展；允许 false 时可关闭此项。

类型：false | Partial<DoubleStrikeOptions>

默认：{}

子扩展的具体选项见 DoubleStrike。是否可以设为 false，以本字段类型为准。

superscript

配置 Superscript 子扩展；允许 false 时可关闭此项。

类型：false | Partial<ScriptPositionOptions>

默认：{}

子扩展的具体选项见 Superscript。是否可以设为 false，以本字段类型为准。

subscript

配置 Subscript 子扩展；允许 false 时可关闭此项。

类型：false | Partial<ScriptPositionOptions>

默认：{}

子扩展的具体选项见 Subscript。是否可以设为 false，以本字段类型为准。

bold

配置 Bold 子扩展；允许 false 时可关闭此项。

类型：StarterKitExtensionOption<BoldOptions> | undefined

默认：{}

子扩展的具体选项见 Bold。是否可以设为 false，以本字段类型为准。

italic

配置 Italic 子扩展；允许 false 时可关闭此项。

类型：StarterKitExtensionOption<ItalicOptions> | undefined

默认：{}

子扩展的具体选项见 Italic。是否可以设为 false，以本字段类型为准。

highlight

匹配结果与当前结果的展示颜色。Search 使用 match、active、activeOutline。

类型：false | Partial<HighlightOptions>

默认：{}

子扩展的具体选项见 Highlight。是否可以设为 false，以本字段类型为准。

underline

配置 Underline 子扩展；允许 false 时可关闭此项。

类型：StarterKitExtensionOption<UnderlineOptions> | undefined

默认：{}

子扩展的具体选项见 Underline。是否可以设为 false，以本字段类型为准。

strike

配置 Strike 子扩展；允许 false 时可关闭此项。

类型：StarterKitExtensionOption<StrikeOptions> | undefined

默认：{}

子扩展的具体选项见 Strike。是否可以设为 false，以本字段类型为准。

textStyle

配置 TextStyle 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleOptions>

默认：{}

子扩展的具体选项见 TextStyle。是否可以设为 false，以本字段类型为准。

fontFamily

配置 FontFamily 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 FontFamily。是否可以设为 false，以本字段类型为准。

fontSize

配置 FontSize 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 FontSize。是否可以设为 false，以本字段类型为准。

letterSpacing

配置 LetterSpacing 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 LetterSpacing。是否可以设为 false，以本字段类型为准。

language

配置 Language 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 Language。是否可以设为 false，以本字段类型为准。

color

链接显示颜色；文字前景色扩展则通过命令设置具体颜色。此配置不改变链接目标。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 Color。是否可以设为 false，以本字段类型为准。

backgroundColor

配置 BackgroundColor 子扩展；允许 false 时可关闭此项。

类型：false | Partial<TextStyleAttributeExtensionOptions>

默认：{}

子扩展的具体选项见 BackgroundColor。是否可以设为 false，以本字段类型为准。

命令与运行方式

此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供；产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。

下一步

返回全部插件，或阅读配置插件区分配置、文档属性与命令。

继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时，见产品插件开发。