Element API and events

Every framework adapter wraps the same <docx-editor> custom element. The adapters forward these properties and re-emit these events in their framework's idiom (see framework bindings).

Attributes and properties

Property	Attribute	Description
documentModel		The DocumentModel shown. Assigning it is an external replacement, not an edit event.
readOnly	read-only	Blocks local edits. Remote collaboration batches still apply.
locale	locale	Interface language: en, fr, de, es or zh-CN. Document content is never translated.
fileName	file-name	Name of the open document (default Document1.docx).
reviewAuthor	review-author	Author recorded on tracked changes and comments (default Author).
theme	theme	light, dark or auto. See theming.
themeColors		Partial token overrides applied as --dve-* custom properties.
showThumbnails	show-thumbnails	Left rail of page thumbnails (Print Layout only).
showToolbar	show-toolbar	false hides the ribbon; the title bar and status bar remain.
hiddenActions		Ribbon controls to hide by stable id; see the table in bindings.
dirty (read)		True after an edit, false after save, load or markClean().

Methods

Method	Description
load(bytes)	Load DOCX or legacy DOC bytes. Rejects and emits document-error on failure.
save()	Resolves to a Blob of the serialized document.
saveBytes()	Resolves to the raw Uint8Array.
download(fileName?)	Saves and starts a browser download.
markClean()	Clears the dirty flag after the host persisted the document.
startCollaboration(config)	Join a collaboration session; see collaboration.
getPendingCollaboration()	The pending step batch, or null.
receiveCollaboration(batch)	Apply an accepted batch from the authority.
stopCollaboration(discardPending?)	Leave the session; pending edits must be acknowledged or explicitly discarded.
publishPresence, receivePresence, leavePresence	Transient presence channel; see collaboration.

Events

All events bubble and are composed, so they cross the shadow boundary.

Event	Detail	Meaning
document-change	DocumentModel	The document changed through editing or review actions.
document-error	Error	Loading, saving, printing or an edit failed.
document-warning	string	Non-fatal notice.
readonly-change	boolean	The user toggled Editing/Viewing in the chrome.
file-command	{ command }	Cancelable. command is new, open, save, export or print.
dirty-change	boolean	Unsaved-changes state flipped.
page-change	{ page, pageCount }	Print Layout page or page count changed (approximate pagination).
ribbon-action	RibbonAction	A ribbon control was activated.
ribbon-customize	readonly string[]	The user changed which ribbon commands are shown; persist the ids if wanted.
presence-send	PresenceMessage	Local presence changed; transport it to other clients.
collaboration-send	StepBatch	Local steps are pending; transport them to the authority.

The package exports the typed event map (DocxEditorEventMap) and the runtime list DOCX_EDITOR_EVENTS.