CodeBlock · 代码块

保存多行纯文本代码和语言属性，支持退出代码块与 Tab 缩进策略。语言属性不会自动安装语法高亮器。

@quirekit/extension-code-block · MIT

编辑器适用范围

层次：共享文档能力

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

接入

pnpm add @quirekit/extension-code-block@alpha

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

StarterKit 已包含此能力，在 StarterKit.configure() 的 codeBlock 子项中配置；设为 false 后才能单独安装同名替代。

import { CodeBlock } from '@quirekit/extension-code-block'

const code = CodeBlock.configure({ enableTabIndentation: true, tabSize: 2 })

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

按编辑器接入

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

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

const instance = createClassicEditor({ element })

import { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'

const instance = createBlockEditor({
  element,
  content: { type: 'doc', content: [{ type: 'paragraph' }] },
})

配置

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

languageClassPrefix

HTML code 元素语言类名前缀。null 可关闭前缀；不负责加载高亮器。

类型：string | null | undefined

默认："language-"

exitOnTripleEnter

是否允许连续三次 Enter 退出代码块。

类型：false | null | true | undefined

默认：true

exitOnArrowDown

光标在文末代码块末尾时，是否允许向下方向键退出。

类型：false | null | true | undefined

默认：true

defaultLanguage

新建代码块未指定语言时保存的代码语言值，不负责安装语法高亮器。

类型：string | null | undefined

默认：null

enableTabIndentation

是否接管代码块中的 Tab 与 Shift-Tab 来增加或减少缩进。

类型：false | null | true | undefined

默认：false

tabSize

代码缩进一次插入或移除的空格数。

类型：number | null | undefined

默认：4

HTMLAttributes

序列化 HTML 时合并的属性，例如 class。它不修改 Canvas 排版，也不是文档中节点属性的默认值。

类型：Record<string, unknown>

默认：{}

命令与运行方式

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

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

其他公开入口

• CodeBlock · @quirekit/starter-kit

下一步

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

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