@docx-editor.dev/vue
v2.6.1 · 1 published subpath with full TypeScript signatures and JSDoc.
Package root
Functions (43)
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;useContextMenuTargetfunctionSource ↗
declare function useContextMenuTarget(): HTMLElement | null;useDocumentOutlinefunctionSource ↗
declare function useDocumentOutline(): UseDocumentOutlineResult;useDocumentSearchfunctionSource ↗
declare function useDocumentSearch(): 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 ↗
declare function useEditorValueCommand(slotId: 'image.wrap'): EditorValueCommandState<ImageWrapTarget>;useEditorValueCommandfunctionSource ↗
declare function useEditorValueCommand(slotId: 'image.altText'): EditorValueCommandState<string>;useFontFamilyfunctionSource ↗
declare function useFontFamily(): UseFontFamilyResult;useFontsfunctionSource ↗
declare function useFonts(source: MaybeRefOrGetter<FontsInput>, ...fragments: readonly MaybeRefOrGetter<FontConfigurationFragment | undefined>[]): FontResolver;useHeaderFooterStatefunctionSource ↗
declare function useHeaderFooterState(): ShallowRef<HeaderFooterState | null>;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;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>;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 (115)
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. |
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 |
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 |
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 | |
| 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 |
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 |
DocxEditorImagePropertiesDialogPropsinterfaceSource ↗
Props for DocxEditor.ImagePropertiesDialog.
interface DocxEditorImagePropertiesDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| onClose | () => void | |
| open | boolean | |
| triggerRef? | RefObject<HTMLElement | null> |
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 | |
| File | MenuPartComponent | |
| Format | MenuPartComponent | |
| Group | typeof MenuGroup | |
| Help | MenuPartComponent | |
| Insert | MenuPartComponent | |
| Item | typeof MenuItem | |
| Menu | typeof Menu | |
| Open | typeof MenuOpen | |
| PageSetup | typeof MenuPageSetup | |
| ReportIssue | typeof MenuReportIssue | |
| 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 | |
| fileName? | string | |
| onOpen? | () => void | |
| onOpenFile? | (file: File) => void | |
| onPageSetup? | () => void | |
| 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 | |
| ContextMenu | typeof ContextMenu | |
| DocumentOutline | typeof DocxEditorDocumentOutline | |
| FontNotice | typeof DocxEditorFontNotice | |
| HeaderFooterChrome | typeof DocxEditorHeaderFooterChrome | |
| HorizontalRuler | typeof DocxEditorHorizontalRuler | |
| HyperLink | typeof DocxEditorHyperLink | |
| Loading | typeof DocxEditorLoading | |
| Menu | typeof DocxEditorMenu | |
| Navigation | typeof Navigation | |
| NotesChrome | typeof DocxEditorNotesChrome | |
| PageNumber | typeof DocxEditorPageNumber | |
| PageSetupDialog | typeof DocxEditorPageSetupDialog | |
| Root | typeof DocxEditorRoot | |
| 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 | |
| style? | CSSProperties | |
| t? | (key: string, params?: Record<string, string | number>) => string | |
| toggle? | boolean | NavigationPartProps |
DocxEditorNotesChromePropsinterfaceSource ↗
interface DocxEditorNotesChromeProps| Member | Type | Summary |
|---|---|---|
| className? | string |
DocxEditorPageNumberPropsinterfaceSource ↗
Props for DocxEditor.PageNumber.
interface DocxEditorPageNumberProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| style? | CSSProperties |
DocxEditorPageSetupDialogPropsinterfaceSource ↗
interface DocxEditorPageSetupDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| onClose | () => void | |
| open | boolean |
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 | |
| menu? | boolean | DocxEditorMenuProps | |
| mode? | EditorMode | |
| modules? | readonly EditorModule[] | |
| navigation? | boolean | |
| rulers? | boolean | |
| t? | (key: string, params?: Record<string, string | number>) => string | |
| 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 | |
| children? | DocxEditorChildren | |
| document? | DocumentSource | |
| fonts? | FontConfiguration | FontConfigurationFragment | FontResolver | |
| imageDecodePort? | ImageDecodePort | |
| locale? | string | |
| mode? | 'edit' | 'view' | 'suggesting' | |
| modules? | readonly EditorModule[] | |
| onChange? | (change: DocumentChange) => void | |
| onFontError? | (error: EditorFontError) => void | |
| onReady? | (editor: Editor) => void | |
| tableInteractionLabel? | (key: 'table.insertRowBelow' | 'table.insertColumnRight') => string | |
| translate? | (key: string, params?: Record<string, string | number>) => string | |
| zoom? | number | |
| zoomMode? | ZoomMode | 'auto' |
DocxEditorRulerPropsinterfaceSource ↗
interface DocxEditorRulerProps| Member | Type | Summary |
|---|---|---|
| className? | string | |
| style? | CSSProperties | |
| unit? | 'inch' | 'cm' |
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 | |
| LineSpacing | ToolbarSlotPartComponent | |
| Link | ToolbarPartComponent | |
| NumberedList | ToolbarPartComponent | |
| Outdent | ToolbarPartComponent | |
| Redo | 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 | () => boolean | |
| isActive | ComputedRef<boolean> | |
| isEnabled | ComputedRef<boolean> |
EditorValueCommandStateinterfaceSource ↗
interface EditorValueCommandState<T extends string | number>| Member | Type | Summary |
|---|---|---|
| disabledReason | ComputedRef<string | null> | |
| execute | (value: T) => void | |
| 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 four 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 |
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 | | |
| sectionProperties | | |
| selectAll | | |
| setParagraphProperty | | |
| 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 |
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 |
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> |
UseDocumentSearchResultinterfaceSource ↗
interface UseDocumentSearchResult| Member | Type | Summary |
|---|---|---|
| activeIndex | ComputedRef<number> | |
| clear | () => void | |
| goTo | (index: number) => void | |
| isPending | ComputedRef<boolean> | |
| matchCase | ComputedRef<boolean> | |
| matches | ComputedRef<readonly TextMatch[]> | |
| next | () => void | |
| previous | () => void | |
| query | ComputedRef<string> | |
| setMatchCase | (value: boolean) => void | |
| setQuery | (query: string) => void | |
| setWholeWord | (value: boolean) => void | |
| truncated | ComputedRef<boolean> | |
| 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 | 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> |
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 |
UsePageSetupReturninterfaceSource ↗
interface UsePageSetupReturn| Member | Type | Summary |
|---|---|---|
| apply | (update: PageSetupUpdate) => boolean | |
| isEnabled | ComputedRef<boolean> | |
| pageSetup | ComputedRef<PageSetup | null> |
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> |
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 (20)
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;DocxFontsInputtypeSource ↗
type DocxFontsInput = FontConfiguration | FontConfigurationFragment;DocxFontsSourcetypeSource ↗
type DocxFontsSource = DocxFontsInput | Promise<DocxFontsInput> | (() => DocxFontsInput | Promise<DocxFontsInput>);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 & {});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'>;ToolbarTranslatetypeSource ↗
type ToolbarTranslate = (key: string) => string;Variables (87)
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
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<{}>, {
disabledReason: string;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
active: boolean;
disabled: boolean;
className: string;
onSelect: () => void;
shortcut: 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<{}>, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, {}, {}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
className: string;
}, {}, 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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, 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, {}, {}, {}, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}>;
__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, {
hidden: boolean;
icon: VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>;
labelKey: string;
shortcutKey: string;
className: string;
}, {}, 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: DocxEditorContentControlNamespaceDocxEditorContextMenuconstSource ↗
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<{}>, {
t: ToolbarTranslate;
disabled: boolean;
className: string;
preset: 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>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<{}>, {
t: TFunction;
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
unit: "cm" | "inch";
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorHyperLinkconstSource ↗
DocxEditorHyperLink: DocxEditorHyperLinkNamespaceDocxEditorImagePropertiesDialogconstSource ↗
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>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: DocxEditorNavigationNamespaceDocxEditorNotesChromeconstSource ↗
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>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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorPageSetupDialogconstSource ↗
DocxEditorPageSetupDialog: vue.DefineComponent<vue.ExtractPropTypes<{
open: {
type: BooleanConstructor;
required: true;
};
onClose: {
type: PropType<() => void>;
required: true;
};
className: {
type: StringConstructor;
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;
};
}>> & Readonly<{}>, {
className: string;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorRootconstSource ↗
DocxEditorRoot: vue.DefineComponent<vue.ExtractPropTypes<{
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<{
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;
onReady?: ((_editor: Editor) => any) | undefined;
onFontError?: ((_error: unknown) => any) | undefined;
}>, {
document: DocumentSource;
locale: string;
zoom: number;
fonts: _docx_editor_dev_core.FontConfiguration | _docx_editor_dev_core.FontConfigurationFragment | _docx_editor_dev_core.FontResolver | undefined;
author: string;
mode: "suggesting" | "edit" | "view";
imageDecodePort: ImageDecodePort;
translate: ((key: string, params?: Record<string, string | number>) => string) | undefined;
modules: readonly EditorModule[];
tableInteractionLabel: ((key: "table.insertRowBelow" | "table.insertColumnRight") => string) | undefined;
zoomMode: "auto" | ZoomMode;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>DocxEditorShellconstSource ↗
Deprecated. Use `<DocxEditor>` instead.
DocxEditorShell: DocxEditorNamespaceDocxEditorToolbarconstSource ↗
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<{}>, {
style: CSSProperties;
className: string;
unit: "cm" | "inch";
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
class: string;
className: string;
}, {}, {}, {}, 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<{}>, {
zoom: number;
pageSetup: _docx_editor_dev_core.PageSetup | null;
style: CSSProperties;
indent: RulerIndent | null;
editable: boolean;
className: string;
onLeftMarginChange: (marginTwips: number) => void;
onRightMarginChange: (marginTwips: number) => void;
onMarginDragEnd: () => void;
showIndentHandles: boolean;
indentEditable: boolean;
onIndentChange: (indent: RulerIndent) => void;
onIndentDragEnd: () => void;
unit: "cm" | "inch";
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<{}>, {
hidden: boolean;
className: string;
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<{}>, {
hidden: boolean;
className: string;
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<{}>, {
hidden: boolean;
className: string;
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<{}>, {
hidden: boolean;
className: string;
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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
style: CSSProperties;
className: string;
}, {}, {}, {}, 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<{}>, {
measurer: TextMeasurer;
scale: number;
className: string;
onError: (reason: string, detail?: string) => void;
onStateChange: (state: PaginatedSurfaceState) => void;
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<{}>, {
measurer: TextMeasurer;
scale: number;
className: string;
onError: (reason: string, detail?: string) => void;
onSave: (bytes: Uint8Array) => void;
colorMode: "light" | "dark";
onStateChange: (state: PaginatedSurfaceState) => void;
documentFontFamily: string;
documentName: string;
onZoomChange: (zoom: number) => void;
}, {}, {}, {}, 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 = 20SEARCH_DEBOUNCE_MSconstSource ↗
SEARCH_DEBOUNCE_MS = 150SEARCH_MATCH_LIMITconstSource ↗
SEARCH_MATCH_LIMIT = 2000SlotconstSource ↗
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;
}>, {
ariaLabel: string;
title: string;
active: boolean;
disabled: boolean;
className: 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, {
hidden: boolean;
className: string;
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, {}, {}, {}, {
hidden: boolean;
className: string;
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, {
hidden: boolean;
className: string;
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<{}>, {
zoom: number;
pageSetup: _docx_editor_dev_core.PageSetup | null;
style: CSSProperties;
editable: boolean;
className: string;
onMarginDragEnd: () => void;
unit: "cm" | "inch";
onTopMarginChange: (marginTwips: number) => void;
onBottomMarginChange: (marginTwips: number) => void;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>