CodeBlock

Stores multiline code and a language attribute, with configurable exit and indentation behavior. It does not install a syntax highlighter.

@quirekit/extension-code-block · MIT

Editor compatibility

Layer：Shared document capability

“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-code-block@alpha

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

Included in StarterKit. Configure its codeBlock child, or disable that child before installing a replacement.

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

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

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

Integration by editor

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.

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' }] },
})

Configuration

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

languageClassPrefix

Prefix added to language classes on rendered code elements.

Type：string | null | undefined

Default："language-"

exitOnTripleEnter

Whether triple Enter exits the code block.

Type：false | null | true | undefined

Default：true

exitOnArrowDown

Whether ArrowDown exits the final code block.

Type：false | null | true | undefined

Default：true

defaultLanguage

Default code language stored on new code blocks.

Type：string | null | undefined

Default：null

enableTabIndentation

Whether Tab and Shift-Tab indent code block text.

Type：false | null | true | undefined

Default：false

tabSize

Number of spaces inserted or removed for indentation.

Type：number | null | undefined

Default：4

HTMLAttributes

HTML attributes added when the code block serializes to HTML.

Type：Record<string, unknown>

Default：{}

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.

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

Other public exports

• CodeBlock · @quirekit/starter-kit

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.