@eigenpal/docx-editor-vue/composables

API Referencev1.0.2

Vue composables mirroring the React `hooks` subpath — history, table selection, find/replace, autosave, clipboard, zoom, and the high-level `useDocxEditor` host composable.

Functions(14)

useAutoSave

packages/vue/src/composables/useAutoSave.ts:66

export declare function useAutoSave(document: MaybeRef<Document | null | undefined>, options?: UseAutoSaveOptions): UseAutoSaveReturn;

useClipboard

packages/vue/src/composables/useClipboard.ts:41

export declare function useClipboard(options?: UseClipboardOptions): UseClipboardReturn;

useCommentSidebarItems

packages/vue/src/composables/useCommentSidebarItems.ts:37

export declare function useCommentSidebarItems(input: UseCommentSidebarItemsOptions): import('vue').ComputedRef<CommentSidebarItem[]>;

useDocxEditor

packages/vue/src/composables/useDocxEditor.ts:194

export declare function useDocxEditor(options: UseDocxEditorOptions): UseDocxEditorReturn;

useDragAutoScroll

packages/vue/src/composables/useDragAutoScroll.ts:28

export declare function useDragAutoScroll(input: DragAutoScrollOptions): UseDragAutoScrollReturn;

useFindReplace

packages/vue/src/composables/useFindReplace.ts:45

export declare function useFindReplace(hookOptions?: FindReplaceOptions): UseFindReplaceReturn;

useFixedDropdown

packages/vue/src/composables/useFixedDropdown.ts:25

export declare function useFixedDropdown(input: UseFixedDropdownOptions): UseFixedDropdownReturn;

useHistory

packages/vue/src/composables/useHistory.ts:23

export declare function useHistory(view: Ref<EditorView | null>, stateTick: Ref<number>): UseHistoryReturn;

useSelectionHighlight

packages/vue/src/composables/useSelectionHighlight.ts:47

export declare function useSelectionHighlight(options: UseSelectionHighlightOptions): UseSelectionHighlightReturn;

useTableResize

packages/vue/src/composables/useTableResize.ts:59

export declare function useTableResize(): UseTableResizeReturn;

useTableSelection

packages/vue/src/composables/useTableSelection.ts:22

export declare function useTableSelection(): UseTableSelectionReturn;

useTrackedChanges

packages/vue/src/composables/useTrackedChanges.ts:22

Pass the editor view ref + a stateTick that bumps on every PM transaction (the same tick the Toolbar listens to). The computed re-runs whenever the tick advances.

export declare function useTrackedChanges(view: Ref<EditorView | null>, stateTick: Ref<number>): import('vue').ComputedRef<TrackedChangesResult>;

useVisualLineNavigation

packages/vue/src/composables/useVisualLineNavigation.ts:25

export declare function useVisualLineNavigation(pagesContainer: Ref<HTMLElement | null>): UseVisualLineNavigationReturn;

useZoom

packages/vue/src/composables/useZoom.ts:31

export declare function useZoom(initialZoom?: number): UseZoomReturn;

Interfaces(22)

interface

CommentSidebarItem

packages/vue/src/composables/useCommentSidebarItems.ts:15

export interface CommentSidebarItem

Member	Type	Summary
anchorKey?	`string`
anchorPos	`number`
change?	`TrackedChangeEntry`
comment?	`Comment`
estimatedHeight?	`number`
fixedY?	`number`
id	`string`
isTemporary?	`boolean`
kind	`'add-comment' \| 'comment' \| 'tracked-change'`
priority?	`number`
replies?	`Comment[]`

interface

DragAutoScrollOptions

packages/vue/src/composables/useDragAutoScroll.ts:17

export interface DragAutoScrollOptions

Member	Type	Summary
onScrollExtendSelection	`(clientX: number, clientY: number) => void`	Called during auto-scroll to extend the selection at the current mouse position.
pagesContainer	`Ref<HTMLElement \| null>`

interface

FindReplaceOptions

packages/vue/src/composables/useFindReplace.ts:12

export interface FindReplaceOptions

Member	Type	Summary
initialReplaceMode?	`boolean`
onCurrentMatchChange?	`(match: FindMatch \| null, index: number) => void`
onMatchesChange?	`(matches: FindMatch[]) => void`

interface

FindReplaceState

packages/vue/src/composables/useFindReplace.ts:18

export interface FindReplaceState

Member	Type	Summary
currentIndex	`number`
isOpen	`boolean`
matches	`FindMatch[]`
options	`FindOptions`
replaceMode	`boolean`
replaceText	`string`
searchText	`string`

interface

UseAutoSaveOptions

packages/vue/src/composables/useAutoSave.ts:31

export interface UseAutoSaveOptions

Member	Type	Summary
debounceDelay?	`number`	Debounce delay for saveOnChange in milliseconds.
enabled?	`boolean`	Whether auto-save starts enabled (default: true).
interval?	`number`	Auto-save interval in ms (default: 30000)
maxAge?	`number`	Maximum age of auto-save before it is considered stale.
onError?	`(error: Error) => void`	Callback when save fails.
onRecoveryAvailable?	`(savedDocument: SavedDocumentData) => void`	Callback when recovery data is found.
onSave?	`(timestamp: Date) => void`	Callback when save succeeds.
saveOnChange?	`boolean`	Whether document changes trigger a debounced save.
storageKey?	`string`	localStorage key (default: 'docx-editor-autosave')

interface

UseAutoSaveReturn

packages/vue/src/composables/useAutoSave.ts:52

export interface UseAutoSaveReturn

Member	Type	Summary
acceptRecovery	`() => Document \| null`
clearAutoSave	`() => void`
disable	`() => void`
dismissRecovery	`() => void`
enable	`() => void`
getRecoveryData	`() => SavedDocumentData \| null`
hasRecoveryData	`Ref<boolean>`
isEnabled	`Ref<boolean>`
lastSaveTime	`Ref<Date \| null>`
save	`() => Promise<boolean>`
status	`Ref<AutoSaveStatus>`

interface

UseClipboardOptions

packages/vue/src/composables/useClipboard.ts:23

export interface UseClipboardOptions

Member	Type	Summary
cleanWordFormatting?	`boolean`
editable?	`boolean`
onCopy?	`(selection: ClipboardSelection) => void`
onCut?	`(selection: ClipboardSelection) => void`
onError?	`(error: Error) => void`
onPaste?	`(content: ParsedClipboardContent, asPlainText: boolean) => void`
theme?	`Theme \| null`

interface

UseClipboardReturn

packages/vue/src/composables/useClipboard.ts:33

export interface UseClipboardReturn

Member	Type	Summary
copy	`(selection: ClipboardSelection) => Promise<boolean>`
cut	`(selection: ClipboardSelection) => Promise<boolean>`
isProcessing	`Ref<boolean>`
lastPastedContent	`Ref<ParsedClipboardContent \| null>`
paste	`(asPlainText?: boolean) => Promise<ParsedClipboardContent \| null>`

interface

UseCommentSidebarItemsOptions

packages/vue/src/composables/useCommentSidebarItems.ts:29

export interface UseCommentSidebarItemsOptions

Member	Type	Summary
addCommentYPosition?	`Ref<number \| null>`
comments	`Ref<Comment[]>`
isAddingComment?	`Ref<boolean>`
showResolved?	`Ref<boolean>`
trackedChanges	`Ref<TrackedChangeEntry[]>`

interface

UseDocxEditorOptions

packages/vue/src/composables/useDocxEditor.ts:144

export interface UseDocxEditorOptions

Member	Type	Summary
externalPlugins?	`Plugin[]`	External ProseMirror plugins supplied by the host app.
hiddenContainer	`Ref<HTMLElement \| null>`	Container element for the hidden ProseMirror editor
onChange?	`(doc: Document) => void`	Callback on document change
onError?	`(error: Error) => void`	Callback on error
onSelectionUpdate?	`() => void`	Callback on selection change
pageGap?	`number`	Page gap in pixels
pagesContainer	`Ref<HTMLElement \| null>`	Container element for the visible pages
readOnly?	`MaybeRef<boolean>`	Whether the editor is read-only
syncCoordinator?	`LayoutSelectionGate`	Coordinates layout updates with visible selection/decoration overlays.

interface

UseDocxEditorReturn

packages/vue/src/composables/useDocxEditor.ts:165

export interface UseDocxEditorReturn

Member	Type	Summary
destroy	`() => void`	Destroy the editor view and clean up listeners.
editorState	`ShallowRef<EditorState \| null>`	Latest editor state. Updated on each transaction.
editorView	`ShallowRef<EditorView \| null>`	ProseMirror editor view (hidden).
focus	`() => void`	Focus the hidden ProseMirror view.
getCommands	`() => CommandMap`	Access the extension command map for invoking marks/nodes/features.
getDocument	`() => Document \| null`	Snapshot the current document model.
isReady	`Ref<boolean>`	True once the editor view has mounted and a document is loaded.
layout	`ShallowRef<Layout \| null>`	Computed page layout.
loadBuffer	`(buffer: ArrayBuffer \| Uint8Array \| Blob \| File) => Promise<void>`	Load a DOCX from a binary buffer.
loadDocument	`(doc: Document) => void`	Load a parsed `Document` directly.
parseError	`Ref<string \| null>`	Last parse error message, or null if the most recent load succeeded.
reLayout	`() => void`	Force a re-layout without a doc change (e.g. after page-setup changes).
save	`() => Promise<Blob \| null>`	Serialize the current document to a DOCX blob.

interface

UseDragAutoScrollReturn

packages/vue/src/composables/useDragAutoScroll.ts:23

export interface UseDragAutoScrollReturn

Member	Type	Summary
stopAutoScroll	`() => void`
updateMousePosition	`(clientX: number, clientY: number) => void`

interface

UseFindReplaceReturn

packages/vue/src/composables/useFindReplace.ts:28

export interface UseFindReplaceReturn

Member	Type	Summary
close	`() => void`
currentMatch	`ComputedRef<FindMatch \| null>`
goToMatch	`(index: number) => void`
goToNextMatch	`() => number`
goToPreviousMatch	`() => number`
hasMatches	`ComputedRef<boolean>`
openFind	`(selectedText?: string) => void`
openReplace	`(selectedText?: string) => void`
setMatches	`(matches: FindMatch[], currentIndex?: number) => void`
setOptions	`(opts: Partial<FindOptions>) => void`
setReplaceText	`(text: string) => void`
setSearchText	`(text: string) => void`
state	`FindReplaceState`
toggle	`() => void`

interface

UseFixedDropdownOptions

packages/vue/src/composables/useFixedDropdown.ts:11

export interface UseFixedDropdownOptions

Member	Type	Summary
align?	`'left' \| 'right'`	'left' aligns dropdown left edge to trigger, 'right' aligns right edge.
isOpen	`Ref<boolean>`
onClose	`() => void`

interface

UseFixedDropdownReturn

packages/vue/src/composables/useFixedDropdown.ts:18

export interface UseFixedDropdownReturn

Member	Type	Summary
containerRef	`Ref<HTMLElement \| null>`
dropdownRef	`Ref<HTMLElement \| null>`
dropdownStyle	`Ref<CSSProperties>`
handleMouseDown	`(e: MouseEvent) => void`

interface

UseHistoryReturn

packages/vue/src/composables/useHistory.ts:16

export interface UseHistoryReturn

Member	Type	Summary
canRedo	`ComputedRef<boolean>`
canUndo	`ComputedRef<boolean>`
redo	`() => boolean`
undo	`() => boolean`

interface

UseSelectionHighlightOptions

packages/vue/src/composables/useSelectionHighlight.ts:29

export interface UseSelectionHighlightOptions

Member	Type	Summary
config?	`SelectionHighlightConfig`
containerRef	`Ref<HTMLElement \| null>`
debounceMs?	`number`
enabled?	`boolean`
onSelectionChange?	`(hasSelection: boolean, text: string) => void`
useOverlay?	`boolean`

interface

UseSelectionHighlightReturn

packages/vue/src/composables/useSelectionHighlight.ts:38

export interface UseSelectionHighlightReturn

Member	Type	Summary
getOverlayStyle	`(rect: HighlightRect) => CSSProperties`
hasSelection	`ComputedRef<boolean>`
highlightRects	`ComputedRef<HighlightRect[]>`
isSelectionInContainer	`ComputedRef<boolean>`
refresh	`() => void`
selectedText	`ComputedRef<string>`

interface

UseTableResizeReturn

packages/vue/src/composables/useTableResize.ts:53

export interface UseTableResizeReturn

Member	Type	Summary
install	`() => () => void`
isResizing	`() => boolean`
tryStartResize	`(e: MouseEvent, view: EditorView) => boolean`

interface

UseTableSelectionReturn

packages/vue/src/composables/useTableSelection.ts:14

export interface UseTableSelectionReturn

Member	Type	Summary
clearSelection	`() => void`
handleCellClick	`(tableIndex: number, rowIndex: number, columnIndex: number) => void`
handleClickTarget	`(target: EventTarget \| null, container?: HTMLElement \| null) => void`
isCellSelected	`(tableIndex: number, rowIndex: number, columnIndex: number) => boolean`
selectedCell	`Ref<CellCoordinates \| null>`

interface

UseVisualLineNavigationReturn

packages/vue/src/composables/useVisualLineNavigation.ts:17

export interface UseVisualLineNavigationReturn

Member	Type	Summary
findLineElementAtPosition	`(pmPos: number) => HTMLElement \| null`
findPositionOnLineAtClientX	`(line: HTMLElement, clientX: number) => number \| null`
getCaretClientX	`(pmPos: number) => number \| null`
handlePMKeyDown	`(view: EditorView, event: KeyboardEvent) => boolean`
state	`ReturnType<typeof createVisualLineState>`

interface

UseZoomReturn

packages/vue/src/composables/useZoom.ts:16

export interface UseZoomReturn

Member	Type	Summary
handleKeyDown	`(e: KeyboardEvent) => void`
handleWheel	`(e: WheelEvent) => void`
installShortcuts	`() => void`
isMaxZoom	`ComputedRef<boolean>`
isMinZoom	`ComputedRef<boolean>`
resetZoom	`() => void`
setZoom	`(level: number) => void`
ZOOM_PRESETS	`number[]`
zoom	`Ref<number>`
zoomIn	`() => void`
zoomOut	`() => void`
zoomPercent	`ComputedRef<number>`