保存链接目标并提供插入、更新和取消链接命令。可在输入完整网址后自动成链;链接编辑界面和打开行为由宿主接入。
@quirekit/extension-link · MIT
编辑器适用范围
层次:共享文档能力
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | createClassicWordPreset — 使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。 |
| Block | 直接支持 | createBlockEditorPreset — createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
pnpm add @quirekit/extension-link@alpha
在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。
import { Link } from '@quirekit/extension-link'
const links = Link.configure({ autolink: false, color: '#2255cc' })
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 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 · 直接支持
createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。
createBlockEditorPresetimport { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'
const instance = createBlockEditor({
element,
content: { type: 'doc', content: [{ type: 'paragraph' }] },
})配置
下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。
HTMLAttributes
序列化 HTML 时合并的属性,例如 class。它不修改 Canvas 排版,也不是文档中节点属性的默认值。
类型:Record<string, unknown>
默认:{}
color
链接文字的派生展示颜色,不写入链接目标 href。
类型:string
默认:"#0563c1"
autolink
在完整网址后输入空白或 Enter 时,是否自动建立链接。
类型:boolean
默认:true
命令与运行方式
以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。
| 命令 | 参数签名 |
|---|---|
setLink | setLink(attributes: LinkAttributes) |
insertLink | insertLink(attributes: LinkInsertionAttributes) |
updateLink | updateLink(attributes: LinkInsertionAttributes) |
toggleLink | toggleLink(attributes: LinkAttributes) |
unsetLink | unsetLink() |
这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。
这里的 Link 只有上面列出的选项,没有 Tiptap Link 的 openOnClick、protocols 等同名配置。不要直接把上游配置对象复制过来。