Break documents into discrete, lockable parts.
Each section is an independent Word SDT (w:sdt) element that preserves state through import/export.
OOXML Structure
<w:sdt>
<w:sdtPr>
<w:alias w:val="Legal Terms"/>
<w:lock w:val="sdtContentLocked"/>
<w:tag w:val='{"id":"legal-1","type":"documentSection"}'/>
</w:sdtPr>
<w:sdtContent>
<!-- Your content as OOXML -->
</w:sdtContent>
</w:sdt>
Use Case
- Contract management - Lock legal clauses, leave business terms editable
- Multi-team documents - Each team owns their section
- Form templates - Some parts fixed, some parts fillable
Options
Configure the extension behavior:
HTML attributes for document sections
Attributes
Node attributes that can be set and retrieved:
Unique section identifier
Section display label (becomes w:alias in Word)
Additional metadata stored in w:tag
Business type for filtering/logic (e.g., ‘legal’, ‘pricing’)
Lock state (maps to w:lock=“sdtContentLocked”)
Commands
createDocumentSection
Create a lockable content section
Example:
editor.commands.createDocumentSection({
id: 1,
title: 'Terms & Conditions',
isLocked: true,
html: '<p>Legal content...</p>'
})
removeSectionAtSelection
Remove section wrapper at cursor, preserving its content
Content stays in document, only section wrapper is removed
editor.commands.removeSectionAtSelection()
removeSectionById
Delete section and all its content
Example:
editor.commands.removeSectionById(123)
lockSectionById
Lock section against edits
Example:
editor.commands.lockSectionById(123)
updateSectionById
Modify section attributes or content
Example:
editor.commands.updateSectionById({ id: 123, attrs: { isLocked: false } })
editor.commands.updateSectionById({ id: 123, html: '<p>New content</p>' })
editor.commands.updateSectionById({
id: 123,
html: '<p>Updated</p>',
attrs: { title: 'New Title' }
})
Types
SectionCreate
Document section creation options
Unique ID. Auto-increments from existing sections if omitted
Label shown in section header
Metadata for tracking (stored in Word’s w:tag)
Prevent editing when true
ProseMirror JSON (overrides html if both provided)
SectionUpdate
Update an existing section
Target section ID (required)
Replace content with HTML
Replace content with ProseMirror JSON (overrides html)
attrs
Partial<DocumentSectionAttributes>
Update attributes only (preserves content)
Source Code
