ClassicWordProofing · Word 校对控件

在 Proofing 上增加产品界面。直接配置时 provider 默认仍为空；ClassicWordKit 可提供自己的默认 provider，不能混淆两种默认值。

@quirekit/classic-docx · Commercial

编辑器适用范围

层次：Classic 产品适配

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

接入

当前 @quirekit/classic-docx 的包元数据标为 private。本站使用工作区源码；外部项目需先取得对应分发包，不能把下面的公开导出理解为已经能从公共 npm 安装。

此入口属于商业组件。使用前先取得相应分发与授权；安装命令仅适用于已配置该分发源的项目。

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

import { ClassicWordProofing } from '@quirekit/classic-docx'

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

按编辑器接入

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

import { 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(),
})

配置

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

ribbon

是否向 Classic 功能区贡献控件。直接使用适配器与由预设装配时的值可能不同。

类型：boolean

默认：false

enabled

是否启用此能力的会话行为。禁用不会删除规范文档内容。

类型：boolean

默认：true

provider

直接使用此适配器时默认 null；完整 Word kit 可以注入默认 provider。自定义检查服务在这里传入。

类型：ProofingProvider | null

默认：null

policy

校对时的策略适配，用于语言、分段或业务范围等规则。

类型：ProofingDocumentPolicy | null

默认：createClassicWordProofingPolicy()

defaultLanguage

未从文本读取到语言时使用的默认语言；CodeBlock 中则是代码语言值。

类型：string | null

默认："en-US"

debounceMs

连续输入后等待再检查的延迟，单位为毫秒。

类型：number

默认：400

maxWaitMs

连续输入期间允许推迟校对的最长时间，单位为毫秒。

类型：number

默认：2000

timeoutMs

单次校对请求超时，单位为毫秒。

类型：number

默认：10000

maxConcurrentRequests

最多同时执行的校对请求数。

类型：number

默认：2

maxSegmentsPerBatch

每批提交的最大文本分段数。

类型：number

默认：40

maxCharactersPerBatch

每批提交的最大字符数。

类型：number

默认：8000

maxSuggestions

每个校对问题最多保留的建议数。

类型：number

默认：5

maxIssues

会话最多保留的问题数量，避免无界增长。

类型：number

默认：2000

dictionaryStore

个人词典的宿主持久化接口。未提供时不承诺跨页面保留。

类型：ProofingDictionaryStore | null

默认：null

appearance

拼写、语法与风格问题的下划线颜色配置。

类型：ProofingAppearance

默认：{ spelling: "#e5484d", grammar: "#3e63dd", style: "#8e4ec6" }

onError

校对发生错误时的回调；用于宿主反馈或记录失败。

类型：((error: ProofingError) => void) | null

默认：null

resolveVisibleRange

读取当前可见文档范围，供校对调度优先处理。默认实现使用已挂载视图。

类型：((editor: QuireEditor) => ProofingRange | null) | null

默认：resolveDefaultProofingVisibleRange

命令与运行方式

以下命令由此扩展直接提供，均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定；可以先用 editor.can() 查询。

这里只展示参数签名。接界面时见命令与控件，正文变更继续经过同一事务与历史。

下一步

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

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