Skip to content
QuireKit
Plugin docs
Alpha · evolving API
Word document extensionsView Markdown ↗

WordBookmark

Maintains named bookmark ranges and navigation. Use bookmark commands to preserve paired endpoints.

Maintains named bookmark ranges and navigation. Use bookmark commands to preserve paired endpoints.

@quirekit/classic-bookmark · Commercial

Editor compatibility

Layer:Shared document capability

EditorStatusAssembly and boundaries
ClassicSupportedcreateClassicWordPreset — 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.
BlockUnverifiedA complete integration and verification path for this entry has not been established for this product. A public Core export does not imply product presentation, controls or file support.

“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

The current @quirekit/classic-bookmark manifest is private. This site uses workspace source; external projects need the relevant distribution package rather than assuming public npm availability.

This entry is a commercial component. Obtain distribution access and authorization first; installation commands require that distribution source.

Start a Word product with the Word preset. This export supports independent Core or custom presets; assemble companion nodes, commands and layout, without duplicate names.

ts

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

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
ts

Configuration

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

startTypeName

Canonical bookmark start node name.

Type:string

Default:WordBookmarkStart.name

endTypeName

Canonical bookmark end node name.

Type:string

Default:WordBookmarkEnd.name

showBookmarks

Whether bookmark brackets are shown initially; hidden by default, as in Word.

Type:boolean

Default:false

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
addWordBookmarkaddWordBookmark(options: AddWordBookmarkPayload)
removeWordBookmarkremoveWordBookmark(options: WordBookmarkNamePayload)
renameWordBookmarkrenameWordBookmark(options: RenameWordBookmarkPayload)
goToWordBookmarkgoToWordBookmark(options: WordBookmarkNamePayload)
selectWordBookmarkselectWordBookmark(options: WordBookmarkNamePayload)
setWordBookmarkVisibilitysetWordBookmarkVisibility(visible: unknown)
ensureWordHeadingBookmarkensureWordHeadingBookmark(options: EnsureWordHeadingBookmarkPayload)

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