Skip to main content

BrowserEditorHost

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

ClientPoint

A viewport point, for a flyout. Not exported by name. You get it from the API.

CompiledCommand

References > Mark Citation, Mark Entry, Insert Table of Authorities and Insert Index. A mark lands after the selection; all also marks every other place its text stands. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

ComponentCommand

Commands the custom-components layer sends; each is one undo step. Not exported by name. You get it from the API.

ComponentContext

What a component’s live view gets. Import from @reductoai/docx-editor.

ComponentFallback

What Word, the PDF and the canvas show for a component: a picture, a real Word table whose cells hold the component’s data, or free Word content. Import from @reductoai/docx-editor.

ComponentInfo

A component found in the body. Import from @reductoai/docx-editor.

CreateEditorHost

Builds the in-thread session host; the same function serves the in-page fallback. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

DefaultHostOptions

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

DocxKeymap

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

DropCaret

Not exported by name. You get it from the API.

EditorCommand

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

EditorComponent

A component definition with an optional live view; the return of mount unmounts it. Import from @reductoai/docx-editor.

EditorHit

What lies under a viewport point: the page, the point in page hmm, the text position and any link. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

EditorHost

Not exported by name. You get it from the API.

EditorHostHandle

What the worker itself can do with the session the page edits. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

EditorI18n

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

FindEditor

Not exported by name. You get it from the API.

HostChannel

Where host requests go: a dedicated Worker, or one end of a MessageChannel whose other end a worker that also does other work serves (see serveEditorHost). Not exported by name. You get it from the API.

HostRequest

Not exported by name. You get it from the API.

HostRequestBody

Not exported by name. You get it from the API.

InsertCommand

Structural inserts at the caret; a non-empty selection is replaced first. Not exported by name. You get it from the API.

KeyMove

Not exported by name. You get it from the API.

LanguageOptions

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

LinkClick

follow: the click opens the link (Cmd/Ctrl+click, a reader’s click, Open link); else it only placed the caret. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

LinkHandlers

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

LinkHover

The link under the pointer and the box of its text on that line, in client pixels. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

MessageKey

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

Messages

A whole catalog; a host’s override is Partial<Messages>. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.
Not exported by name. You get it from the API.

OpenOptions

markup is the Display for Review the document opens in; All Markup when absent. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

PaletteCommand

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

PaletteGroup

Not exported by name. You get it from the API.

PaletteModel

The slice of EditorModel the command tree reads and drives. Narrow so a test can fake it. Not exported by name. You get it from the API.

PaletteStep

Not exported by name. You get it from the API.

PastedBlock

Not exported by name. You get it from the API.

PromptResult

A typed argument: accept it and run, accept it and ask the next question, or explain. Not exported by name. You get it from the API.

ReactToolbarAddition

A control on the built-in bar: a React node, or a framework-free slot. Import from @reductoai/docx-editor/react.

ReactToolbarItems

Import from @reductoai/docx-editor/react.

SaveBytes

Hands the exported bytes to the user; a sandboxed frame passes its host’s download. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

SaveOptions

Not exported by name. You get it from the API.

SlotName

Import from @reductoai/docx-editor.

SpellDictionary

Where “Add to dictionary” keeps the user’s words; a host may store them server-side. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

SpellEditor

Not exported by name. You get it from the API.

Speller

The dictionary: which words it does not know, and what it would write instead. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

StoryHit

Not exported by name. You get it from the API.

ToolbarAddition

A host’s own control on the built-in bar. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

ToolbarControl

Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

ToolbarItems

Changes to the built-in format bar. A hidden control’s command still runs from its key and the command palette. Import from @reductoai/docx-editor, @reductoai/docx-editor/model.

WorkerScope

Not exported by name. You get it from the API.