@docx-editor.dev/vue
v2.26.0 · 1 published subpath with full TypeScript signatures and JSDoc.
Package root
Functions (52)
definePopupfunctionSource ↗
Adapt a Vue component to a popup renderer while preserving its props and lifecycle. Required and narrowed props remain checked; inherited framework attributes do not constrain the popup host.
declare function definePopup<C extends Component | FunctionalComponent<never>>(component: C): (props: C extends new (...args: never[]) => {
$props: infer P;
} ? Omit<P, {
[K in keyof P]-?: K extends keyof (VNodeProps & AllowedComponentProps & ComponentCustomProps) ? {} extends Pick<P, K> ? (VNodeProps & AllowedComponentProps & ComponentCustomProps)[K] extends P[K] ? K : never : never : never;
}[keyof P]> : C extends (props: infer P, ...args: never[]) => unknown ? P : never) => DocxEditorChildren;isFieldLinkfunctionSource ↗
declare function isFieldLink(link: SurfaceHyperlink): boolean;navigationPaneReservationfunctionSource ↗
Total left space an open pane needs before the page may start.
declare function navigationPaneReservation(paneWidth?: number): number;navigationShiftfunctionSource ↗
The viewport's left padding, in px, that puts the page's left edge exactly at reservation — and 0 whenever the gutter is already wide enough.
Returns 0 for a degenerate measurement (a viewport that has not been laid out yet, a document with no page setup) rather than guessing: shifting on a zero measurement would make the pane jump on the first frame and settle on the second.
declare function navigationShift(input: NavigationShiftInput): number;normalizeImageBytesfunctionSource ↗
Preflight raster bytes for insert/replace. Never allocates from file-supplied dimensions alone.
declare function normalizeImageBytes(bytes: Uint8Array): NormalizedImagePayload;provideDocxEditorfunctionSource ↗
Setup composable for hosts that own the editor above the packaged root. Creates the instance, publishes docxEditorKey, and returns props for [DocxEditorRoot](DocxEditorRoot).
declare function provideDocxEditor(options: DocxEditorRootProps): ProvideDocxEditorResult;reviewGutterfunctionSource ↗
Returns the inline-edge reservations for the current rail geometry.
declare function reviewGutter(input: ReviewGutterInput): ReviewGutter;useChromeTranslatefunctionSource ↗
declare function useChromeTranslate(overrides?: ReadonlyMap<string, string>): ComputedRef<ChromeTranslate>;useContentControlfunctionSource ↗
declare function useContentControl(): UseContentControlResult;useContentControlInstancefunctionSource ↗
declare function useContentControlInstance(): UseContentControlResult;useContentControlWidgetfunctionSource ↗
Draft state of the enclosing content-control value pop-up.
declare function useContentControlWidget(): UseContentControlWidgetResult;useContextMenuTargetfunctionSource ↗
declare function useContextMenuTarget(): HTMLElement | null;useDocumentOutlinefunctionSource ↗
declare function useDocumentOutline(): UseDocumentOutlineResult;useDocumentSearchfunctionSource ↗
The editor's shared search, with no UI attached. The packaged Find pane uses the same session, so state set here shows there.
declare function useDocumentSearch(options?: MaybeRefOrGetter<UseDocumentSearchOptions>): UseDocumentSearchResult;useDocxEditorfunctionSource ↗
declare function useDocxEditor(): ShallowRef<DocxEditorInstance | null>;useDocxSourcefunctionSource ↗
declare function useDocxSource(source: MaybeRefOrGetter<DocxSource | null | undefined>, options?: MaybeRefOrGetter<UseDocxSourceOptions>): UseDocxSourceResult;useEditorCaretfunctionSource ↗
declare function useEditorCaret(): ShallowRef<EditorCaret | null>;useEditorCommandfunctionSource ↗
declare function useEditorCommand(target: MaybeRefOrGetter<ChromeSlotId | EditorCommand>): EditorCommandState;useEditorEventfunctionSource ↗
declare function useEditorEvent<E extends keyof EditorEvents>(event: E, handler: EditorEvents[E]): void;useEditorSnapshotfunctionSource ↗
declare function useEditorSnapshot(editor: MaybeRefOrGetter<Editor | null>): Ref<number>;useEditorStatefunctionSource ↗
declare function useEditorState<T>(selector: (snapshot: EditorSnapshot) => T, isEqual?: (a: T, b: T) => boolean, options?: UseEditorStateOptions): Readonly<ShallowRef<T>>;useEditorValueCommandfunctionSource ↗
Bind a value slot. Font size values use half-points; colors use six digits without #.
declare function useEditorValueCommand<K extends keyof ToolbarValueMap>(slotId: K): EditorValueCommandState<ToolbarValueMap[K]>;useFontFamilyfunctionSource ↗
declare function useFontFamily(): UseFontFamilyResult;useFontsfunctionSource ↗
declare function useFonts(source: MaybeRefOrGetter<FontsInput>, ...fragments: readonly MaybeRefOrGetter<FontConfigurationFragment | undefined>[]): MarkedFontResolver;useFontsfunctionSource ↗
declare function useFonts(...origins: readonly MaybeRefOrGetter<FontOrigin>[]): MarkedFontResolver;useHeaderFooterStatefunctionSource ↗
declare function useHeaderFooterState(): ShallowRef<HeaderFooterState | null>;useHighlightAtfunctionSource ↗
The topmost text highlight under the pointer, or null. Pass a set name to watch one set. R is your range type, so fields you added to your ranges come back typed on range.
declare function useHighlightAt<R extends HighlightRange = HighlightRange>(name?: MaybeRefOrGetter<string>): Readonly<ShallowRef<HighlightHit<R> | null>>;```ts
const hit = useHighlightAt<GlossaryRange>('glossary');
// hit.value?.range.definition, positioned at hit.value.rect
```useHighlightsfunctionSource ↗
Mark text ranges as the named set while the calling scope is active.
A function source runs inside reactive tracking, so a getter that reads refs reapplies when they change. Use a unique name per call: two calls with the same name replace each other's ranges.
declare function useHighlights(name: MaybeRefOrGetter<string>, source: MaybeRefOrGetter<HighlightSource>, options?: MaybeRefOrGetter<HighlightOptions>): ComputedRef<HighlightResult>;```ts
useHighlights(
'glossary',
(editor) => editor.findMatches(terms.value, { wholeWord: true }).flat(),
{ className: 'glossary-term' }
);
```useHistoryGroupfunctionSource ↗
Bind a control's native gesture lifecycle. Apply values through the existing command hooks.
declare function useHistoryGroup(input: HistoryGroupBindingOptions): UseHistoryGroupReturn;useHyperlinkPopupfunctionSource ↗
declare function useHyperlinkPopup(): UseHyperlinkPopupResult;useHyperlinkPopupInstancefunctionSource ↗
declare function useHyperlinkPopupInstance(active?: boolean): UseHyperlinkPopupResult;useNavigationPanefunctionSource ↗
declare function useNavigationPane(options?: MaybeRefOrGetter$1<UseNavigationPaneOptions>): UseNavigationPaneResult;useNavigationShiftfunctionSource ↗
declare function useNavigationShift(): ShallowRef<number>;useNotePropertiesStatefunctionSource ↗
declare function useNotePropertiesState(): ShallowRef<NotePropertiesState | null>;useNoteScopeStatefunctionSource ↗
declare function useNoteScopeState(): ShallowRef<Extract<ViewScope, {
kind: 'note';
}> | null>;usePageSetupfunctionSource ↗
declare function usePageSetup(): UsePageSetupReturn;usePageSetupDialogfunctionSource ↗
Access the current Page Setup draft and actions.
declare function usePageSetupDialog(): UsePageSetupDialogReturn;useParagraphDialogfunctionSource ↗
Access the current Paragraph draft and actions.
declare function useParagraphDialog(): UseParagraphDialogReturn;useParagraphFormatfunctionSource ↗
The selection's paragraph formatting, plus the command to change it.
declare function useParagraphFormat(): UseParagraphFormatReturn;useParagraphIndentfunctionSource ↗
declare function useParagraphIndent(): UseParagraphIndentReturn;useParagraphStylefunctionSource ↗
declare function useParagraphStyle(): UseParagraphStyleResult;useReviewAuthorsfunctionSource ↗
declare function useReviewAuthors(): Readonly<ShallowRef<readonly ReviewAuthorInfo[]>>;useReviewGutterfunctionSource ↗
Returns the live review-rail reservation for the viewport and rulers.
declare function useReviewGutter(): ShallowRef<ReviewGutter>;useScopeClassNamefunctionSource ↗
declare function useScopeClassName(): '' | 'docx-editor ';useScopedChromeAnchorfunctionSource ↗
Attach contextual chrome to a painted story instead of the top of the editor viewport.
declare function useScopedChromeAnchor(findAnchor: (viewport: HTMLElement) => HTMLElement | null, placement: AnchorPlacement): ScopedChromeAnchor;useTableBorderTargetLabelfunctionSource ↗
declare function useTableBorderTargetLabel(): ComputedRef<string>;useTextFormFieldDialogfunctionSource ↗
Access the Field Options draft and actions.
declare function useTextFormFieldDialog(): UseTextFormFieldDialogReturn;useToolbarContextfunctionSource ↗
declare function useToolbarContext(): ComputedRef<ToolbarContextValue>;useToolbarLabelfunctionSource ↗
declare function useToolbarLabel(): (key: string) => string;useToolbarLabelForfunctionSource ↗
declare function useToolbarLabelFor(t: ToolbarTranslate | undefined): (key: string) => string;useTranslationfunctionSource ↗
declare function useTranslation(): {
t: TFunction;
catalogue: ShallowRef<LocaleStrings>;
};useZoomfunctionSource ↗
declare function useZoom(): UseZoomResult;Interfaces (144)
ContentControlActionPropsinterfaceSource ↗
Props for action parts that also take an icon.
interface ContentControlActionProps extends ContentControlPartProps| Member | Type | Summary |
|---|---|---|
| icon? | DocxEditorChildren |
ContentControlInspectorStateinterfaceSource ↗
interface ContentControlInspectorState| Member | Type | Summary |
|---|---|---|
| alias | string | null | |
| bound | boolean | |
| controlType | ContentControlType | |
| effectiveLock | ContentControlLock | null | |
| id | string | |
| locked | boolean | |
| placeholder | boolean | |
| removalLocked | boolean | |
| tag | string | null |
ContentControlPartPropsinterfaceSource ↗
Shared props for every part.
interface ContentControlPartProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
ContentControlPropsinterfaceSource ↗
Props for DocxEditor.ContentControl.
interface ContentControlProps extends ContentControlPartProps| Member | Type | Summary |
|---|---|---|
| preset? | boolean | Render the packaged arrangement. `false` mounts only the shell and host children. |
ContentControlWidgetDayPropsinterfaceSource ↗
Props for one calendar cell.
interface ContentControlWidgetDayProps extends DocxEditorContentControlWidgetPartProps| Member | Type | Summary |
|---|---|---|
| day | CalendarDay |
ContentControlWidgetEntryinterfaceSource ↗
One selectable entry of a dropdown or combo-box control.
interface ContentControlWidgetEntry| Member | Type | Summary |
|---|---|---|
| displayText | string | |
| value | string |
ContentControlWidgetItemPropsinterfaceSource ↗
Props for one list entry.
interface ContentControlWidgetItemProps extends DocxEditorContentControlWidgetPartProps| Member | Type | Summary |
|---|---|---|
| item | ContentControlWidgetEntry |
ContentControlWidgetPicturePropsinterfaceSource ↗
Props for the picture file input.
interface ContentControlWidgetPictureProps extends DocxEditorContentControlWidgetPartProps| Member | Type | Summary |
|---|---|---|
| autoOpen? | boolean | Open the browser's file dialog as soon as the part mounts. Defaults to true. |
ContextMenuAnchorinterfaceSource ↗
interface ContextMenuAnchor| Member | Type | Summary |
|---|---|---|
| x | number | |
| y | number |
ContextMenuCommandPropsinterfaceSource ↗
Props for a packaged context-menu row.
interface ContextMenuCommandProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| icon? | DocxEditorChildren | |
| labelKey? | string | |
| shortcutKey? | string |
ContextMenuContextValueinterfaceSource ↗
interface ContextMenuContextValue| Member | Type | Summary |
|---|---|---|
| anchor | ContextMenuAnchor | null | |
| clipboardRefusal | string | null | |
| close | (restoreFocus?: boolean) => void | |
| reportClipboardRefusal | (reason: string) => void | |
| target | HTMLElement | null | |
| tocId | string | null |
ContextMenuItemPropsinterfaceSource ↗
interface ContextMenuItemProps| Member | Type | Summary |
|---|---|---|
| active? | boolean | |
| className? | string | |
| disabled? | boolean | |
| disabledReason? | string | |
| icon? | DocxEditorChildren | |
| label | string | |
| onSelect? | () => void | |
| shortcut? | string |
ContextMenuTableRowPropsinterfaceSource ↗
interface ContextMenuTableRowProps extends ContextMenuCommandProps| Member | Type | Summary |
|---|---|---|
| destructive? | boolean |
DialogCustomizationPropsinterfaceSource ↗
Layout customization for a packaged dialog.
interface DialogCustomizationProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| preset? | boolean | |
| style? | CSSProperties |
DialogPartPropsinterfaceSource ↗
Shared presentation props for dialog parts.
Anything beyond these members reaches the rendered element, so a part takes an id, an aria-* label or a data-* test hook. The part's own wiring wins every collision: a host cannot replace Apply's handler or its data-docx-part marker by passing one. To own the element and its handler outright, pass as-child and supply your own.
interface DialogPartProps| Member | Type | Summary |
|---|---|---|
| "aria-label"? | string | |
| (member-1) | | |
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string | |
| id? | string | |
| style? | CSSProperties | |
| title? | string |
DocxEditorAuthorStylePropsinterfaceSource ↗
interface DocxEditorAuthorStyleProps extends RevisionAuthorStyle| Member | Type | Summary |
|---|---|---|
| author | string |
DocxEditorContentControlNamespaceinterfaceSource ↗
interface DocxEditorContentControlNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Fields | typeof ContentControlFields | |
| Header | typeof ContentControlHeader | |
| Remove | typeof ContentControlRemove |
DocxEditorContentControlWidgetNamespaceinterfaceSource ↗
The compound pop-up with its parts attached as statics.
interface DocxEditorContentControlWidgetNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Apply | typeof ContentControlWidgetApply | |
| Calendar | typeof ContentControlWidgetCalendar | |
| Cancel | typeof ContentControlWidgetCancel | |
| Day | typeof ContentControlWidgetDay | |
| Error | typeof ContentControlWidgetError | |
| Footer | typeof ContentControlWidgetFooter | |
| Grid | typeof ContentControlWidgetGrid | |
| Header | typeof ContentControlWidgetHeader | |
| Input | typeof ContentControlWidgetInput | |
| Item | typeof ContentControlWidgetItem | |
| List | typeof ContentControlWidgetList | |
| Month | typeof ContentControlWidgetMonth | |
| Navigation | typeof ContentControlWidgetNavigation | |
| NextMonth | typeof ContentControlWidgetNextMonth | |
| Picture | typeof ContentControlWidgetPicture | |
| PreviousMonth | typeof ContentControlWidgetPreviousMonth | |
| Title | typeof ContentControlWidgetTitle | |
| Today | typeof ContentControlWidgetToday | |
| Weekdays | typeof ContentControlWidgetWeekdays | |
| Year | typeof ContentControlWidgetYear |
DocxEditorContentControlWidgetPartPropsinterfaceSource ↗
Presentation overrides for a value pop-up part.
Anything beyond these members reaches the rendered element, so a part takes an id, an aria-* label or a data-* test hook. The part's own wiring wins every collision. Pass asChild to own the element outright and keep its behavior.
interface DocxEditorContentControlWidgetPartProps| Member | Type | Summary |
|---|---|---|
| "aria-label"? | string | |
| (member-1) | | |
| (member-2) | | |
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string | |
| id? | string | |
| style? | CSSProperties | |
| title? | string |
DocxEditorContentControlWidgetPropsinterfaceSource ↗
Value-widget session and optional replacement controls.
interface DocxEditorContentControlWidgetProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | Replaces the packaged arrangement. Compose it from the compound's parts (`DocxEditorContentControlWidget.Calendar`, `.List`, …) or from `useContentControlWidget()`. |
| className? | string | |
| session | ContentControlWidgetSession | |
| style? | CSSProperties |
DocxEditorContentPropsinterfaceSource ↗
interface DocxEditorContentProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string |
DocxEditorContextMenuNamespaceinterfaceSource ↗
interface DocxEditorContextMenuNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| CellVerticalAlignment | typeof ContextMenuCellVerticalAlignment | |
| Copy | typeof ContextMenuCopy | |
| Cut | typeof ContextMenuCut | |
| Delete | typeof ContextMenuDelete | |
| DeleteTable | typeof ContextMenuDeleteTable | |
| DeleteTableColumn | typeof ContextMenuDeleteTableColumn | |
| DeleteTableRow | typeof ContextMenuDeleteTableRow | |
| Group | typeof MenuGroup | |
| InsertColumnLeft | typeof ContextMenuInsertColumnLeft | |
| InsertColumnRight | typeof ContextMenuInsertColumnRight | |
| InsertRowAbove | typeof ContextMenuInsertRowAbove | |
| InsertRowBelow | typeof ContextMenuInsertRowBelow | |
| Item | typeof ContextMenuItem | |
| Paste | typeof ContextMenuPaste | |
| PasteWithoutFormatting | typeof ContextMenuPasteWithoutFormatting | |
| RefreshToc | typeof ContextMenuRefreshToc | |
| RefreshTocPageNumbers | typeof ContextMenuRefreshTocPageNumbers | |
| Row | typeof MenuRow | |
| SelectAll | typeof ContextMenuSelectAll | |
| Separator | typeof MenuSeparator | |
| Slot | typeof MenuItem | |
| Submenu | typeof MenuSubmenu |
DocxEditorContextMenuPropsinterfaceSource ↗
interface DocxEditorContextMenuProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| disabled? | boolean | |
| onOpenChange? | (open: boolean) => void | |
| preset? | boolean | |
| t? | ToolbarTranslate |
DocxEditorDocumentOutlinePropsinterfaceSource ↗
Props for the context-fed outline part.
interface DocxEditorDocumentOutlineProps| Member | Type | Summary |
|---|---|---|
| leftOffset? | number | |
| onClose? | () => void | |
| topOffset? | number |
DocxEditorExportDialogPropsinterfaceSource ↗
State and presentation for the File menu export dialog.
interface DocxEditorExportDialogProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | Replaces the default contents while retaining the modal and focus behavior. |
| className? | string | Additional class on the dialog element. |
| error | string | Localized failure text, or an empty string while conversion runs. |
| format | ChromeExportFormat | The format selected in File Export. |
| onClose | | Dismisses feedback without canceling the export. |
| open | boolean | Controls visibility when rendering the dialog directly. |
| pending | boolean | True while conversion runs. Closing the dialog does not cancel conversion. |
| style? | CSSProperties | Inline styles on the dialog element. |
DocxEditorFontNoticePropsinterfaceSource ↗
Props for DocxEditor.FontNotice.
interface DocxEditorFontNoticeProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| style? | CSSProperties | |
| t? | TFunction |
DocxEditorHeaderFooterChromePropsinterfaceSource ↗
Props for DocxEditor.HeaderFooterChrome.
interface DocxEditorHeaderFooterChromeProps| Member | Type | Summary |
|---|---|---|
| className? | string |
DocxEditorHyperLinkNamespaceinterfaceSource ↗
interface DocxEditorHyperLinkNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Apply | typeof HyperLinkApply | |
| Cancel | typeof HyperLinkCancel | |
| Copy | typeof HyperLinkCopy | |
| Edit | typeof HyperLinkEdit | |
| Error | typeof HyperLinkError | |
| Fields | typeof HyperLinkFields | |
| Unlink | typeof HyperLinkUnlink | |
| Url | typeof HyperLinkUrl |
DocxEditorImageAltTextPopupPropsinterfaceSource ↗
Controlled image description popup.
interface DocxEditorImageAltTextPopupProps| Member | Type | Summary |
|---|---|---|
| anchorRef? | RefObject<HTMLElement | null> | |
| className? | string | |
| id | string | |
| isEnabled | boolean | |
| onApply | | |
| onClose | | |
| onValueChange | | |
| value | string |
DocxEditorImagePropertiesDialogPropsinterfaceSource ↗
Props for DocxEditor.ImagePropertiesDialog.
interface DocxEditorImagePropertiesDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| onClose | () => void | |
| open | boolean | |
| triggerRef? | RefObject<HTMLElement | null> |
DocxEditorInvalidTextFormFieldDialogPropsinterfaceSource ↗
Invalid-value acknowledgement with editor-owned clearing and focus restoration.
interface DocxEditorInvalidTextFormFieldDialogProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| session | InvalidTextFormFieldSession | |
| style? | CSSProperties |
DocxEditorLoadingComponentinterfaceSource ↗
interface DocxEditorLoadingComponent| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Spinner | typeof DocxEditorLoadingSpinner |
DocxEditorLoadingPropsinterfaceSource ↗
Props for DocxEditor.Loading.
interface DocxEditorLoadingProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| overlay? | boolean | |
| style? | CSSProperties | |
| when? | boolean |
DocxEditorLoadingSpinnerPropsinterfaceSource ↗
Props for DocxEditor.Loading.Spinner.
interface DocxEditorLoadingSpinnerProps| Member | Type | Summary |
|---|---|---|
| className? | string |
DocxEditorMenuNamespaceinterfaceSource ↗
interface DocxEditorMenuNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Entry | typeof MenuEntry | |
| ExportMarkdown | typeof MenuExportMarkdown | |
| ExportPdf | typeof MenuExportPdf | |
| File | MenuPartComponent | |
| Format | MenuPartComponent | |
| Group | typeof MenuGroup | |
| Help | MenuPartComponent | |
| ImageInsert | typeof MenuImageInsert | |
| Insert | MenuPartComponent | |
| Item | typeof MenuItem | |
| Menu | typeof Menu | |
| Open | typeof MenuOpen | |
| PageSetup | typeof MenuPageSetup | |
typeof MenuPrint | ||
| ReportIssue | typeof MenuReportIssue | |
| Review | typeof MenuReview | |
| Reviewers | typeof MenuReviewers | |
| Row | typeof MenuRow | |
| Save | typeof MenuSave | |
| Separator | typeof MenuSeparator | |
| Submenu | typeof MenuSubmenu | |
| TableGrid | typeof MenuTableGrid |
DocxEditorMenuPropsinterfaceSource ↗
interface DocxEditorMenuProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| exporters? | ChromeExportHandlers | Converter handlers. Markdown requires docx-to-markdown; PDF requires docx-to-pdf on Node.js. File Print also uses the PDF handler. Missing handlers show an error. |
| fileName? | string | |
| onOpen? | () => void | |
| onOpenFile? | (file: File) => void | |
| onPageSetup? | () => void | Owns Page Setup opening when `popups.pageSetup` is omitted. Use `popups` to customize its UI. |
| onReportIssue? | () => void | |
| onSave? | () => void | |
| preset? | boolean | |
| reportIssue? | boolean | |
| t? | ToolbarTranslate |
DocxEditorNamespaceinterfaceSource ↗
interface DocxEditorNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| AuthorStyle | typeof DocxEditorAuthorStyle | |
| ColorByChangeType | typeof DocxEditorColorByChangeType | |
| Content | typeof DocxEditorContent | |
| ContentControl | typeof DocxEditorContentControl | |
| ContentControlWidget | typeof DocxEditorContentControlWidget | |
| ContextMenu | typeof ContextMenu | |
| DocumentOutline | typeof DocxEditorDocumentOutline | |
| Equation | typeof DocxEditorEquation | The default linear-math popover for a clicked Office Math equation. |
| ExportDialog | typeof DocxEditorExportDialog | File export progress and errors, configured through popups.export. |
| FontNotice | typeof DocxEditorFontNotice | |
| HeaderFooterChrome | typeof DocxEditorHeaderFooterChrome | |
| HorizontalRuler | typeof DocxEditorHorizontalRuler | |
| HyperLink | typeof DocxEditorHyperLink | |
| ImageAltTextPopup | typeof DocxEditorImageAltTextPopup | |
| ImagePropertiesDialog | typeof DocxEditorImagePropertiesDialog | |
| InvalidTextFormFieldDialog | typeof DocxEditorInvalidTextFormFieldDialog | |
| Loading | typeof DocxEditorLoading | |
| Menu | typeof DocxEditorMenu | |
| Navigation | typeof Navigation | |
| NotePreview | typeof DocxEditorNotePreview | |
| NotePropertiesDialog | typeof DocxEditorNotePropertiesDialog | |
| NotesChrome | typeof DocxEditorNotesChrome | |
| NotesContextMenu | typeof DocxEditorNotesContextMenu | |
| PageNumber | typeof DocxEditorPageNumber | |
| PageSetupDialog | typeof DocxEditorPageSetupDialog | |
| ParagraphDialog | typeof DocxEditorParagraphDialog | The Paragraph dialog: alignment, indentation, spacing and the paragraph flags. |
| PrintDialog | typeof DocxEditorPrintDialog | File print progress and errors, configured through popups.print. |
| Root | typeof DocxEditorRoot | |
| TextFormFieldDialog | typeof DocxEditorTextFormFieldDialog | |
| Toolbar | typeof DocxEditorToolbar | |
| VerticalRuler | typeof DocxEditorVerticalRuler | |
| Viewport | typeof DocxEditorViewport |
DocxEditorNavigationNamespaceinterfaceSource ↗
interface DocxEditorNavigationNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Close | typeof NavigationClose | |
| Find | typeof NavigationFind | |
| Header | typeof NavigationHeader | |
| Headings | typeof NavigationHeadings | |
| Tab | typeof NavigationTab | |
| Tabs | typeof NavigationTabs | |
| Title | typeof NavigationTitle | |
| Toggle | typeof NavigationToggle |
DocxEditorNavigationPropsinterfaceSource ↗
Props for DocxEditor.Navigation.
interface DocxEditorNavigationProps extends UseNavigationPaneOptions| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| searchHighlight? | DocumentSearchHighlight | Which Find matches to highlight while the Find tab is open: `'all'` (default), `'active'`, or `'none'`. The pane stops requesting highlights when it closes or leaves the tab; another `useDocumentSearch` consumer can still request them. |
| style? | CSSProperties | |
| t? | (key: string, params?: Record<string, string | number>) => string | |
| toggle? | boolean | NavigationPartProps |
DocxEditorNotePreviewPropsinterfaceSource ↗
Note hover preview content and viewport coordinates.
interface DocxEditorNotePreviewProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| scopeId | string | |
| text | string | |
| x | number | |
| y | number |
DocxEditorNotePropertiesDialogPropsinterfaceSource ↗
Note properties draft callbacks.
interface DocxEditorNotePropertiesDialogProps| Member | Type | Summary |
|---|---|---|
| onApply | | |
| onClose | |
DocxEditorNotesChromePropsinterfaceSource ↗
interface DocxEditorNotesChromeProps| Member | Type | Summary |
|---|---|---|
| className? | string |
DocxEditorNotesContextMenuPropsinterfaceSource ↗
Note context menu state and actions.
interface DocxEditorNotesContextMenuProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| convertAllDisabledReason? | string | |
| convertAllEnabled | boolean | |
| convertDisabledReason? | string | |
| convertEnabled | boolean | |
| deleteDisabledReason? | string | |
| deleteEnabled | boolean | |
| noteId | number | |
| noteKind | 'footnote' | 'endnote' | |
| onClose | | |
| onConvert | | |
| onConvertAll | | |
| onDelete | | |
| onOpenProperties | | |
| scopeId | string | |
| x | number | |
| y | number |
DocxEditorPageNumberPropsinterfaceSource ↗
Props for DocxEditor.PageNumber.
interface DocxEditorPageNumberProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| style? | CSSProperties |
DocxEditorPageSetupDialogPropsinterfaceSource ↗
interface DocxEditorPageSetupDialogProps extends DialogCustomizationProps| Member | Type | Summary |
|---|---|---|
| onClose | () => void | |
| open | boolean |
DocxEditorParagraphDialogPropsinterfaceSource ↗
Props for DocxEditorParagraphDialog.
interface DocxEditorParagraphDialogProps extends DialogCustomizationProps| Member | Type | Summary |
|---|---|---|
| onClose | () => void | |
| open | boolean |
DocxEditorPopupsinterfaceSource ↗
Render overrides for automatically hosted editor popups. False disables a popup.
interface DocxEditorPopups| Member | Type | Summary |
|---|---|---|
| contentControl? | DocxEditorPopup<ContentControlProps> | |
| contentControlCheckbox? | DocxEditorPopup<DocxEditorContentControlWidgetProps> | Renderer for checkbox presses. Omitted, the engine toggles the box itself and `contentControlWidget` never sees a checkbox session. Configure it to confirm, refuse or restyle the toggle; `DocxEditorContentControlWidget` without children applies it at once. |
| contentControlPicture? | DocxEditorPopup<DocxEditorContentControlWidgetProps> | Renderer for picture presses. Omitted, the engine opens its own file picker and `contentControlWidget` never sees a picture session. Configure it to pick from your own source; `DocxEditorContentControlWidget` without children opens a file picker at once. |
| contentControlWidget? | DocxEditorPopup<DocxEditorContentControlWidgetProps> | |
| contextMenu? | DocxEditorPopup<DocxEditorContextMenuProps> | |
| equation? | DocxEditorPopup<Record<string, never>> | |
| export? | DocxEditorPopup<DocxEditorExportDialogProps> | File export progress and errors. False hides feedback without stopping conversion. |
| hyperlink? | DocxEditorPopup<HyperLinkProps> | |
| imageAltText? | DocxEditorPopup<DocxEditorImageAltTextPopupProps> | |
| imageProperties? | DocxEditorPopup<DocxEditorImagePropertiesDialogProps> | |
| invalidTextFormField? | DocxEditorPopup<DocxEditorInvalidTextFormFieldDialogProps> | |
| notePreview? | DocxEditorPopup<DocxEditorNotePreviewProps> | |
| noteProperties? | DocxEditorPopup<DocxEditorNotePropertiesDialogProps> | |
| notesContextMenu? | DocxEditorPopup<DocxEditorNotesContextMenuProps> | |
| pageSetup? | DocxEditorPopup<DocxEditorPageSetupDialogProps> | |
| paragraph? | DocxEditorPopup<DocxEditorParagraphDialogProps> | |
| print? | DocxEditorPopup<DocxEditorPrintDialogProps> | File print progress and errors. False hides feedback; printing still runs. |
| textFormField? | DocxEditorPopup<DocxEditorTextFormFieldDialogProps> |
DocxEditorPrintDialogPropsinterfaceSource ↗
State and presentation for the File menu print dialog.
interface DocxEditorPrintDialogProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | Replaces the default contents while retaining the modal and focus behavior. |
| className? | string | Additional class on the dialog element. |
| error | string | Localized failure text, or an empty string. |
| onClose | | Closes the dialog. While `pending` is true, closing also cancels printing. |
| open | boolean | Controls visibility when rendering the dialog directly. |
| pending | boolean | True while the PDF handler converts the document. |
| style? | CSSProperties | Inline styles on the dialog element. |
| url | string | An object URL for the converted PDF when printing failed after conversion, such as in a browser without a PDF viewer. Otherwise an empty string. The default dialog links only to `blob:` URLs. |
DocxEditorPropsinterfaceSource ↗
Props for the Vue DocxEditor sugar host.
interface DocxEditorProps| Member | Type | Summary |
|---|---|---|
| author? | string | |
| chrome? | boolean | |
| class? | string | |
| colorMode? | 'light' | 'dark' | 'system' | |
| contextMenu? | boolean | DocxEditorContextMenuProps | |
| document? | DocumentSource | |
| fonts? | FontConfiguration | FontConfigurationFragment | FontResolver | |
| hyperlinkPopup? | boolean | |
| i18n? | Translations | |
| locale? | string | BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US. Changes apply to subsequent edits without a remount; stored date formats are preserved. UI translations are supplied separately through i18n. |
| menu? | boolean | DocxEditorMenuProps | |
| mode? | EditorMode | Live host mode. |
| modules? | readonly EditorModule[] | Construction-time capability modules. Later array changes need a remount. |
| navigation? | boolean | DocxEditorNavigationProps | |
| popups? | DocxEditorPopups | |
| rulers? | boolean | |
| t? | (key: string, params?: Record<string, string | number>) => string | Live resolver for chrome and drawing labels. |
| title? | string | |
| zoom? | number | |
| zoomMode? | ZoomMode | 'auto' |
DocxEditorRefinterfaceSource ↗
Imperative handle exposed by <DocxEditor ref="…">.
interface DocxEditorRef| Member | Type | Summary |
|---|---|---|
| exec | | |
| focus | | |
| getDocumentHandle | | |
| getEditor | | |
| load | | |
| save | | |
| snapshot | |
DocxEditorRootListenersinterfaceSource ↗
Lifecycle listeners for [provideDocxEditor](provideDocxEditor); bind on [DocxEditorRoot](DocxEditorRoot).
interface DocxEditorRootListeners| Member | Type | Summary |
|---|---|---|
| onChange? | (change: DocumentChange) => void | |
| onFontError? | (error: EditorFontError) => void | |
| onReady? | (editor: Editor) => void |
DocxEditorRootPropsinterfaceSource ↗
interface DocxEditorRootProps| Member | Type | Summary |
|---|---|---|
| author? | string | Author for later comments, replies, and tracked changes. Changes apply without a remount. |
| children? | DocxEditorChildren | |
| document? | DocumentSource | |
| fonts? | FontConfiguration | FontConfigurationFragment | FontResolver | |
| imageDecodePort? | ImageDecodePort | |
| locale? | string | BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US. Changes apply to subsequent edits without a remount; stored date formats are preserved. For UI translations, wrap Root and its chrome in LocaleProvider with an i18n catalog. |
| mode? | 'edit' | 'view' | 'suggesting' | Live host mode. Omit it to let document tracking settings select the mode. |
| modules? | readonly EditorModule[] | Construction-time capability modules. Later array changes need a remount. |
| onChange? | (change: DocumentChange) => void | |
| onFontError? | (error: EditorFontError) => void | |
| onReady? | (editor: Editor) => void | |
| popups? | DocxEditorPopups | |
| tableInteractionLabel? | (key: 'table.insertRowBelow' | 'table.insertColumnRight') => string | |
| translate? | (key: string, params?: Record<string, string | number>) => string | Live drawing and form-control labels. Defaults to the active catalogue. |
| zoom? | number | |
| zoomMode? | ZoomMode | 'auto' |
DocxEditorRulerPropsinterfaceSource ↗
interface DocxEditorRulerProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| style? | CSSProperties | |
| unit? | 'inch' | 'cm' |
DocxEditorTextFormFieldDialogPropsinterfaceSource ↗
Controlled Field Options dialog.
interface DocxEditorTextFormFieldDialogProps extends DialogCustomizationProps| Member | Type | Summary |
|---|---|---|
| session | TextFormFieldDialogSession | null |
DocxEditorToolbarNamespaceinterfaceSource ↗
interface DocxEditorToolbarNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Action | typeof ToolbarAction | |
| AlignCenter | ToolbarPartComponent | |
| AlignJustify | ToolbarPartComponent | |
| AlignLeft | ToolbarPartComponent | |
| Alignment | ToolbarAlignmentComponent | |
| AlignRight | ToolbarPartComponent | |
| Bold | ToolbarPartComponent | |
| BulletList | ToolbarPartComponent | |
| Button | typeof ToolbarButton$1 | |
| ClearFormatting | ToolbarPartComponent | |
| Comments | ToolbarPartComponent | |
| ContentControlFormFill | ToolbarPartComponent | |
| ContentControlInspector | ToolbarPartComponent | |
| ContentControlRemove | ToolbarPartComponent | |
| ContentControlShowAll | ToolbarPartComponent | |
| EditingMode | ToolbarSlotPartComponent | |
| FontColor | ToolbarColorSplitComponent | |
| FontFamily | typeof FontFamily | |
| FontSize | ToolbarSlotPartComponent | |
| Highlight | ToolbarColorSplitComponent | |
| ImageAltText | ImageAltTextPartComponent | |
| ImageInsert | ToolbarPartComponent | |
| ImageProperties | ToolbarPartComponent | |
| ImageWrap | ImageWrapPartComponent | |
| Indent | ToolbarPartComponent | |
| Italic | ToolbarPartComponent | |
| LeftToRight | ToolbarPartComponent | |
| LineSpacing | ToolbarSlotPartComponent | |
| Link | ToolbarPartComponent | |
| NumberedList | ToolbarPartComponent | |
| Outdent | ToolbarPartComponent | |
| Redo | ToolbarPartComponent | |
| Reviewers | typeof ToolbarReviewers | |
| RightToLeft | ToolbarPartComponent | |
| Save | ToolbarSlotPartComponent | |
| Separator | typeof ToolbarSeparator | |
| Strike | ToolbarPartComponent | |
| StylePicker | typeof ParagraphStyle | |
| Subscript | ToolbarPartComponent | |
| Superscript | ToolbarPartComponent | |
| TableBorderColor | TableBorderColorNamespace | |
| TableBorderStyle | TableBorderStyleNamespace | |
| TableBorderTarget | TableBorderTargetNamespace | |
| TableBorderWidth | TableBorderWidthNamespace | |
| TableCellFill | TableCellFillNamespace | |
| TableInsert | ToolbarPartComponent | |
| Underline | ToolbarPartComponent | |
| Undo | ToolbarPartComponent | |
| Zoom | ToolbarSlotPartComponent |
DocxEditorToolbarPropsinterfaceSource ↗
interface DocxEditorToolbarProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| onSave? | () => void | |
| overflow? | boolean | |
| preset? | boolean | |
| t? | ToolbarTranslate |
DocxEditorViewportPropsinterfaceSource ↗
interface DocxEditorViewportProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string | |
| style? | CSSProperties |
EditorCaretinterfaceSource ↗
interface EditorCaret| Member | Type | Summary |
|---|---|---|
| offset | number | |
| paragraphId | string |
EditorCommandStateinterfaceSource ↗
interface EditorCommandState| Member | Type | Summary |
|---|---|---|
| disabledReason | ComputedRef<string | null> | |
| execute | EditorCommandExecute | |
| isActive | ComputedRef<boolean> | |
| isEnabled | ComputedRef<boolean> | |
| value | ComputedRef<string | null> | What the control SHOWS, for the slots whose answer is a value rather than a pressed state — the editing-mode pill, and the format painter's `off` / `once` / `locked`. |
EditorValueCommandStateinterfaceSource ↗
interface EditorValueCommandState<T extends string | number>| Member | Type | Summary |
|---|---|---|
| disabledReason | ComputedRef<string | null> | |
| execute | (value: T, options?: EditorExecOptions) => ExecResult | |
| isEnabled | ComputedRef<boolean> | |
| options | ComputedRef<readonly T[]> | |
| value | ComputedRef<T | null> |
FontFamilyItemPropsinterfaceSource ↗
interface FontFamilyItemProps extends FontFamilyPartProps| Member | Type | Summary |
|---|---|---|
| value | string |
FontFamilyNamespaceinterfaceSource ↗
interface FontFamilyNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Content | typeof FontFamilyContent | |
| docxSlot | 'font.family' | |
| Item | typeof FontFamilyItem | |
| Trigger | typeof FontFamilyTrigger |
FontFamilyPartPropsinterfaceSource ↗
interface FontFamilyPartProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
FontFamilyPropsinterfaceSource ↗
interface FontFamilyProps extends FontFamilyPartProps| Member | Type | Summary |
|---|
HorizontalRulerPropsinterfaceSource ↗
interface HorizontalRulerProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| editable? | boolean | Whether the MARGIN handles drag. |
| indent? | RulerIndent | null | The paragraph's indent in twips; `firstLine` is SIGNED, negative for a hanging. |
| indentEditable? | boolean | Whether the INDENT handles drag — a different capability from `editable`. |
| onIndentChange? | (indent: RulerIndent) => void | Fires continuously through an indent drag, for the host to preview. |
| onIndentDragEnd? | () => void | Fires when an indent drag is released — the moment to commit one undoable step. |
| onLeftMarginChange? | (marginTwips: number) => void | |
| onMarginDragEnd? | () => void | Fires when a margin drag is released — the moment to commit what the drag previewed. |
| onRightMarginChange? | (marginTwips: number) => void | |
| onTabMarkRemove? | (positionTwips: number) => void | |
| pageSetup? | RulerPageSetup | null | |
| showIndentHandles? | boolean | Paint the four indent handles. |
| style? | CSSProperties | |
| tabMarks? | RulerTabStop[] | null | |
| unit? | 'inch' | 'cm' | |
| zoom? | number |
HyperLinkActionPropsinterfaceSource ↗
Props for the action parts, which also take an icon.
interface HyperLinkActionProps extends HyperLinkPartProps| Member | Type | Summary |
|---|---|---|
| icon? | DocxEditorChildren |
HyperLinkPartPropsinterfaceSource ↗
Shared props for every part.
interface HyperLinkPartProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
HyperlinkPopupAnchorinterfaceSource ↗
interface HyperlinkPopupAnchor| Member | Type | Summary |
|---|---|---|
| left | number | |
| top | number |
HyperlinkPopupStateinterfaceSource ↗
interface HyperlinkPopupState| Member | Type | Summary |
|---|---|---|
| anchor | HyperlinkPopupAnchor | null | |
| canEdit | boolean | |
| copied | boolean | |
| error | boolean | |
| link | SurfaceHyperlink | null | |
| mode | HyperlinkPopupMode | |
| text | string | |
| url | string |
HyperLinkPropsinterfaceSource ↗
Props for DocxEditor.HyperLink.
interface HyperLinkProps extends HyperLinkPartProps| Member | Type | Summary |
|---|---|---|
| preset? | boolean |
ImagePropertiesTriggerPropsinterfaceSource ↗
Props for the toolbar properties trigger.
interface ImagePropertiesTriggerProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
IndentUpdateinterfaceSource ↗
interface IndentUpdate| Member | Type | Summary |
|---|---|---|
| firstLine? | number | null | |
| left? | number | null | |
| right? | number | null |
LocaleProviderPropsinterfaceSource ↗
interface LocaleProviderProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| i18n? | Translations |
MenuActionPropsinterfaceSource ↗
Props for the pinned File rows.
interface MenuActionProps| Member | Type | Summary |
|---|---|---|
| className? | string |
MenuGroupPropsinterfaceSource ↗
Props for DocxEditor.Menu.Group: a titled section of rows.
interface MenuGroupProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| label? | string | Literal heading, already resolved. Wins over [labelKey](labelKey). |
| labelKey? | string | i18n key of the heading. |
MenuItemPropsinterfaceSource ↗
Props for DocxEditor.Menu.Item: one chrome slot as a menu row.
interface MenuItemProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| labelKey? | string | Plain-label i18n key, overriding the slot's tooltip-shaped one. |
| shortcutKey? | string | i18n key of the shortcut shown in the right column. |
| slot | ChromeSlotId | The chrome slot this row drives (`'text.bold'`, `'insert.pageBreak'`, …). |
MenuPartComponentinterfaceSource ↗
A menu pinned to one registry id, for DocxEditor.Menu.File and friends.
interface MenuPartComponent| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| docxMenu | ChromeMenuId |
MenuPropsinterfaceSource ↗
Props for DocxEditor.Menu.Menu and the five pinned menu parts.
interface MenuProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | Panel content. |
| className? | string | |
| icon? | DocxEditorChildren | Icon shown before the trigger's label. |
| id | MenuId | Which menu this is. Only one panel in the bar is open at a time, keyed on this. |
| label? | string | Literal trigger label, already resolved. Wins over `labelKey`, and is what a host-defined menu uses — its name is not in our catalogue and never will be. |
| labelKey? | string | i18n key of the trigger label. Defaults to the registry's. |
| preset? | boolean | `false` renders `children` verbatim as the whole panel. Default `true`: the panel is the registry's rows for this menu, with a row child REPLACING the row it names in place (`hidden` removes it) and any other child appended. Use `false` when the order matters and you want to state it yourself. |
MenuReportIssuePropsinterfaceSource ↗
Props for DocxEditor.Menu.ReportIssue.
interface MenuReportIssueProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| onSelect? | () => void | Replaces the packaged handler. Falls back to the menu's `onReportIssue`, then to this project's own tracker. |
MenuRowPropsinterfaceSource ↗
Props for DocxEditor.Menu.Row: one presentational menu row.
interface MenuRowProps| Member | Type | Summary |
|---|---|---|
| "data-slot"? | string | |
| active? | boolean | Checked state, for a row that TOGGLES (bold on bold text). Leave undefined on a row that just acts: `menuitemcheckbox` with `aria-checked="false"` announces "not selected" on a Page break row, which is a claim about state it does not have. |
| children? | DocxEditorChildren | |
| className? | string | |
| disabled? | boolean | |
| icon? | DocxEditorChildren | Material Symbols paths, rendered as inline SVG in the row's icon column. |
| onSelect? | () => void | |
| rowSlot? | string | Stable marker for hosts, tests and e2e — pass via [menuRowSlot](menuRowSlot). |
| selected? | true | Present on a row belonging to a MUTUALLY EXCLUSIVE set (the four alignments), which makes it `menuitemradio` rather than `menuitemcheckbox`. Four independent checkboxes is a different claim from one-of-four, and a screen reader reads it as such. |
| selectHandler? | () => void | Row activation handler. Prefer this name — Vue TSX treats `onSelect` as a listener. |
| shortcut? | string | Right-aligned shortcut text (already resolved). |
| slot? | string | React parity alias for [rowSlot](rowSlot). |
| title? | string | Tooltip. Set it for the ENGINE's disabled reason and nothing else — a menu row's text is already visible, so a tooltip repeating it is noise, and inventing a reason for a refusal the engine explained is the thing this codebase does not do. |
MenuSeparatorPropsinterfaceSource ↗
Props for DocxEditor.Menu.Separator.
interface MenuSeparatorProps| Member | Type | Summary |
|---|---|---|
| className? | string |
MenuSubmenuPropsinterfaceSource ↗
interface MenuSubmenuProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| labelKey | string | i18n key of the parent row's label. |
| paths? | readonly string[] | null | Material Symbols paths for the parent row's icon. |
MenuTableGridPropsinterfaceSource ↗
Props for DocxEditor.Menu.TableGrid.
interface MenuTableGridProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| slot? | ChromeSlotId | The slot the picked size dispatches through. Defaults to `table.insert`. |
NavigationPartPropsinterfaceSource ↗
Shared props for the pane's structural parts.
interface NavigationPartProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| className? | string | |
| style? | CSSProperties |
NavigationShiftInputinterfaceSource ↗
interface NavigationShiftInput| Member | Type | Summary |
|---|---|---|
| docked? | boolean | Whether the page's WIDTH follows the padding right now. |
| inlineEndReservation? | number | Padding already reserved at the inline end, for example by the review rail. |
| inlineStartReservation? | number | Padding already reserved at the inline start besides this shift. |
| pageWidthPx | number | Rendered width of one page, zoom applied. |
| reservation | number | Space the open pane needs, from [navigationPaneReservation](navigationPaneReservation). |
| viewportWidth | number | Client width of the scroll container. |
NavigationTabPropsinterfaceSource ↗
interface NavigationTabProps extends NavigationPartProps| Member | Type | Summary |
|---|---|---|
| value | NavigationTab$1 |
OutlineHeadingIteminterfaceSource ↗
interface OutlineHeadingItem| Member | Type | Summary |
|---|---|---|
| depth | number | |
| heading | OutlineHeading$1 |
PageIndicatorPropsinterfaceSource ↗
interface PageIndicatorProps| Member | Type | Summary |
|---|---|---|
| currentPage | number | |
| totalPages | number | |
| visible | boolean |
PageSetupDialogFieldsinterfaceSource ↗
Page Setup draft values in twips.
interface PageSetupDialogFields| Member | Type | Summary |
|---|---|---|
| marginBottom | number | |
| marginLeft | number | |
| marginRight | number | |
| marginTop | number | |
| orientation | 'portrait' | 'landscape' | |
| pageHeight | number | |
| pageWidth | number | |
| scope | 'document' | 'section' |
PageSetupUpdateinterfaceSource ↗
interface PageSetupUpdate| Member | Type | Summary |
|---|---|---|
| marginBottomTwips? | number | |
| marginLeftTwips? | number | |
| marginRightTwips? | number | |
| marginTopTwips? | number | |
| orientation? | 'portrait' | 'landscape' | |
| pageHeightTwips? | number | |
| pageWidthTwips? | number | |
| scope? | 'document' | 'section' |
PaginatedDocxEditorHandleinterfaceSource ↗
interface PaginatedDocxEditorHandle| Member | Type | Summary |
|---|---|---|
| focus | | |
| formatting | | |
| navigate | | |
| redo | | |
| save | | Save pending form input. Throws for invalid values or an active edit. |
| sectionProperties | | |
| selectAll | | |
| setParagraphProperty | | `options.mergeAttributes` keeps the attributes the call does not name — see the React twin. |
| setRunProperty | | |
| toggleRunProperty | | |
| type | | |
| undo | |
PaginatedDocxEditorPropsinterfaceSource ↗
interface PaginatedDocxEditorProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| documentFontFamily? | string | |
| measurer? | TextMeasurer | |
| onError? | (reason: string, detail?: string) => void | |
| onStateChange? | (state: PaginatedSurfaceState) => void | |
| ref? | Ref<PaginatedDocxEditorHandle> | |
| scale? | number | |
| source | Uint8Array |
PaginatedDocxEditorShellPropsinterfaceSource ↗
interface PaginatedDocxEditorShellProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| colorMode? | 'light' | 'dark' | |
| documentFontFamily? | string | |
| documentName? | string | |
| measurer? | TextMeasurer | |
| onError? | (reason: string, detail?: string) => void | |
| onSave? | (bytes: Uint8Array) => void | |
| onStateChange? | (state: PaginatedSurfaceState) => void | |
| onZoomChange? | (zoom: number) => void | |
| ref? | Ref<PaginatedDocxEditorHandle> | |
| renderTitleBarLeft? | () => DocxEditorChildren | |
| renderTitleBarRight? | () => DocxEditorChildren | |
| scale? | number | |
| source | Uint8Array |
ParagraphStyleItemPropsinterfaceSource ↗
interface ParagraphStyleItemProps extends ParagraphStylePartProps| Member | Type | Summary |
|---|---|---|
| value | string |
ParagraphStyleNamespaceinterfaceSource ↗
interface ParagraphStyleNamespace| Member | Type | Summary |
|---|---|---|
| (member-0) | | |
| Content | typeof ParagraphStyleContent | |
| docxSlot | 'styles.style' | |
| Item | typeof ParagraphStyleItem | |
| Trigger | typeof ParagraphStyleTrigger |
ParagraphStyleOptioninterfaceSource ↗
interface ParagraphStyleOption| Member | Type | Summary |
|---|---|---|
| name | string | |
| preview | {
readonly fontFamily: string | null;
readonly fontSizePt: number | null;
readonly bold: boolean;
readonly italic: boolean;
readonly color: string | null;
} | |
| styleId | string |
ParagraphStylePartPropsinterfaceSource ↗
interface ParagraphStylePartProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
ParagraphStylePropsinterfaceSource ↗
interface ParagraphStyleProps extends ParagraphStylePartProps| Member | Type | Summary |
|---|
ProvideDocxEditorResultinterfaceSource ↗
interface ProvideDocxEditorResult| Member | Type | Summary |
|---|---|---|
| DocxEditorRoot | typeof DocxEditorRoot | |
| editorRef | ReturnType<typeof useDocxEditor> | |
| rootListeners | DocxEditorRootListeners | |
| rootProps | ShallowRef<Omit<DocxEditorRootProps, keyof DocxEditorRootListeners>> |
ReviewGutterinterfaceSource ↗
Scroll-container reservations on each inline edge.
interface ReviewGutter| Member | Type | Summary |
|---|---|---|
| inlineEnd | number | |
| inlineStart | number |
ReviewGutterInputinterfaceSource ↗
Inputs for [reviewGutter](reviewGutter).
interface ReviewGutterInput| Member | Type | Summary |
|---|---|---|
| docked? | boolean | |
| inlineStartReservation? | number | |
| open | boolean | |
| pageWidthPx | number | |
| viewportWidth | number |
ReviewRailRegistryinterfaceSource ↗
interface ReviewRailRegistry| Member | Type | Summary |
|---|---|---|
| mounted | number | |
| register | () => () => void | |
| registerCommentDraft | (handler: () => void) => () => void | |
| requestCommentDraft | () => boolean |
ScopedChromeAnchorinterfaceSource ↗
interface ScopedChromeAnchor| Member | Type | Summary |
|---|---|---|
| ref | DocxEditorRefCallback<HTMLDivElement> | |
| style | ShallowRef<CSSProperties> |
SlotPropsinterfaceSource ↗
interface SlotProps| Member | Type | Summary |
|---|---|---|
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string | |
| ref? | unknown | |
| style? | CSSProperties |
TableBorderColorNamespaceinterfaceSource ↗
interface TableBorderColorNamespace extends TableChromePartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | 'table.borderColor' | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Main | (props: TableChromePartProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableBorderStyleNamespaceinterfaceSource ↗
interface TableBorderStyleNamespace extends TableChromePartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | 'table.borderStyle' | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableBorderTargetNamespaceinterfaceSource ↗
interface TableBorderTargetNamespace extends TableChromePartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | 'table.borderTarget' | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableBorderWidthNamespaceinterfaceSource ↗
interface TableBorderWidthNamespace extends TableChromePartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | 'table.borderWidth' | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableCellFillNamespaceinterfaceSource ↗
interface TableCellFillNamespace extends TableChromePartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | 'table.cellFill' | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Main | (props: TableChromePartProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableChromeItemPropsinterfaceSource ↗
interface TableChromeItemProps extends TableChromePartProps| Member | Type | Summary |
|---|---|---|
| value | string |
TableChromePartComponentinterfaceSource ↗
interface TableChromePartComponent extends ToolbarSlotPartComponent| Member | Type | Summary |
|---|---|---|
| Content | (props: TableChromePartProps) => DocxEditorChildren | |
| docxSlot | TableChromeSlotId | |
| Item | (props: TableChromeItemProps) => DocxEditorChildren | |
| Trigger | (props: TableChromePartProps) => DocxEditorChildren |
TableChromePartPropsinterfaceSource ↗
interface TableChromePartProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| className? | string |
TextFormFieldDialogFieldsinterfaceSource ↗
Editable Field Options draft.
interface TextFormFieldDialogFields| Member | Type | Summary |
|---|---|---|
| defaultText | string | |
| enabled | boolean | |
| format | string | |
| maxLength | number | |
| type | string |
ToolbarActionPropsinterfaceSource ↗
interface ToolbarActionProps| Member | Type | Summary |
|---|---|---|
| active? | boolean | |
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string | |
| disabled? | boolean | |
| disabledReason? | string | |
| icon? | DocxEditorChildren | |
| label | string | |
| onSelect? | () => void |
ToolbarAlignmentComponentinterfaceSource ↗
interface ToolbarAlignmentComponent| Member | Type | Summary |
|---|---|---|
| docxSlot | 'alignment' |
ToolbarButtonPropsinterfaceSource ↗
interface ToolbarButtonProps| Member | Type | Summary |
|---|---|---|
| asChild? | boolean | |
| children? | DocxEditorChildren | |
| class? | string | |
| className? | string | |
| icon? | DocxEditorChildren | |
| slot | ChromeSlotId |
ToolbarContextValueinterfaceSource ↗
interface ToolbarContextValue| Member | Type | Summary |
|---|---|---|
| onSave | (() => void) | undefined | |
| t | ToolbarTranslate | undefined |
ToolbarPartComponentinterfaceSource ↗
interface ToolbarPartComponent| Member | Type | Summary |
|---|---|---|
| docxSlot | ChromeSlotId |
ToolbarPropsinterfaceSource ↗
Deprecated. Use `DocxEditor.Toolbar` from the composition layer instead.
Props for the deprecated formatting rail.
interface ToolbarProps| Member | Type | Summary |
|---|---|---|
| canRedo? | boolean | |
| canUndo? | boolean | |
| children? | DocxEditorChildren | |
| className? | string | |
| currentFormatting? | SelectionFormatting | |
| disabled? | boolean | |
| documentFonts? | readonly FontOption[] | |
| documentStyles? | readonly DocumentStyleSummary[] | |
| editorRef? | RefObject<HTMLElement> | |
| enableShortcuts? | boolean | |
| fontFamilies? | ReadonlyArray<string | FontOption> | |
| imageContext? | {
wrapType: string;
displayMode: string;
cssFloat: string | null;
} | null | |
| inline? | boolean | |
| onFormat? | (action: FormattingAction) => void | |
| onImageTransform? | (action: 'rotateCW' | 'rotateCCW' | 'flipH' | 'flipV') => void | |
| onImageWrapType? | (wrapType: string) => void | |
| onInsertImage? | () => void | |
| onInsertPageBreak? | () => void | |
| onInsertSectionBreakContinuous? | () => void | |
| onInsertSectionBreakNextPage? | () => void | |
| onInsertShape? | (data: {
shapeType: string;
width: number;
height: number;
fillColor?: string;
fillType?: string;
outlineWidth?: number;
outlineColor?: string;
}) => void | |
| onInsertTable? | (rows: number, columns: number) => void | |
| onInsertTOC? | () => void | |
| onOpen? | () => void | |
| onOpenImageProperties? | () => void | |
| onPageSetup? | () => void | |
| onPrint? | () => void | |
| onRedo? | () => void | |
| onRefocusEditor? | () => void | |
| onSave? | () => void | |
| onTableAction? | (action: TableAction) => void | |
| onUndo? | () => void | |
| onWatermark? | () => void | |
| onZoomChange? | (zoom: number) => void | |
| showAlignmentButtons? | boolean | |
| showFontPicker? | boolean | |
| showFontSizePicker? | boolean | |
| showHelpMenu? | boolean | |
| showHighlightColorPicker? | boolean | |
| showLineSpacingPicker? | boolean | |
| showListButtons? | boolean | |
| showStylePicker? | boolean | |
| showTableInsert? | boolean | |
| showTextColorPicker? | boolean | |
| showZoomControl? | boolean | |
| style? | CSSProperties | |
| tableContext? | {
isInTable: boolean;
rowCount?: number;
columnCount?: number;
canSplitCell?: boolean;
hasMultiCellSelection?: boolean;
cellBorderColor?: ColorValue;
cellBackgroundColor?: string;
} | null | |
| theme? | Theme | null | |
| zoom? | number |
ToolbarSeparatorPropsinterfaceSource ↗
interface ToolbarSeparatorProps| Member | Type | Summary |
|---|---|---|
| class? | string | |
| className? | string |
ToolbarSlotPartComponentinterfaceSource ↗
interface ToolbarSlotPartComponent| Member | Type | Summary |
|---|---|---|
| docxSlot | ChromeSlotId |
ToolbarSlotPartPropsinterfaceSource ↗
interface ToolbarSlotPartProps| Member | Type | Summary |
|---|---|---|
| class? | string | |
| className? | string |
UseContentControlResultinterfaceSource ↗
interface UseContentControlResult| Member | Type | Summary |
|---|---|---|
| canRemove | ComputedRef<boolean> | |
| canSetValue | ComputedRef<boolean> | |
| closeInspector | () => void | |
| control | ComputedRef<ContentControlInspectorState | null> | |
| controls | ComputedRef<readonly ContentControlSummary[]> | |
| formFill | ComputedRef<boolean> | |
| inspectorOpen | ComputedRef<boolean> | |
| openInspector | () => void | |
| remove | () => ExecResult | |
| removeDisabledReason | ComputedRef<string | null> | |
| setFormFill | (on: boolean) => void | |
| setShowAll | (show: boolean) => void | |
| setValue | (value: string) => ExecResult | |
| setValueDisabledReason | ComputedRef<string | null> | |
| showAll | ComputedRef<boolean> | |
| toggleFormFill | () => void | |
| toggleInspector | () => void | |
| toggleShowAll | () => void |
UseContentControlWidgetResultinterfaceSource ↗
The draft state a content-control value pop-up renders over.
Read it from useContentControlWidget() inside DocxEditorContentControlWidget. value is the draft; apply() commits it through the session, which the engine validates. The calendar members drive the date picker: calendar is the month in view, built for the session's locale. Reactive members are refs.
interface UseContentControlWidgetResult| Member | Type | Summary |
|---|---|---|
| accept | string | Picture sessions: the image types `replaceImage` takes, as a file input `accept` list. |
| apply | | Commit `value`, or an explicit one; false when the engine refused it. |
| applyDateText | | |
| calendar | Readonly<Ref<CalendarMonth>> | |
| cancel | | |
| dateText | Readonly<Ref<string>> | Numeric regional date entry, separate from the ISO value. |
| focusDay | | Move keyboard focus to a day, turning the month if it lies outside the view. |
| focusIso | Readonly<Ref<string | null>> | The day keyboard focus should land on after the grid renders, if any. |
| isEnabled | Readonly<Ref<boolean>> | The engine still accepts a write for this control. |
| items | Readonly<Ref<readonly ContentControlWidgetEntry[]>> | |
| kind | Readonly<Ref<ContentControlWidgetSession['kind']>> | |
| listId | string | ID shared by the combo input and listbox. |
| listNavigation | ContentControlListNavigation | Shared typeahead and roving-focus behavior for replacement lists. |
| nextMonth | | |
| previousMonth | | |
| refused | Readonly<Ref<boolean>> | The last `apply()` was refused by the engine. |
| replaceImage | | Picture sessions: replace the control's image from a file or its bytes. The engine checks the format and size; false (and `refused`) when it declines or the session is not a picture session. |
| selectDay | | Commit one calendar day (`YYYY-MM-DD`). |
| selectToday | | Commit the current local date. |
| session | Readonly<Ref<ContentControlWidgetSession>> | |
| setDateText | | |
| setValue | | |
| showMonth | | Jump to a month without committing. Month is zero-based; year is 100–9999. |
| value | Readonly<Ref<string>> |
UseDialogReturninterfaceSource ↗
Draft state and actions for a dialog.
interface UseDialogReturn<T extends object>| Member | Type | Summary |
|---|---|---|
| apply | | |
| cancel | | |
| errors | Readonly<Ref<Readonly<Partial<Record<keyof T | 'form', string>>>>> | |
| isEnabled | Readonly<Ref<boolean>> | |
| setValue | | |
| values | Readonly<Ref<T>> |
UseDocumentOutlineResultinterfaceSource ↗
interface UseDocumentOutlineResult| Member | Type | Summary |
|---|---|---|
| goTo | (blockId: string) => void | |
| headings | ComputedRef<readonly OutlineHeading$1[]> | |
| isEmpty | ComputedRef<boolean> | |
| items | ComputedRef<readonly OutlineHeadingItem[]> | |
| selectedBlockId | ComputedRef<string | null> |
UseDocumentSearchOptionsinterfaceSource ↗
How useDocumentSearch behaves.
interface UseDocumentSearchOptions| Member | Type | Summary |
|---|---|---|
| highlight? | DocumentSearchHighlight | Which matches to mark: every match with the active one emphasized (`'all'`), only the active match (`'active'`), or none (`'none'`). Default: `'all'`. |
UseDocumentSearchResultinterfaceSource ↗
What useDocumentSearch answers.
interface UseDocumentSearchResult| Member | Type | Summary |
|---|---|---|
| activeIndex | ComputedRef<number> | Index of the current match, or `-1` before any navigation. |
| activeMatch | ComputedRef<TextMatch | null> | The current match, or `null` before any navigation. |
| clear | () => void | Empty the query and drop the results, without changing the selection. |
| find | (query: string, options?: DocumentSearchFindOptions) => readonly TextMatch[] | Search now and return the matches. `selectFirst` selects the first match; `highlight` highlights the results until `clear()`, even without this hook's own request. |
| goTo | (index: number) => boolean | Select a match by index and bring its page into view. Focus stays where it is, so a search box keeps it. Returns false for an index without a match. |
| isPending | ComputedRef<boolean> | Whether a typed query is waiting for its debounce to elapse. |
| matchCase | ComputedRef<boolean> | |
| matches | ComputedRef<readonly TextMatch[]> | Matches for the last searched query, in document order. |
| next | () => boolean | Next / previous match, wrapping at the ends the way Word's arrows do. |
| previous | () => boolean | |
| query | ComputedRef<string> | The text in the search box, updated synchronously as the user types. |
| setMatchCase | (value: boolean) => void | |
| setQuery | (query: string) => void | Update the typed query. The search runs after a short debounce. |
| setWholeWord | (value: boolean) => void | |
| truncated | ComputedRef<boolean> | The search stopped at its cap with matches still ahead, so a count reads "2000+". |
| wholeWord | ComputedRef<boolean> |
UseDocxSourceOptionsinterfaceSource ↗
interface UseDocxSourceOptions| Member | Type | Summary |
|---|---|---|
| fetchOptions? | RequestInit | |
| fonts? | DocxFontsSource |
UseDocxSourceResultinterfaceSource ↗
interface UseDocxSourceResult| Member | Type | Summary |
|---|---|---|
| document | ComputedRef<Uint8Array | undefined> | |
| error | ComputedRef<Error | null> | |
| fonts | ComputedRef<FontConfiguration | FontResolver | undefined> | |
| isLoading | ComputedRef<boolean> |
UseFontFamilyResultinterfaceSource ↗
interface UseFontFamilyResult| Member | Type | Summary |
|---|---|---|
| isEnabled | ComputedRef<boolean> | |
| options | ComputedRef<readonly string[]> | |
| setValue | (family: string) => void | |
| value | ComputedRef<string | null> |
UseHistoryGroupReturninterfaceSource ↗
interface UseHistoryGroupReturn| Member | Type | Summary |
|---|---|---|
| options | () => EditorExecOptions | |
| ref | (element: HTMLElement | null) => void |
UseHyperlinkPopupResultinterfaceSource ↗
interface UseHyperlinkPopupResult| Member | Type | Summary |
|---|---|---|
| beginEdit | () => void | |
| close | () => void | |
| commitEdit | () => boolean | |
| copy | () => Promise<boolean> | |
| open | (link?: SurfaceHyperlink | null, anchor?: HyperlinkPopupAnchor | null) => void | |
| openAtCaret | () => void | |
| openTarget | () => boolean | |
| setText | (text: string) => void | |
| setUrl | (url: string) => void | |
| state | ComputedRef<HyperlinkPopupState> | |
| unlink | () => boolean |
UseNavigationPaneOptionsinterfaceSource ↗
interface UseNavigationPaneOptions| Member | Type | Summary |
|---|---|---|
| defaultOpen? | boolean | |
| defaultTab? | NavigationTab$1 | |
| onOpenChange? | (open: boolean) => void | |
| onTabChange? | (tab: NavigationTab$1) => void | |
| open? | boolean | |
| paneWidth? | number | |
| tab? | NavigationTab$1 |
UseNavigationPaneResultinterfaceSource ↗
interface UseNavigationPaneResult| Member | Type | Summary |
|---|---|---|
| open | ComputedRef<boolean> | |
| paneWidth | ComputedRef<number> | |
| setOpen | (open: boolean) => void | |
| setTab | (tab: NavigationTab$1) => void | |
| shift | ComputedRef<number> | |
| tab | ComputedRef<NavigationTab$1> | |
| toggle | () => void |
UsePageSetupDialogReturninterfaceSource ↗
Page Setup draft state and actions.
interface UsePageSetupDialogReturn extends UseDialogReturn<PageSetupDialogFields>UsePageSetupReturninterfaceSource ↗
interface UsePageSetupReturn| Member | Type | Summary |
|---|---|---|
| apply | (update: PageSetupUpdate) => boolean | |
| isEnabled | ComputedRef<boolean> | |
| pageSetup | ComputedRef<PageSetup | null> |
UseParagraphDialogReturninterfaceSource ↗
Paragraph draft state, mixed values, and actions.
interface UseParagraphDialogReturn extends UseDialogReturn<ParagraphDialogFields>| Member | Type | Summary |
|---|---|---|
| mixed | Readonly<Ref<ParagraphDialogMixed>> |
UseParagraphFormatReturninterfaceSource ↗
What useParagraphFormat returns.
interface UseParagraphFormatReturn| Member | Type | Summary |
|---|---|---|
| apply | (update: ParagraphFormatUpdate) => boolean | |
| format | ComputedRef<ParagraphFormatRead | null> | |
| isEnabled | ComputedRef<boolean> |
UseParagraphIndentReturninterfaceSource ↗
interface UseParagraphIndentReturn| Member | Type | Summary |
|---|---|---|
| apply | (update: IndentUpdate) => boolean | |
| indent | ComputedRef<IndentFormatting | null> | |
| isEnabled | ComputedRef<boolean> |
UseParagraphStyleResultinterfaceSource ↗
interface UseParagraphStyleResult| Member | Type | Summary |
|---|---|---|
| isEnabled | ComputedRef<boolean> | |
| options | ComputedRef<readonly ParagraphStyleOption[]> | |
| setValue | (styleId: string) => void | |
| value | ComputedRef<string | null> |
UseTextFormFieldDialogReturninterfaceSource ↗
Field Options draft state and actions.
interface UseTextFormFieldDialogReturn extends UseDialogReturn<TextFormFieldDialogFields>UseZoomResultinterfaceSource ↗
interface UseZoomResult| Member | Type | Summary |
|---|---|---|
| auto | () => void | |
| canZoomIn | ComputedRef<boolean> | |
| canZoomOut | ComputedRef<boolean> | |
| fitToWidth | () => void | |
| isFit | ComputedRef<boolean> | |
| levels | readonly number[] | |
| mode | ComputedRef<ZoomMode> | |
| reset | () => void | |
| setMode | (mode: ZoomMode | 'auto') => void | |
| setZoom | (zoom: number) => void | |
| zoom | ComputedRef<number> | |
| zoomIn | () => void | |
| zoomOut | () => void |
VerticalRulerPropsinterfaceSource ↗
interface VerticalRulerProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| editable? | boolean | |
| onBottomMarginChange? | (marginTwips: number) => void | |
| onMarginDragEnd? | () => void | |
| onTopMarginChange? | (marginTwips: number) => void | |
| pageSetup? | RulerPageSetup | null | |
| style? | CSSProperties | |
| unit? | 'inch' | 'cm' | |
| zoom? | number |
Type aliases (24)
ChromeTranslatetypeSource ↗
type ChromeTranslate = (key: string, params?: Record<string, string | number>) => string;ContentControlLocktypeSource ↗
type ContentControlLock = 'unlocked' | 'sdtLocked' | 'contentLocked' | 'sdtContentLocked';ContentControlSlotIdtypeSource ↗
type ContentControlSlotId = (typeof CONTENT_CONTROL_SLOTS)[keyof typeof CONTENT_CONTROL_SLOTS];DocxEditorChildrentypeSource ↗
Slot and icon content in public component props.
Vue hosts pass [VNode](VNode). React hosts pass [ReactNode](https://react.dev/reference/react/ReactNode) through the paired [DocxEditorChildren](DocxEditorChildren) alias in @docx-editor.dev/react.
type DocxEditorChildren = VNode;DocxEditorPopuptypeSource ↗
A render callback for an automatically hosted popup. False disables the popup.
type DocxEditorPopup<P extends object> = false | ((props: P) => DocxEditorChildren | null);DocxFontOrigintypeSource ↗
type DocxFontOrigin = FontOrigin | (() => DocxFontsInput | Promise<DocxFontsInput>);DocxFontsInputtypeSource ↗
type DocxFontsInput = FontConfiguration | FontConfigurationFragment;DocxFontsSourcetypeSource ↗
type DocxFontsSource = DocxFontOrigin | readonly DocxFontOrigin[];DocxSourcetypeSource ↗
type DocxSource = string | URL | Uint8Array | ArrayBuffer;EditorModetypeSource ↗
type EditorMode = 'edit' | 'view' | 'suggesting';FontsInputtypeSource ↗
type FontsInput = FontConfiguration | FontConfigurationFragment | FontResolver | Promise<FontConfiguration | FontConfigurationFragment | undefined> | undefined;HeaderFooterStatetypeSource ↗
type HeaderFooterState = Exclude<ReturnType<Editor['getHeaderFooterState']>, null>;HyperlinkPopupModetypeSource ↗
type HyperlinkPopupMode = 'closed' | 'reading' | 'editing';MaybeRefOrGettertypeSource ↗
Reactive input accepted by Vue composables.
type MaybeRefOrGetter<T> = T | Ref<T> | (() => T);MenuIdtypeSource ↗
type MenuId = ChromeMenuId | (string & {});MenuReviewersPropstypeSource ↗
type MenuReviewersProps = {
className?: string;
hidden?: boolean;
};NavigationTabValuetype
type NavigationTab$1 = 'headings' | 'find';NormalizedImagePayloadtypeSource ↗
type NormalizedImagePayload = {
readonly ok: true;
readonly bytes: Uint8Array;
readonly mime: SupportedImageMime;
readonly widthPoints: number;
readonly heightPoints: number;
} | {
readonly ok: false;
readonly reasonKey: string;
};NotePropertiesStatetypeSource ↗
type NotePropertiesState = Exclude<ReturnType<Editor['getNotePropertiesState']>, null>;OutlineHeadingtypeSource ↗
type OutlineHeading$1 = ReturnType<Editor['getOutline']>[number];PaginatedDocxEditorExposetypeSource ↗
Vue name for the same contract React exports as PaginatedDocxEditorExpose.
type PaginatedDocxEditorExpose = PaginatedDocxEditorHandle;ToolbarPartPropstypeSource ↗
type ToolbarPartProps = Omit<ToolbarButtonProps, 'slot'>;ToolbarReviewersPropstypeSource ↗
type ToolbarReviewersProps = {
className?: string;
hidden?: boolean;
icon?: DocxEditorChildren;
};ToolbarTranslatetypeSource ↗
type ToolbarTranslate = (key: string) => string;Variables (99)
CONTENT_CONTROL_SLOTSconstSource ↗
CONTENT_CONTROL_SLOTS: {
readonly showAll: 'contentControl.showAll';
readonly formFill: 'contentControl.formFill';
readonly inspector: 'contentControl.inspector';
readonly remove: 'contentControl.remove';
}ContextMenuCellVerticalAlignmentconstSource ↗
ContextMenuCellVerticalAlignment: vue.DefineComponent<vue.ExtractPropTypes<{
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
hidden: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ContextMenuCopyconstSource ↗
ContextMenuCopy: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuCopyFormattingconstSource ↗
Copy the formatting at the selection — the Format Painter's read half.
Stays available in a read-only document, like Copy: it writes nothing.
ContextMenuCopyFormatting: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuCutconstSource ↗
ContextMenuCut: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuDeleteconstSource ↗
ContextMenuDelete: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuDeleteTableconstSource ↗
ContextMenuDeleteTable: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuDeleteTableColumnconstSource ↗
ContextMenuDeleteTableColumn: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuDeleteTableRowconstSource ↗
ContextMenuDeleteTableRow: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuInsertColumnLeftconstSource ↗
ContextMenuInsertColumnLeft: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuInsertColumnRightconstSource ↗
ContextMenuInsertColumnRight: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuInsertRowAboveconstSource ↗
ContextMenuInsertRowAbove: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuInsertRowBelowconstSource ↗
ContextMenuInsertRowBelow: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
destructive: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
destructive: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuItemconstSource ↗
ContextMenuItem: vue.DefineComponent<vue.ExtractPropTypes<{
label: {
type: StringConstructor;
required: true;
};
icon: {
type: PropType<VNode>;
default: undefined;
};
shortcut: {
type: StringConstructor;
default: undefined;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
disabledReason: {
type: StringConstructor;
default: undefined;
};
active: {
type: BooleanConstructor;
default: undefined;
};
onSelect: {
type: PropType<() => void>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
label: {
type: StringConstructor;
required: true;
};
icon: {
type: PropType<VNode>;
default: undefined;
};
shortcut: {
type: StringConstructor;
default: undefined;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
disabledReason: {
type: StringConstructor;
default: undefined;
};
active: {
type: BooleanConstructor;
default: undefined;
};
onSelect: {
type: PropType<() => void>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
shortcut: string;
disabled: boolean;
disabledReason: string;
active: boolean;
onSelect: () => void;
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ContextMenuPasteconstSource ↗
ContextMenuPaste: vue.DefineComponent<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ContextMenuPasteFormattingconstSource ↗
Apply the copied formatting to the selection.
Disabled with the engine's own reason until something has been copied, so the row says why rather than looking live and doing nothing.
ContextMenuPasteFormatting: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuPasteWithoutFormattingconstSource ↗
Paste the clipboard's plain text as if typed, whatever richer flavours it holds — the Cmd+Shift+V twin as a menu row.
ContextMenuPasteWithoutFormatting: vue.DefineComponent<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ContextMenuRefreshTocconstSource ↗
ContextMenuRefreshToc: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuRefreshTocPageNumbersconstSource ↗
ContextMenuRefreshTocPageNumbers: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}ContextMenuSelectAllconstSource ↗
ContextMenuSelectAll: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
icon: {
type: PropType<VNode>;
default: undefined;
};
labelKey: {
type: StringConstructor;
default: undefined;
};
shortcutKey: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
hidden: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxRow: string;
}DocumentNameconstSource ↗
Deprecated. Use `<DocxEditor>` title props instead.
DocumentName: vue.DefineComponent<vue.ExtractPropTypes<{
value: {
type: StringConstructor;
default: string;
};
onChange: {
type: PropType<(value: string) => void>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
value: {
type: StringConstructor;
default: string;
};
onChange: {
type: PropType<(value: string) => void>;
default: undefined;
};
}>> & Readonly<{}>, {
value: string;
onChange: (value: string) => void;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocumentOutlineconstSource ↗
DocumentOutline: vue.DefineComponent<vue.ExtractPropTypes<{
headings: {
type: PropType<readonly OutlineHeading[]>;
required: true;
};
onHeadingClick: {
type: PropType<(blockId: string) => void>;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
topOffset: {
type: NumberConstructor;
default: number;
};
scrollLeft: {
type: NumberConstructor;
default: number;
};
leftOffset: {
type: NumberConstructor;
default: number;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
headings: {
type: PropType<readonly OutlineHeading[]>;
required: true;
};
onHeadingClick: {
type: PropType<(blockId: string) => void>;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
topOffset: {
type: NumberConstructor;
default: number;
};
scrollLeft: {
type: NumberConstructor;
default: number;
};
leftOffset: {
type: NumberConstructor;
default: number;
};
}>> & Readonly<{}>, {
topOffset: number;
scrollLeft: number;
leftOffset: number;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorconstSource ↗
DocxEditor: DocxEditorNamespaceDocxEditorAuthorStyleconstSource ↗
DocxEditorAuthorStyle: {
new (): {
$props: DocxEditorAuthorStyleProps;
};
}DocxEditorColorByChangeTypeconstSource ↗
DocxEditorColorByChangeType: vue.DefineComponent<{}, () => null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorContentconstSource ↗
DocxEditorContent: vue.DefineComponent<vue.ExtractPropTypes<{
class: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
class: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
class: string;
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorContentControlconstSource ↗
DocxEditorContentControl: DocxEditorContentControlNamespaceDocxEditorContentControlWidgetconstSource ↗
Compact value editor for a configured content-control popup.
DocxEditorContentControlWidget: DocxEditorContentControlWidgetNamespaceDocxEditorContextMenuconstSource ↗
DocxEditorContextMenu: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
t: {
type: PropType<ToolbarTranslate>;
default: undefined;
};
preset: {
type: BooleanConstructor;
default: boolean;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
onOpenChange: {
type: PropType<(open: boolean) => void>;
default: undefined;
};
}>, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
t: {
type: PropType<ToolbarTranslate>;
default: undefined;
};
preset: {
type: BooleanConstructor;
default: boolean;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
onOpenChange: {
type: PropType<(open: boolean) => void>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
t: ToolbarTranslate;
preset: boolean;
disabled: boolean;
onOpenChange: (open: boolean) => void;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorDocumentOutlineconstSource ↗
DocxEditorDocumentOutline: vue.DefineComponent<vue.ExtractPropTypes<{
onClose: {
type: PropType<() => void>;
default: undefined;
};
topOffset: {
type: NumberConstructor;
default: number;
};
leftOffset: {
type: NumberConstructor;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
onClose: {
type: PropType<() => void>;
default: undefined;
};
topOffset: {
type: NumberConstructor;
default: number;
};
leftOffset: {
type: NumberConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
onClose: () => void;
topOffset: number;
leftOffset: number;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorEquationconstSource ↗
Default equation editor mounted by the packaged Vue host.
DocxEditorEquation: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorExportDialogconstSource ↗
Default progress and error dialog for popups.export.
DocxEditorExportDialog: vue.DefineComponent<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
pending: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
format: {
type: PropType<ChromeExportFormat>;
required: true;
};
error: {
type: StringConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
pending: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
format: {
type: PropType<ChromeExportFormat>;
required: true;
};
error: {
type: StringConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorFontNoticeconstSource ↗
DocxEditorFontNotice: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
t: {
type: PropType<TFunction>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
t: {
type: PropType<TFunction>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
t: TFunction;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorHeaderFooterChromeconstSource ↗
Thin overlay while a header or footer scope is open: region label and contextual options.
DocxEditorHeaderFooterChrome: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorHorizontalRulerconstSource ↗
DocxEditorHorizontalRuler: vue.DefineComponent<vue.ExtractPropTypes<{
unit: {
type: PropType<'inch' | 'cm'>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
unit: {
type: PropType<'inch' | 'cm'>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
unit: "cm" | "inch";
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorHyperLinkconstSource ↗
DocxEditorHyperLink: DocxEditorHyperLinkNamespaceDocxEditorImageAltTextPopupconstSource ↗
Packaged image description popup.
DocxEditorImageAltTextPopup: vue.DefineComponent<vue.ExtractPropTypes<{
id: {
type: StringConstructor;
required: true;
};
value: {
type: StringConstructor;
required: true;
};
onValueChange: {
type: PropType<(value: string) => void>;
required: true;
};
onApply: {
type: PropType<() => void>;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
isEnabled: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
anchorRef: PropType<RefObject<HTMLElement | null>>;
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
id: {
type: StringConstructor;
required: true;
};
value: {
type: StringConstructor;
required: true;
};
onValueChange: {
type: PropType<(value: string) => void>;
required: true;
};
onApply: {
type: PropType<() => void>;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
isEnabled: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
anchorRef: PropType<RefObject<HTMLElement | null>>;
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorImagePropertiesDialogconstSource ↗
Properties dialog for the selected picture.
DocxEditorImagePropertiesDialog: vue.DefineComponent<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
triggerRef: {
type: PropType<RefObject<HTMLElement | null>>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
triggerRef: {
type: PropType<RefObject<HTMLElement | null>>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
triggerRef: RefObject<HTMLElement | null>;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorInvalidTextFormFieldDialogconstSource ↗
Default acknowledgement shell for a custom popup renderer.
DocxEditorInvalidTextFormFieldDialog: vue.DefineComponent<vue.ExtractPropTypes<{
session: {
type: PropType<InvalidTextFormFieldSession>;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
session: {
type: PropType<InvalidTextFormFieldSession>;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorLoadingconstSource ↗
DocxEditorLoading: DocxEditorLoadingComponentDocxEditorLoadingSpinnerconstSource ↗
DocxEditorLoadingSpinner: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorMenuconstSource ↗
DocxEditorMenu: DocxEditorMenuNamespaceDocxEditorNavigationconstSource ↗
DocxEditorNavigation: DocxEditorNavigationNamespaceDocxEditorNotePreviewconstSource ↗
Packaged note hover preview.
DocxEditorNotePreview: vue.DefineComponent<vue.ExtractPropTypes<{
scopeId: {
type: StringConstructor;
required: true;
};
text: {
type: StringConstructor;
required: true;
};
x: {
type: NumberConstructor;
required: true;
};
y: {
type: NumberConstructor;
required: true;
};
className: StringConstructor;
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
scopeId: {
type: StringConstructor;
required: true;
};
text: {
type: StringConstructor;
required: true;
};
x: {
type: NumberConstructor;
required: true;
};
y: {
type: NumberConstructor;
required: true;
};
className: StringConstructor;
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorNotePropertiesDialogconstSource ↗
Packaged note properties dialog.
DocxEditorNotePropertiesDialog: vue.DefineComponent<vue.ExtractPropTypes<{
onClose: {
type: PropType<() => void>;
required: true;
};
onApply: {
type: PropType<(command: EditorCommand) => void>;
required: true;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
onClose: {
type: PropType<() => void>;
required: true;
};
onApply: {
type: PropType<(command: EditorCommand) => void>;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorNotesChromeconstSource ↗
DocxEditorNotesChrome: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorNotesContextMenuconstSource ↗
Packaged note context menu.
DocxEditorNotesContextMenu: vue.DefineComponent<vue.ExtractPropTypes<{
scopeId: {
type: StringConstructor;
required: true;
};
noteKind: {
type: PropType<'footnote' | 'endnote'>;
required: true;
};
noteId: {
type: NumberConstructor;
required: true;
};
x: {
type: NumberConstructor;
required: true;
};
y: {
type: NumberConstructor;
required: true;
};
onDelete: {
readonly type: PropType<() => void>;
readonly required: true;
};
onConvert: {
readonly type: PropType<() => void>;
readonly required: true;
};
onConvertAll: {
readonly type: PropType<() => void>;
readonly required: true;
};
onOpenProperties: {
readonly type: PropType<() => void>;
readonly required: true;
};
onClose: {
readonly type: PropType<() => void>;
readonly required: true;
};
deleteEnabled: BooleanConstructor;
convertEnabled: BooleanConstructor;
convertAllEnabled: BooleanConstructor;
deleteDisabledReason: StringConstructor;
convertDisabledReason: StringConstructor;
convertAllDisabledReason: StringConstructor;
className: StringConstructor;
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
scopeId: {
type: StringConstructor;
required: true;
};
noteKind: {
type: PropType<'footnote' | 'endnote'>;
required: true;
};
noteId: {
type: NumberConstructor;
required: true;
};
x: {
type: NumberConstructor;
required: true;
};
y: {
type: NumberConstructor;
required: true;
};
onDelete: {
readonly type: PropType<() => void>;
readonly required: true;
};
onConvert: {
readonly type: PropType<() => void>;
readonly required: true;
};
onConvertAll: {
readonly type: PropType<() => void>;
readonly required: true;
};
onOpenProperties: {
readonly type: PropType<() => void>;
readonly required: true;
};
onClose: {
readonly type: PropType<() => void>;
readonly required: true;
};
deleteEnabled: BooleanConstructor;
convertEnabled: BooleanConstructor;
convertAllEnabled: BooleanConstructor;
deleteDisabledReason: StringConstructor;
convertDisabledReason: StringConstructor;
convertAllDisabledReason: StringConstructor;
className: StringConstructor;
}>> & Readonly<{}>, {
deleteEnabled: boolean;
convertEnabled: boolean;
convertAllEnabled: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorPageNumberconstSource ↗
DocxEditorPageNumber: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorPageSetupDialogconstSource ↗
Customizable Page Setup dialog.
DocxEditorPageSetupDialog: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
className: string;
preset: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
className: string;
preset: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
className: string;
preset: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & Record<"Apply" | "Body" | "Cancel" | "Error" | "Footer" | "Header" | "Title", vue.DefineComponent<DialogPartProps>> & {
Field: vue.DefineComponent<DialogPartProps & {
name: "marginBottom" | "marginLeft" | "marginRight" | "marginTop" | "orientation" | "pageSize" | "scope";
}>;
}DocxEditorParagraphDialogconstSource ↗
Customizable Paragraph dialog.
DocxEditorParagraphDialog: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
className: string;
preset: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
className: string;
preset: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: PropType<CSSProperties>;
preset: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
className: string;
preset: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & Record<"Apply" | "Body" | "Cancel" | "Error" | "Footer" | "Header" | "Title", vue.DefineComponent<DialogPartProps>> & {
Field: vue.DefineComponent<DialogPartProps & {
name: "alignment" | "contextualSpacing" | "direction" | "indentLeft" | "indentRight" | "keepLines" | "keepNext" | "lineRule" | "lineValue" | "pageBreakBefore" | "spaceAfter" | "spaceBefore" | "special" | "specialBy" | "tabStops" | "widowControl";
}>;
}DocxEditorPrintDialogconstSource ↗
Default progress and error dialog for popups.print. The editor closes it when the browser print dialog opens.
DocxEditorPrintDialog: vue.DefineComponent<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
pending: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
error: {
type: StringConstructor;
required: true;
};
url: {
type: StringConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
pending: {
type: BooleanConstructor;
required: true;
};
className: StringConstructor;
style: PropType<CSSProperties>;
children: PropType<DocxEditorChildren>;
error: {
type: StringConstructor;
required: true;
};
url: {
type: StringConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorRootconstSource ↗
DocxEditorRoot: vue.DefineComponent<vue.ExtractPropTypes<{
popups: PropType<DocxEditorPopups>;
document: {
type: PropType<DocumentSource>;
default: undefined;
};
fonts: {
type: PropType<DocxEditorRootProps['fonts']>;
default: undefined;
};
author: {
type: StringConstructor;
default: undefined;
};
locale: {
type: StringConstructor;
default: undefined;
};
translate: {
type: PropType<DocxEditorRootProps['translate']>;
default: undefined;
};
modules: {
type: PropType<readonly EditorModule[]>;
default: undefined;
};
mode: {
type: PropType<'edit' | 'view' | 'suggesting'>;
default: undefined;
};
zoom: {
type: NumberConstructor;
default: undefined;
};
zoomMode: {
type: PropType<ZoomMode | 'auto'>;
default: undefined;
};
tableInteractionLabel: {
type: PropType<DocxEditorRootProps['tableInteractionLabel']>;
default: undefined;
};
imageDecodePort: {
type: PropType<ImageDecodePort>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
ready: (_editor: Editor) => true;
change: (_change: DocumentChange) => true;
fontError: (_error: unknown) => true;
}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
popups: PropType<DocxEditorPopups>;
document: {
type: PropType<DocumentSource>;
default: undefined;
};
fonts: {
type: PropType<DocxEditorRootProps['fonts']>;
default: undefined;
};
author: {
type: StringConstructor;
default: undefined;
};
locale: {
type: StringConstructor;
default: undefined;
};
translate: {
type: PropType<DocxEditorRootProps['translate']>;
default: undefined;
};
modules: {
type: PropType<readonly EditorModule[]>;
default: undefined;
};
mode: {
type: PropType<'edit' | 'view' | 'suggesting'>;
default: undefined;
};
zoom: {
type: NumberConstructor;
default: undefined;
};
zoomMode: {
type: PropType<ZoomMode | 'auto'>;
default: undefined;
};
tableInteractionLabel: {
type: PropType<DocxEditorRootProps['tableInteractionLabel']>;
default: undefined;
};
imageDecodePort: {
type: PropType<ImageDecodePort>;
default: undefined;
};
}>> & Readonly<{
onChange?: ((_change: DocumentChange) => any) | undefined;
onFontError?: ((_error: unknown) => any) | undefined;
onReady?: ((_editor: Editor) => any) | undefined;
}>, {
document: DocumentSource;
fonts: _docx_editor_dev_core.FontConfiguration | _docx_editor_dev_core.FontConfigurationFragment | _docx_editor_dev_core.FontResolver | undefined;
author: string;
locale: string;
translate: ((key: string, params?: Record<string, string | number>) => string) | undefined;
modules: readonly EditorModule[];
mode: "edit" | "suggesting" | "view";
zoom: number;
zoomMode: "auto" | ZoomMode;
tableInteractionLabel: ((key: 'table.insertRowBelow' | 'table.insertColumnRight') => string) | undefined;
imageDecodePort: ImageDecodePort;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorShellconstSource ↗
Deprecated. Use `<DocxEditor>` instead.
DocxEditorShell: DocxEditorNamespaceDocxEditorTextFormFieldDialogconstSource ↗
Customizable legacy text field options.
DocxEditorTextFormFieldDialog: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
session: {
type: PropType<TextFormFieldDialogSession | null>;
default: null;
};
preset: {
type: BooleanConstructor;
default: boolean;
};
className: StringConstructor;
style: PropType<CSSProperties>;
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
session: TextFormFieldDialogSession | null;
preset: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
session: {
type: PropType<TextFormFieldDialogSession | null>;
default: null;
};
preset: {
type: BooleanConstructor;
default: boolean;
};
className: StringConstructor;
style: PropType<CSSProperties>;
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
session: TextFormFieldDialogSession | null;
preset: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
children: PropType<DocxEditorChildren>;
session: {
type: PropType<TextFormFieldDialogSession | null>;
default: null;
};
preset: {
type: BooleanConstructor;
default: boolean;
};
className: StringConstructor;
style: PropType<CSSProperties>;
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
session: TextFormFieldDialogSession | null;
preset: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & Record<"Apply" | "Body" | "Cancel" | "Error" | "Footer" | "Header" | "Title", vue.DefineComponent<DialogPartProps>> & {
Field: vue.DefineComponent<DialogPartProps & {
name: keyof TextFormFieldDialogFields;
}>;
}DocxEditorToolbarconstSource ↗
DocxEditorToolbar: DocxEditorToolbarNamespaceDocxEditorVerticalRulerconstSource ↗
DocxEditorVerticalRuler: vue.DefineComponent<vue.ExtractPropTypes<{
unit: {
type: PropType<'inch' | 'cm'>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
unit: {
type: PropType<'inch' | 'cm'>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
unit: "cm" | "inch";
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorViewportconstSource ↗
DocxEditorViewport: vue.DefineComponent<vue.ExtractPropTypes<{
class: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
class: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
class: string;
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>HorizontalRulerconstSource ↗
HorizontalRuler: vue.DefineComponent<vue.ExtractPropTypes<{
pageSetup: {
type: PropType<RulerPageSetup | null>;
default: null;
};
zoom: {
type: NumberConstructor;
default: number;
};
editable: {
type: BooleanConstructor;
default: boolean;
};
onLeftMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onRightMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onMarginDragEnd: {
type: PropType<() => void>;
default: undefined;
};
showIndentHandles: {
type: BooleanConstructor;
default: boolean;
};
indent: {
type: PropType<RulerIndent | null>;
default: null;
};
indentEditable: {
type: BooleanConstructor;
default: boolean;
};
onIndentChange: {
type: PropType<(indent: RulerIndent) => void>;
default: undefined;
};
onIndentDragEnd: {
type: PropType<() => void>;
default: undefined;
};
unit: {
type: PropType<'inch' | 'cm'>;
default: string;
};
className: {
type: StringConstructor;
default: string;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
tabMarks: {
type: PropType<RulerTabStop[] | null>;
default: null;
};
onTabMarkRemove: {
type: PropType<(positionTwips: number) => void>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
pageSetup: {
type: PropType<RulerPageSetup | null>;
default: null;
};
zoom: {
type: NumberConstructor;
default: number;
};
editable: {
type: BooleanConstructor;
default: boolean;
};
onLeftMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onRightMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onMarginDragEnd: {
type: PropType<() => void>;
default: undefined;
};
showIndentHandles: {
type: BooleanConstructor;
default: boolean;
};
indent: {
type: PropType<RulerIndent | null>;
default: null;
};
indentEditable: {
type: BooleanConstructor;
default: boolean;
};
onIndentChange: {
type: PropType<(indent: RulerIndent) => void>;
default: undefined;
};
onIndentDragEnd: {
type: PropType<() => void>;
default: undefined;
};
unit: {
type: PropType<'inch' | 'cm'>;
default: string;
};
className: {
type: StringConstructor;
default: string;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
tabMarks: {
type: PropType<RulerTabStop[] | null>;
default: null;
};
onTabMarkRemove: {
type: PropType<(positionTwips: number) => void>;
default: undefined;
};
}>> & Readonly<{}>, {
pageSetup: _docx_editor_dev_core.PageSetup | null;
zoom: number;
editable: boolean;
onLeftMarginChange: (marginTwips: number) => void;
onRightMarginChange: (marginTwips: number) => void;
onMarginDragEnd: () => void;
showIndentHandles: boolean;
indent: RulerIndent | null;
indentEditable: boolean;
onIndentChange: (indent: RulerIndent) => void;
onIndentDragEnd: () => void;
unit: "cm" | "inch";
className: string;
style: CSSProperties;
tabMarks: RulerTabStop[] | null;
onTabMarkRemove: (positionTwips: number) => void;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ImageAltTextconstSource ↗
ImageAltText: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
hidden: boolean;
asChild: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ImageInsertProviderconstSource ↗
ImageInsertProvider: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[], {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ImageInsertTriggerconstSource ↗
ImageInsertTrigger: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
hidden: boolean;
asChild: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ImagePropertiesTriggerconstSource ↗
Opens the image properties dialog for the selected drawing.
ImagePropertiesTrigger: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
hidden: boolean;
asChild: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ImageWrapconstSource ↗
ImageWrap: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
hidden: boolean;
asChild: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>LocaleProviderconstSource ↗
LocaleProvider: vue.DefineComponent<vue.ExtractPropTypes<{
i18n: {
type: PropType<Translations>;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[] | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
i18n: {
type: PropType<Translations>;
default: undefined;
};
}>> & Readonly<{}>, {
i18n: _docx_editor_dev_i18n.PartialLocaleStrings;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>LogoconstSource ↗
Deprecated. Use `<DocxEditor>` title slots instead.
Logo: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>MenuBarconstSource ↗
Deprecated. Use `<DocxEditor.Menu>` instead.
MenuBar: DocxEditorMenuNamespaceNAVIGATION_PANE_GAPconstSource ↗
Clearance kept between the panel's right edge and the page.
NAVIGATION_PANE_GAP = 16NAVIGATION_PANE_INSETconstSource ↗
Gap between the viewport's left edge and the panel.
Clears a vertical ruler: RULER_WIDTH is 20px pinned at the viewport's left edge, so anything less puts the panel and its collapsed disc on top of the tick marks.
NAVIGATION_PANE_INSET = 32NAVIGATION_PANE_WIDTHconstSource ↗
Panel width, in px, when the host does not choose one.
NAVIGATION_PANE_WIDTH = 280NavigationCloseconstSource ↗
NavigationClose: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationFindconstSource ↗
NavigationFind: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationHeaderconstSource ↗
NavigationHeader: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationHeadingsconstSource ↗
NavigationHeadings: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationTabconstSource ↗
NavigationTab: vue.DefineComponent<vue.ExtractPropTypes<{
value: {
type: PropType<NavigationTab$1>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
value: {
type: PropType<NavigationTab$1>;
required: true;
};
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationTabsconstSource ↗
NavigationTabs: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationTitleconstSource ↗
NavigationTitle: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>NavigationToggleconstSource ↗
NavigationToggle: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>OUTLINE_BUTTON_LEFT_OFFSETconstSource ↗
OUTLINE_BUTTON_LEFT_OFFSET = 12OUTLINE_BUTTON_RESERVED_SPACEconstSource ↗
OUTLINE_BUTTON_RESERVED_SPACE: numberOUTLINE_LEFT_OFFSETconstSource ↗
OUTLINE_LEFT_OFFSET = 12OUTLINE_RESERVED_SPACEconstSource ↗
OUTLINE_RESERVED_SPACE: numberPageIndicatorconstSource ↗
PageIndicator: vue.DefineComponent<vue.ExtractPropTypes<{
currentPage: {
type: NumberConstructor;
required: true;
};
totalPages: {
type: NumberConstructor;
required: true;
};
visible: {
type: BooleanConstructor;
required: true;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
currentPage: {
type: NumberConstructor;
required: true;
};
totalPages: {
type: NumberConstructor;
required: true;
};
visible: {
type: BooleanConstructor;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>PageNumberTranslationContextconstSource ↗
Internal bridge from the batteries-included editor's t prop to this composition part.
PageNumberTranslationContext: InjectionKey<((key: string) => string) | null>PaginatedDocxEditorconstSource ↗
PaginatedDocxEditor: vue.DefineComponent<vue.ExtractPropTypes<{
source: {
type: PropType<Uint8Array>;
required: true;
};
scale: {
type: NumberConstructor;
default: undefined;
};
measurer: {
type: PropType<TextMeasurer>;
default: undefined;
};
onStateChange: {
type: PropType<(state: PaginatedSurfaceState) => void>;
default: undefined;
};
onError: {
type: PropType<(reason: string, detail?: string) => void>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
documentFontFamily: {
type: StringConstructor;
default: undefined;
};
}>, () => VNode, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
source: {
type: PropType<Uint8Array>;
required: true;
};
scale: {
type: NumberConstructor;
default: undefined;
};
measurer: {
type: PropType<TextMeasurer>;
default: undefined;
};
onStateChange: {
type: PropType<(state: PaginatedSurfaceState) => void>;
default: undefined;
};
onError: {
type: PropType<(reason: string, detail?: string) => void>;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
documentFontFamily: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
scale: number;
measurer: TextMeasurer;
onStateChange: (state: PaginatedSurfaceState) => void;
onError: (reason: string, detail?: string) => void;
className: string;
documentFontFamily: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>PaginatedDocxEditorShellconstSource ↗
Deprecated. Use `<DocxEditor>` from the composition layer instead.
PaginatedDocxEditorShell: vue.DefineComponent<vue.ExtractPropTypes<{
source: {
type: PropType<Uint8Array>;
required: true;
};
documentName: {
type: StringConstructor;
default: undefined;
};
scale: {
type: NumberConstructor;
default: undefined;
};
measurer: {
type: PropType<TextMeasurer>;
default: undefined;
};
onStateChange: {
type: PropType<(state: PaginatedSurfaceState) => void>;
default: undefined;
};
onError: {
type: PropType<(reason: string, detail?: string) => void>;
default: undefined;
};
onSave: {
type: PropType<(bytes: Uint8Array) => void>;
default: undefined;
};
colorMode: {
type: PropType<'light' | 'dark'>;
default: undefined;
};
onZoomChange: {
type: PropType<(zoom: number) => void>;
default: undefined;
};
documentFontFamily: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
source: {
type: PropType<Uint8Array>;
required: true;
};
documentName: {
type: StringConstructor;
default: undefined;
};
scale: {
type: NumberConstructor;
default: undefined;
};
measurer: {
type: PropType<TextMeasurer>;
default: undefined;
};
onStateChange: {
type: PropType<(state: PaginatedSurfaceState) => void>;
default: undefined;
};
onError: {
type: PropType<(reason: string, detail?: string) => void>;
default: undefined;
};
onSave: {
type: PropType<(bytes: Uint8Array) => void>;
default: undefined;
};
colorMode: {
type: PropType<'light' | 'dark'>;
default: undefined;
};
onZoomChange: {
type: PropType<(zoom: number) => void>;
default: undefined;
};
documentFontFamily: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
documentName: string;
scale: number;
measurer: TextMeasurer;
onStateChange: (state: PaginatedSurfaceState) => void;
onError: (reason: string, detail?: string) => void;
onSave: (bytes: Uint8Array) => void;
colorMode: "dark" | "light";
onZoomChange: (zoom: number) => void;
documentFontFamily: string;
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>REVIEW_MARKERS_GUTTERconstSource ↗
Reservation for markers and the add-comment button.
REVIEW_MARKERS_GUTTER = 44REVIEW_PANE_GUTTERconstSource ↗
Full reservation for the card column and page-edge gap.
REVIEW_PANE_GUTTER = 316ReviewRailContextconstSource ↗
ReviewRailContext: InjectionKey<ShallowRef<ReviewRailRegistry>>RULER_WIDTHconstSource ↗
RULER_WIDTH = 20SlotconstSource ↗
Renders its single child vnode with the slot props merged in.
Slot: vue.DefineComponent<{}, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>TitleBarconstSource ↗
Deprecated. Use `<DocxEditor>` title slots instead.
TitleBar: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>TitleBarRightconstSource ↗
Deprecated. Use `<DocxEditor>` title slots instead.
TitleBarRight: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ToolbarconstSource ↗
Deprecated. Use `DocxEditor.Toolbar` from the composition layer instead.
Toolbar: vue.DefineComponent<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ToolbarButtonconstSource ↗
Deprecated. Use `DocxEditor.Toolbar` button parts instead.
ToolbarButton: vue.DefineComponent<vue.ExtractPropTypes<{
active: {
type: BooleanConstructor;
default: undefined;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
title: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
ariaLabel: {
type: StringConstructor;
default: undefined;
};
}>, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "click"[], "click", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
active: {
type: BooleanConstructor;
default: undefined;
};
disabled: {
type: BooleanConstructor;
default: undefined;
};
title: {
type: StringConstructor;
default: undefined;
};
className: {
type: StringConstructor;
default: undefined;
};
ariaLabel: {
type: StringConstructor;
default: undefined;
};
}>> & Readonly<{
onClick?: ((...args: any[]) => any) | undefined;
}>, {
active: boolean;
disabled: boolean;
title: string;
className: string;
ariaLabel: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ToolbarContextconstSource ↗
ToolbarContext: InjectionKey<MaybeRef<ToolbarContextValue>>ToolbarGroupconstSource ↗
Deprecated. Use `DocxEditor.Toolbar` group parts instead.
ToolbarGroup: vue.DefineComponent<{}, () => VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>ToolbarImagePropertiesconstSource ↗
ToolbarImageProperties: {
new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
className: string;
hidden: boolean;
asChild: boolean;
}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, {
className: string;
hidden: boolean;
asChild: boolean;
}>;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
className: {
type: StringConstructor;
default: undefined;
};
hidden: {
type: BooleanConstructor;
default: undefined;
};
asChild: {
type: BooleanConstructor;
default: undefined;
};
}>> & Readonly<{}>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
className: string;
hidden: boolean;
asChild: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
docxSlot: 'image.properties';
}VERSIONconstSource ↗
VERSION: stringVerticalRulerconstSource ↗
VerticalRuler: vue.DefineComponent<vue.ExtractPropTypes<{
pageSetup: {
type: PropType<RulerPageSetup | null>;
default: null;
};
zoom: {
type: NumberConstructor;
default: number;
};
editable: {
type: BooleanConstructor;
default: boolean;
};
onTopMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onBottomMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onMarginDragEnd: {
type: PropType<() => void>;
default: undefined;
};
unit: {
type: PropType<'inch' | 'cm'>;
default: string;
};
className: {
type: StringConstructor;
default: string;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>, () => vue_jsx_runtime.JSX.Element, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
pageSetup: {
type: PropType<RulerPageSetup | null>;
default: null;
};
zoom: {
type: NumberConstructor;
default: number;
};
editable: {
type: BooleanConstructor;
default: boolean;
};
onTopMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onBottomMarginChange: {
type: PropType<(marginTwips: number) => void>;
default: undefined;
};
onMarginDragEnd: {
type: PropType<() => void>;
default: undefined;
};
unit: {
type: PropType<'inch' | 'cm'>;
default: string;
};
className: {
type: StringConstructor;
default: string;
};
style: {
type: PropType<CSSProperties>;
default: undefined;
};
}>> & Readonly<{}>, {
pageSetup: _docx_editor_dev_core.PageSetup | null;
zoom: number;
editable: boolean;
onTopMarginChange: (marginTwips: number) => void;
onBottomMarginChange: (marginTwips: number) => void;
onMarginDragEnd: () => void;
unit: "cm" | "inch";
className: string;
style: CSSProperties;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>