ClassicWordParagraph · Word 段落控件
连接 Word 段落格式与产品面板,并支持宿主持久化个人样式默认值。该偏好存储不替代文档中的样式与直接格式。
连接 Word 段落格式与产品面板,并支持宿主持久化个人样式默认值。该偏好存储不替代文档中的样式与直接格式。
@quirekit/classic-docx · Commercial
编辑器适用范围
层次:Classic 产品适配
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | createClassicWordPreset — 使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。 |
| Block | 未支持 | Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
当前 @quirekit/classic-docx 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。
此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。
先使用 Word 预设。这里的单项适配器用于自定义预设或替换子项;不能向已有装配再追加同名扩展。
import { ClassicWordParagraph } from '@quirekit/classic-docx'
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 直接支持
使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 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 · 未支持
Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。
配置
下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。
ribbon
是否向 Classic 功能区贡献控件。直接使用适配器与由预设装配时的值可能不同。
类型:boolean
默认:false
styleUserDefaultsStore
个人样式默认值的宿主读写接口,未提供时不承诺跨会话保存。
类型:WordParagraphStyleUserDefaultsStore | null
默认:null
types
需要附加此能力的节点或标记类型名,必须与当前 schema 的实际名称一致。
类型:readonly string[]
默认:Object.freeze([ "paragraph", "heading" ])
命令与运行方式
以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。
| 命令 | 参数签名 |
|---|---|
insertWordBlankPage | insertWordBlankPage() |
insertWordPageBreak | insertWordPageBreak(options?: { readonly position?: number; } | undefined) |
insertWordColumnBreak | insertWordColumnBreak(options?: { readonly position?: number; } | undefined) |
setWordParagraphProperties | setWordParagraphProperties(options: SetWordParagraphPropertiesOptions) |
setWordParagraphIndentation | setWordParagraphIndentation(options: SetWordParagraphIndentationOptions) |
setWordParagraphSpacingSide | setWordParagraphSpacingSide(options: SetWordParagraphSpacingSideOptions) |
setWordParagraphSpacing | setWordParagraphSpacing(options: SetWordParagraphSpacingOptions) |
setWordParagraphLineSpacing | setWordParagraphLineSpacing(options: SetWordParagraphLineSpacingOptions) |
increaseWordParagraphIndentation | increaseWordParagraphIndentation() |
decreaseWordParagraphIndentation | decreaseWordParagraphIndentation() |
这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。
下一步
继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。