跳到正文
QuireKit
插件文档
Alpha · API 持续演进
预设与组合查看 Markdown ↗

TextStyleKit · 文字样式预设

组合 TextStyle 与字体、字号、颜色、底色、间距、语言及上下标等扩展。它不包含 Highlight,也不自动下载字体。

组合 TextStyle 与字体、字号、颜色、底色、间距、语言及上下标等扩展。它不包含 Highlight,也不自动下载字体。

@quirekit/extension-text-style · MIT

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic需适配ClassicEditorFormatting — Classic 通过 ClassicEditorFormatting 装配文字样式和产品控件。沿用默认预设,按适配器的字段配置;不要把整个 TextStyleKit 再重复追加。
Block直接支持createBlockEditorPreset — createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。

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

接入

sh

在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。

ts

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

按编辑器接入

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

Classic · 需适配

Classic 通过 ClassicEditorFormatting 装配文字样式和产品控件。沿用默认预设,按适配器的字段配置;不要把整个 TextStyleKit 再重复追加。

ClassicEditorFormatting
ts

配置

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

doubleStrike

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

类型:false | Partial<DoubleStrikeOptions>

默认:{}

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

superscript

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

类型:false | Partial<ScriptPositionOptions>

默认:{}

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

subscript

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

类型:false | Partial<ScriptPositionOptions>

默认:{}

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

fontFamily

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

类型:false | Partial<TextStyleAttributeExtensionOptions>

默认:{}

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

color

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

类型:false | Partial<TextStyleAttributeExtensionOptions>

默认:{}

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

backgroundColor

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

类型:false | Partial<TextStyleAttributeExtensionOptions>

默认:{}

子扩展的具体选项见 BackgroundColor。是否可以设为 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,以本字段类型为准。

textStyle

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

类型:false | Partial<TextStyleOptions>

默认:{}

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

命令与运行方式

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

其他公开入口

  • textStyleKitExtension · @quirekit/extension-text-style

下一步

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

自己定义能力时见扩展开发;搭建完整宿主时见构建产品。

QuireKitQuireKit · Core、插件与 Classic 文档