ClassicWordComment
Adds Pro comment/review UI and a host identity provider for newly authored comments and replies.
Adds Pro comment/review UI and a host identity provider for newly authored comments and replies.
@quirekit/classic-pro · Commercial
Editor compatibility
Layer:Classic product integration
| Editor | Status | Assembly and boundaries |
|---|---|---|
| Classic | Supported | createClassicWordProPreset — Use createClassicWordProPreset for professional product capabilities. Review UI also follows the review feature. Do not add duplicate community or professional extensions. |
| Block | Unsupported | Block does not consume Classic product contributions, plugins or paginated assembly. Use shared capabilities and Block adapters instead of copying this entry's Classic configuration. |
“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-pro 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.
Use the professional Word preset. Individual adapters support custom assembly or replacement without duplicate names.
import { ClassicWordComment } from '@quirekit/classic-pro'
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 createClassicWordProPreset for professional product capabilities. Review UI also follows the review feature. Do not add duplicate community or professional extensions.
createClassicWordProPresetimport { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'
import { createClassicWordProPreset } from '@quirekit/classic-pro'
import '@quirekit/classic-pro/styles.css'
const instance = createClassicEditor({
element,
preset: createClassicWordProPreset(),
document: createClassicWordDefaultDocument(),
})Block · Unsupported
Block does not consume Classic product contributions, plugins or paginated assembly. Use shared capabilities and Block adapters instead of copying this entry's Classic configuration.
Configuration
These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.
startTypeName
Canonical comment-range start node name.
Type:string
Default:WordCommentStart.name
endTypeName
Canonical comment end/reference node name.
Type:string
Default:WordCommentEnd.name
ribbon
Whether review ribbon controls and the comment sidebar are installed.
Type:boolean
Default:false
reviewerIdentityProvider
Optional Host authority for newly authored root and reply identities.
Type:ClassicWordReviewerIdentityProvider | null
Default:null
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 |
|---|---|
addWordComment | addWordComment(options: WordCommentAuthorInput) |
replyToWordComment | replyToWordComment(options: ReplyToWordCommentOptions) |
updateWordCommentMessage | updateWordCommentMessage(options: UpdateWordCommentMessageOptions) |
setWordCommentResolved | setWordCommentResolved(options: SetWordCommentResolvedOptions) |
removeWordComment | removeWordComment(options: WordCommentThreadOptions) |
goToWordComment | goToWordComment(options: WordCommentThreadOptions) |
goToNextWordComment | goToNextWordComment() |
goToPreviousWordComment | goToPreviousWordComment() |
setWordCommentHoveredThreadId | setWordCommentHoveredThreadId(threadId: string | null) |
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.
Continue with Classic quick start and configuration/lifetime. See product plugin development for your own UI and services.