vue - pro | DOCX Editor

Compound part overrides (List, Card, Accept, …) match the React export names and mount when passed as slots; the preset arrangement is the default when no slot overrides are supplied. Full asChild merge semantics follow the React ladder and are typed on each part export for hosts that replace individual pieces.

Functions (9)

`activatedCustomNodeOf`functionSource ↗

Resolves the host-facing custom-node activation payload.

declare function activatedCustomNodeOf(resolved: ResolvedCustomNodeActivation, editor: Editor | null | undefined): ActivatedCustomNode | null;

`resolveCustomNodeActivation`functionSource ↗

Resolves a painted pointer target to a registered custom-node definition.

declare function resolveCustomNodeActivation(target: EventTarget | null, nodes: readonly AnyCustomNodeDefinition[]): ResolvedCustomNodeActivation | null;

`reviewModule`functionSource ↗

Build the review module. Construction never validates the key and never touches the network.

declare function reviewModule(options?: ReviewModuleOptions): EditorModule;

`useCustomNodeDefinitions`functionSource ↗

Returns custom-node definitions from a prop or the mounted editor.

declare function useCustomNodeDefinitions(nodes?: MaybeRefOrGetter$1<readonly AnyCustomNodeDefinition[] | undefined>): ComputedRef<readonly AnyCustomNodeDefinition[]>;

`useReview`functionSource ↗

declare function useReview(query?: MaybeRefOrGetter<ReviewItemQuery | undefined>): UseReviewReturn;

`useReviewAuthor`functionSource ↗

Returns the resolved color, slot, and declared style for one review author.

The result updates when the author or revision style declarations change.

declare function useReviewAuthor(author: MaybeRefOrGetter$1<string | undefined>): ComputedRef<ReviewAuthorInfo | undefined>;

`useReviewItem`functionSource ↗

declare function useReviewItem(): ComputedRef<ReviewItemView | null>;

`useReviewOf`functionSource ↗

declare function useReviewOf(editorRef: Ref<Editor | null>, query?: MaybeRefOrGetter<ReviewItemQuery | undefined>): UseReviewReturn;

`useStackedReviewPositions`functionSource ↗

declare function useStackedReviewPositions(items: MaybeRefOrGetter<readonly {
    readonly key: string;
    readonly anchorY: number | null;
}[]>, heights: MaybeRefOrGetter<ReadonlyMap<string, number>>, options?: MaybeRefOrGetter<{
    readonly gap?: number;
    readonly scale?: number;
    readonly defaultHeight?: number;
}>): ComputedRef<ReadonlyMap<string, number>>;

Interfaces (11)

`CustomNodeChromeProps`interfaceSource ↗

Props for custom-node chip colors and pointer activation.

interface CustomNodeChromeProps

Member	Type	Summary
nodes?	`readonly CustomNodeDefinition[]`	Definitions to style. Defaults to definitions registered on the editor.
onNodeClick?	`(node: ActivatedCustomNode) => void`	Receives primary-button activation after the definition's own hook.
onNodeHover?	`(node: ActivatedCustomNode) => void`	Receives pointer-entry activation after the definition's own hook.

`CustomNodeContextMenuProps`interfaceSource ↗

Props for the custom-node context-menu section.

interface CustomNodeContextMenuProps

Member	Type	Summary
nodes?	`readonly CustomNodeDefinition[]`	Definitions to offer. Defaults to definitions registered on the editor.
onEditNode?	`(node: ActivatedCustomNode, definition: CustomNodeDefinition) => void`	Runs after the definition's own edit hook.
onRemoveRefused?	`(node: ActivatedCustomNode, reason: string) => void`	Receives the engine reason when removal is refused.
remove?	`boolean`	Adds the remove row. Defaults to `true`.

`ProLicenseOptions`interfaceSource ↗

Accepted by every pro entry point.

interface ProLicenseOptions

Member	Type	Summary
licenseKey?	`string`	Your license key from docx-editor.dev. Optional in v1: unlicensed use in development and evaluation is permitted, production use requires a license (see LICENSE.md) — the package trusts you either way.

`ResolvedCustomNodeActivation`interfaceSource ↗

A custom-node definition and decoded node under a pointer target.

interface ResolvedCustomNodeActivation

Member	Type	Summary
controlId	`string \| null`
definition	`AnyCustomNodeDefinition`
node	`ActivatedCustomNode`

`ReviewActionProps`interfaceSource ↗

interface ReviewActionProps extends ReviewPartProps

Member	Type	Summary
icon?	`VNode \| string`

`ReviewActivationOptions`interface

How activating a review item places it in the viewport.

interface ReviewActivationOptions

Member	Type	Summary
reveal?	`'start' \| 'center' \| 'centerIfNeeded' \| 'nearest' \| false`	Where the item lands, or `false` to open it without scrolling at all.

`ReviewMarkersProps`interfaceSource ↗

interface ReviewMarkersProps extends ReviewPartProps

Member	Type	Summary
icon?	`VNode \| ((item: ReviewItemView) => VNode \| null \| undefined)`
offset?	`number`
scale?	`number`
window?	`{ top: number; bottom: number; } \| null`

`ReviewModuleOptions`interfaceSource ↗

How [reviewModule](reviewModule) is configured. Carries only the licence key today, so reviewModule() with no argument is the ordinary call.

interface ReviewModuleOptions extends ProLicenseOptions

`ReviewPartProps`interfaceSource ↗

interface ReviewPartProps

Member	Type	Summary
asChild?	`boolean`
children?	`VNode \| VNode[]`
className?	`string`
hidden?	`boolean`

`ReviewProps`interfaceSource ↗

interface ReviewProps extends Omit<ReviewPartProps, 'children' | 'hidden'>

Member	Type	Summary
card?	`{ className?: string; }`
children?	`VNode \| VNode[]`	Scoped slot for custom card render: `#default="{ item }"`.
filter?	`(item: ReviewItemView) => boolean`
formatting?	`boolean`
furniture?	`VNode \| VNode[]`
gap?	`number`
hidden?	`boolean`
preset?	`boolean`
stack?	`boolean`
structural?	`boolean`
t?	`(key: string, params?: Record<string, string \| number>) => string`

`UseReviewReturn`interfaceSource ↗

interface UseReviewReturn

Member	Type	Summary
accept	`(item: ReviewItemView) => boolean`
activeKey	`ComputedRef<string \| null>`
comment	`(text: string, author?: string) => boolean`
commentResolutionDisabledReason	`ComputedRef<string \| null>`
items	`ComputedRef<readonly ReviewItemView[]>`
paneOpen	`ComputedRef<boolean>`
ready	`ComputedRef<boolean>`
reject	`(item: ReviewItemView) => boolean`
remove	`(item: ReviewItemView) => boolean`
reopen	`(item: ReviewItemView) => boolean`
reply	`(item: ReviewItemView, text: string, author?: string) => boolean`
resolve	`(item: ReviewItemView) => boolean`
selectionAnchorY	`ComputedRef<number \| null>`
setActive	`(key: string \| null, options?: ReviewActivationOptions) => boolean`
setPaneOpen	`(open: boolean) => void`

Type aliases (2)

`DocxEditorReviewNamespace`typeSource ↗

type DocxEditorReviewNamespace = typeof DocxEditorReview;

`ReviewItemView`typeSource ↗

type ReviewItemView = ReviewItemPlacement;

Variables (3)

`CustomNodeChrome`constSource ↗

Applies custom-node chip colors and dispatches click and hover activation.

Mount this component once inside DocxEditorRoot. It renders no element.

CustomNodeChrome: {
    new (): {
        $props: CustomNodeChromeProps;
    };
}

`CustomNodeContextMenu`constSource ↗

Adds custom-node information, edit, and remove rows to the context menu.

Place this component inside DocxEditorContextMenu.

CustomNodeContextMenu: {
    readonly docxRowPlacement: "start";
    new (): {
        $props: CustomNodeContextMenuProps;
    };
}

`DocxEditorReview`constSource ↗

DocxEditorReview: {
    new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        t: {
            type: PropType<(key: string, params?: Record<string, string | number>) => string>;
            default: undefined;
        };
        card: {
            type: PropType<{
                className?: string;
            }>;
            default: undefined;
        };
        furniture: {
            type: PropType<VNode | VNode[]>;
            default: undefined;
        };
        preset: {
            type: BooleanConstructor;
            default: boolean;
        };
        stack: {
            type: BooleanConstructor;
            default: boolean;
        };
        gap: {
            type: NumberConstructor;
            default: number;
        };
        filter: {
            type: PropType<(item: ReviewItemView) => boolean>;
            default: undefined;
        };
        structural: {
            type: BooleanConstructor;
            default: boolean;
        };
        formatting: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{}>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {
        filter: (item: ReviewItemView) => boolean;
        hidden: boolean;
        t: (key: string, params?: Record<string, string | number>) => string;
        structural: boolean;
        furniture: VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }> | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>[];
        formatting: boolean;
        asChild: boolean;
        gap: number;
        preset: boolean;
        card: {
            className?: string;
        };
        stack: boolean;
    }, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
        P: {};
        B: {};
        D: {};
        C: {};
        M: {};
        Defaults: {};
    }, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        t: {
            type: PropType<(key: string, params?: Record<string, string | number>) => string>;
            default: undefined;
        };
        card: {
            type: PropType<{
                className?: string;
            }>;
            default: undefined;
        };
        furniture: {
            type: PropType<VNode | VNode[]>;
            default: undefined;
        };
        preset: {
            type: BooleanConstructor;
            default: boolean;
        };
        stack: {
            type: BooleanConstructor;
            default: boolean;
        };
        gap: {
            type: NumberConstructor;
            default: number;
        };
        filter: {
            type: PropType<(item: ReviewItemView) => boolean>;
            default: undefined;
        };
        structural: {
            type: BooleanConstructor;
            default: boolean;
        };
        formatting: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{}>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, {
        filter: (item: ReviewItemView) => boolean;
        hidden: boolean;
        t: (key: string, params?: Record<string, string | number>) => string;
        structural: boolean;
        furniture: VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }> | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>[];
        formatting: boolean;
        asChild: boolean;
        gap: number;
        preset: boolean;
        card: {
            className?: string;
        };
        stack: boolean;
    }>;
    __isFragment?: never;
    __isTeleport?: never;
    __isSuspense?: never;
} & vue.ComponentOptionsBase<Readonly<vue.ExtractPropTypes<{
    className: StringConstructor;
    asChild: BooleanConstructor;
    hidden: BooleanConstructor;
    t: {
        type: PropType<(key: string, params?: Record<string, string | number>) => string>;
        default: undefined;
    };
    card: {
        type: PropType<{
            className?: string;
        }>;
        default: undefined;
    };
    furniture: {
        type: PropType<VNode | VNode[]>;
        default: undefined;
    };
    preset: {
        type: BooleanConstructor;
        default: boolean;
    };
    stack: {
        type: BooleanConstructor;
        default: boolean;
    };
    gap: {
        type: NumberConstructor;
        default: number;
    };
    filter: {
        type: PropType<(item: ReviewItemView) => boolean>;
        default: undefined;
    };
    structural: {
        type: BooleanConstructor;
        default: boolean;
    };
    formatting: {
        type: BooleanConstructor;
        default: boolean;
    };
}>> & Readonly<{}>, () => VNode<vue.RendererNode, vue.RendererElement, {
    [key: string]: any;
}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {
    filter: (item: ReviewItemView) => boolean;
    hidden: boolean;
    t: (key: string, params?: Record<string, string | number>) => string;
    structural: boolean;
    furniture: VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }>[];
    formatting: boolean;
    asChild: boolean;
    gap: number;
    preset: boolean;
    card: {
        className?: string;
    };
    stack: boolean;
}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
    List: vue.DefineComponent<vue.ExtractPropTypes<{
        stack: {
            type: BooleanConstructor;
            default: boolean;
        };
        positions: {
            type: PropType<ReadonlyMap<string, number>>;
            default: undefined;
        };
        collapsed: {
            type: PropType<ReadonlySet<string>>;
            default: undefined;
        };
        scale: {
            type: NumberConstructor;
            default: number;
        };
        offset: {
            type: NumberConstructor;
            default: number;
        };
        window: {
            type: PropType<{
                top: number;
                bottom: number;
            } | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        stack: {
            type: BooleanConstructor;
            default: boolean;
        };
        positions: {
            type: PropType<ReadonlyMap<string, number>>;
            default: undefined;
        };
        collapsed: {
            type: PropType<ReadonlySet<string>>;
            default: undefined;
        };
        scale: {
            type: NumberConstructor;
            default: number;
        };
        offset: {
            type: NumberConstructor;
            default: number;
        };
        window: {
            type: PropType<{
                top: number;
                bottom: number;
            } | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        offset: number;
        window: {
            top: number;
            bottom: number;
        } | null;
        scale: number;
        collapsed: ReadonlySet<string>;
        stack: boolean;
        positions: ReadonlyMap<string, number>;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Empty: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Card: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Avatar: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Author: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Time: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Summary: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
        asChild: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Accept: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        icon: string | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Reject: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        icon: string | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Resolve: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        icon: string | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Reopen: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        icon: string | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Delete: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        asChild: BooleanConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | string>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        icon: string | VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }>;
        asChild: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Replies: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Reply: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }>[] | vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Markers: vue.DefineComponent<vue.ExtractPropTypes<{
        scale: {
            type: NumberConstructor;
            default: number;
        };
        offset: {
            type: NumberConstructor;
            default: number;
        };
        window: {
            type: PropType<{
                top: number;
                bottom: number;
            } | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | ((item: ReviewItemView) => VNode | null | undefined)>;
            default: undefined;
        };
    }>, () => vue_jsx_runtime.JSX.Element | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        scale: {
            type: NumberConstructor;
            default: number;
        };
        offset: {
            type: NumberConstructor;
            default: number;
        };
        window: {
            type: PropType<{
                top: number;
                bottom: number;
            } | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
        icon: {
            type: PropType<VNode | ((item: ReviewItemView) => VNode | null | undefined)>;
            default: undefined;
        };
    }>> & Readonly<{}>, {
        hidden: boolean;
        offset: number;
        window: {
            top: number;
            bottom: number;
        } | null;
        icon: VNode<vue.RendererNode, vue.RendererElement, {
            [key: string]: any;
        }> | ((item: ReviewItemView) => VNode | null | undefined);
        scale: number;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    AddComment: vue.DefineComponent<vue.ExtractPropTypes<{
        top: {
            type: PropType<number | null>;
            default: null;
        };
        drafting: {
            type: BooleanConstructor;
            default: boolean;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        top: {
            type: PropType<number | null>;
            default: null;
        };
        drafting: {
            type: BooleanConstructor;
            default: boolean;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        top: number | null;
        hidden: boolean;
        drafting: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Draft: vue.DefineComponent<vue.ExtractPropTypes<{
        top: {
            type: NumberConstructor;
            default: number;
        };
        left: {
            type: PropType<number | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        top: {
            type: NumberConstructor;
            default: number;
        };
        left: {
            type: PropType<number | null>;
            default: null;
        };
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        left: number | null;
        top: number;
        hidden: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
    Balloon: vue.DefineComponent<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>, () => VNode<vue.RendererNode, vue.RendererElement, {
        [key: string]: any;
    }> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
        className: StringConstructor;
        hidden: BooleanConstructor;
    }>> & Readonly<{}>, {
        hidden: boolean;
    }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
}

`@docx-editor.dev/pro/vue`

Functions (9)

`activatedCustomNodeOf`functionSource ↗

`resolveCustomNodeActivation`functionSource ↗

`reviewModule`functionSource ↗

`useCustomNodeDefinitions`functionSource ↗

`useReview`functionSource ↗

`useReviewAuthor`functionSource ↗

`useReviewItem`functionSource ↗

`useReviewOf`functionSource ↗

`useStackedReviewPositions`functionSource ↗

Interfaces (11)

`CustomNodeChromeProps`interfaceSource ↗

`CustomNodeContextMenuProps`interfaceSource ↗

`ProLicenseOptions`interfaceSource ↗

`ResolvedCustomNodeActivation`interfaceSource ↗

`ReviewActionProps`interfaceSource ↗

`ReviewActivationOptions`interface

`ReviewMarkersProps`interfaceSource ↗

`ReviewModuleOptions`interfaceSource ↗

`ReviewPartProps`interfaceSource ↗

`ReviewProps`interfaceSource ↗

`UseReviewReturn`interfaceSource ↗

Type aliases (2)

`DocxEditorReviewNamespace`typeSource ↗

`ReviewItemView`typeSource ↗

Variables (3)

`CustomNodeChrome`constSource ↗

`CustomNodeContextMenu`constSource ↗

`DocxEditorReview`constSource ↗

On this page

@docx-editor.dev/pro/vue

Functions (9)

activatedCustomNodeOffunctionSource ↗

resolveCustomNodeActivationfunctionSource ↗

reviewModulefunctionSource ↗

useCustomNodeDefinitionsfunctionSource ↗

useReviewfunctionSource ↗

useReviewAuthorfunctionSource ↗

useReviewItemfunctionSource ↗

useReviewOffunctionSource ↗

useStackedReviewPositionsfunctionSource ↗

Interfaces (11)

CustomNodeChromePropsinterfaceSource ↗

CustomNodeContextMenuPropsinterfaceSource ↗

ProLicenseOptionsinterfaceSource ↗

ResolvedCustomNodeActivationinterfaceSource ↗

ReviewActionPropsinterfaceSource ↗

ReviewActivationOptionsinterface

ReviewMarkersPropsinterfaceSource ↗

ReviewModuleOptionsinterfaceSource ↗

ReviewPartPropsinterfaceSource ↗

ReviewPropsinterfaceSource ↗

UseReviewReturninterfaceSource ↗

Type aliases (2)

DocxEditorReviewNamespacetypeSource ↗

ReviewItemViewtypeSource ↗

Variables (3)

CustomNodeChromeconstSource ↗

CustomNodeContextMenuconstSource ↗

DocxEditorReviewconstSource ↗

On this page

`@docx-editor.dev/pro/vue`

`activatedCustomNodeOf`functionSource ↗

`resolveCustomNodeActivation`functionSource ↗

`reviewModule`functionSource ↗

`useCustomNodeDefinitions`functionSource ↗

`useReview`functionSource ↗

`useReviewAuthor`functionSource ↗

`useReviewItem`functionSource ↗

`useReviewOf`functionSource ↗

`useStackedReviewPositions`functionSource ↗

`CustomNodeChromeProps`interfaceSource ↗

`CustomNodeContextMenuProps`interfaceSource ↗

`ProLicenseOptions`interfaceSource ↗

`ResolvedCustomNodeActivation`interfaceSource ↗

`ReviewActionProps`interfaceSource ↗

`ReviewActivationOptions`interface

`ReviewMarkersProps`interfaceSource ↗

`ReviewModuleOptions`interfaceSource ↗

`ReviewPartProps`interfaceSource ↗

`ReviewProps`interfaceSource ↗

`UseReviewReturn`interfaceSource ↗

`DocxEditorReviewNamespace`typeSource ↗

`ReviewItemView`typeSource ↗

`CustomNodeChrome`constSource ↗

`CustomNodeContextMenu`constSource ↗

`DocxEditorReview`constSource ↗