Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Core built-insView Markdown ↗

CommandsExtension

Provides Core commands and is installed by Editor by default. Configure built-ins through Editor options.

Provides Core commands and is installed by Editor by default. Configure built-ins through Editor options.

@quirekit/core · MIT

Editor compatibility

Layer:Core built-in

EditorStatusAssembly and boundaries
ClassicSupportedInstalled automatically by the product's Core. Manage it through Core enableCoreExtensions and coreExtensionOptions without duplicates. View-specific event behavior follows the active View.
BlockSupportedInstalled automatically by the product's Core. Manage it through Core enableCoreExtensions and coreExtensionOptions without duplicates. View-specific event behavior follows the active View.

“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

sh

Editor installs this built-in by default. Use enableCoreExtensions and coreExtensionOptions instead of adding a duplicate extension.

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.

Classic · Supported

Installed automatically by the product's Core. Manage it through Core enableCoreExtensions and coreExtensionOptions without duplicates. View-specific event behavior follows the active View.

Configuration

This entry has no independent configuration fields. Set document attributes through domain commands; presets may install other configurable children.

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.

CommandParameter signature
extendMarkRangeextendMarkRange(typeOrName: QuireMarkTypeInput, attributes?: Readonly<Record<string, unknown>>)
resetAttributesresetAttributes(typeOrName: QuireAttributeTypeInput, attributes: string | readonly string[])
setMarksetMark(typeOrName: QuireMarkTypeInput, attrs?: Attrs | null)
setMetasetMeta(key: unknown, value: unknown)
toggleMarktoggleMark(typeOrName: QuireMarkTypeInput, attrs?: Attrs | null, options?: QuireToggleMarkOptions)
unsetAllMarksunsetAllMarks()
unsetMarkunsetMark(typeOrName: QuireMarkTypeInput, options?: QuireUnsetMarkOptions)
updateAttributesupdateAttributes(typeOrName: QuireAttributeTypeInput, attributes?: Readonly<Record<string, unknown>>)
updateDecorationsupdateDecorations(extensionName?: string | undefined)

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

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.

QuireKitQuireKit · Core, plugins and Classic docs