Link · QuireKit

Stores link destinations and provides insert, update and removal commands. Completed typed URLs can become links; the host owns link UI and navigation.

@quirekit/extension-link · MIT

Editor compatibility

Layer：Shared document capability

Editor	Status	Assembly and boundaries
Classic	Supported	createClassicWordPreset — Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.
Block	Supported	createBlockEditorPreset — The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See status and integration rules. Licensing is shown separately.

Installation

pnpm add @quirekit/extension-link@alpha

Install in Editor extensions. The host supplies a view, container and persistence; see Quick start.

import { Link } from '@quirekit/extension-link'

const links = Link.configure({ autolink: false, color: '#2255cc' })

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see support and licensing.

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

Classic · Supported

Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.

createClassicWordPreset

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

Block · Supported

The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

createBlockEditorPreset

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

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

Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.

HTMLAttributes

Additional serialized anchor attributes.

Type：Record<string, unknown>

Default：{}

color

Derived glyph color, not persistent document state.

Type：string

Default："#0563c1"

autolink

Complete typed URLs after whitespace/Enter; defaults to true.

Type：boolean

Default：true

Commands and runtime

These commands are supplied directly by this extension. Availability depends on the installed schema, selection and protection policy; query editor.can() first.

Command	Parameter signature
`setLink`	`setLink(attributes: LinkAttributes)`
`insertLink`	`insertLink(attributes: LinkInsertionAttributes)`
`updateLink`	`updateLink(attributes: LinkInsertionAttributes)`
`toggleLink`	`toggleLink(attributes: LinkAttributes)`
`unsetLink`	`unsetLink()`

These are parameter signatures. See commands and controls to connect UI while retaining one transaction/history authority.

Only the options listed above are supported. Tiptap Link settings such as openOnClick and protocols are not options of this implementation.

Next steps

Return to all plugins, or read configuration to distinguish options, attributes and commands.

See extension development for custom capabilities and Build a product for complete hosting.