> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reducto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# @reductoai/docx-editor

## 0.0.23

*2026-11-17*

Needs `@reductoai/docx` 0.0.41.

### Added

* `ReductoLicenseError` has a stable `code` (such as `REDUCTO_LICENSE_REVOKED`) and `status`; the message ends with the code
* A card's `preview.stories` entries have a typed `storyType`
* Screen readers read wrapped lines with their spaces, numbered headings as headings and contents entries as plain text
* Screen readers read each hyperlink as one link that Tab skips, and pictures by their alt text
* Screen readers read text boxes after their paragraph, and footnotes and endnotes after the body
* Caret speech names a selected picture, and says "Heading level N" or the row and column on entry

### Changes

* The license check stops the package at once on an "unpaid" answer, sent when the organization is out of credits
* `revert` throws when another accepted card edits inside the card's text; revert that card first
* `revert` deletes a comment left on only the words it takes out, as Word does

### Fixes

* `revert` of a card takes out all of its text after a later card in that text is reverted
* A card accepted with a rewrite or without its comment reverts as the agent made it after an undo or redo
* `accept` with `review` drops the agent's edits of words the answer takes out
* `accept` with `review` keeps the agent's edits that do not touch the changes it answers
* `review: { choice, ids }` keeps the agent's edits on the revisions it does not name
* `accept` with `review` refuses while an accepted card edits words the agent answered in another card
* `accept` with `review` answers another author's revisions in a header, footer or note
* `draft(id)` gives the card's new comments and revisions ids that the user's do not hold
* A signed card no longer shares a revision id with a change of the same author and date
* A list typed as "(i) " or "1. " in a live document keeps its number on the server and in other tabs
* Word's heading levels 7 to 9 keep their level in the reader tree
* Toolbar icons are hidden from screen readers

## 0.0.22

*2026-11-16*

Needs `@reductoai/docx` 0.0.40.

### Changes

* The package needs the `@reductoai/docx` version it was built with, and installs it
* A live editor takes no edits until it joins the server

### Fixes

* An edit made while a live editor connects reaches the server; it no longer shifts later edits
* A live edit is no longer sent twice when the editor joins

## 0.0.21

*2026-11-16*

Needs `@reductoai/docx` 0.0.40.

### Breaking

* Live wire 2: needs docserver 0.1.0-rc.5 or newer

### Added

* `live.synced()` resolves once the server has every edit this tab made
* Live tabs ping every 30 s (`keepalive`), so idle sockets stay open
* `server.peerColor` sets each peer's caret colour
* The Shape and Table Style galleries take the theme's corner radius

### Changes

* Undo takes back a typed sentence in one step, as Word does
* Live tracked changes and comments carry the name the editor joined with
* A saved document has a `w14:paraId` on every paragraph and table row

### Fixes

* Two people typing at one spot keep their text apart
* A typist no longer falls behind while another person types
* `await model.run()` resolves only once the edit is applied
* A live editor reconnects with a new token when its token expires
* A live editor joins the docserver's licence Session
* `mountDocxEditor` mounts once inside a Svelte effect
* Spell check no longer flags Hebrew and Arabic text

### Accessibility

* The toolbar is one Tab stop; the arrow keys, Home and End move within it
* More tools opened from the keyboard takes focus, and Escape gives it back
* The selection toolbar takes the same keys, and its buttons have names
* Navigation pane, chart gallery and Format pane tabs are one Tab stop each

## 0.0.20

*2026-11-13*

Needs `@reductoai/docx` 0.0.38.

### Accessibility

* A screen reader reads headings, lists, tables and links; activating one moves the caret there
* Escape, then Tab or Shift+Tab, leaves the document; in read-only view Tab alone does

### Copy and paste

* Copy keeps headings, lists and tables, so they paste into Word, Google Docs and Outlook
* Copied cells of one row are tab-separated in plain text
* Pasting an HTML table makes a Word table

### Agent suggestions

* Fix: a second `restore` keeps `stale` and rejected cards as they were
* Fix: a signed comment-only card reverts to pending after its comment is deleted, as in 0.0.18
* Fix: `paragraphs` counts past a text box as `doc.body.paragraphs` does
* Fix: two runs that add the same text no longer both go in
* Fix: undo of the user's last edit gives back every card as it was
* Fix: a pending insert card goes `stale` when the words before it are deleted
* Fix: a card's revert no longer makes another card of its run `stale`
* Fix: `revert` takes out the user's replies to the card's comment
* Fix: `revert` takes out a reply in a document with no `w14:paraId`
* Fix: an accepted card's `preview.comments` no longer lists the user's replies
* Fix: a card's comment between table rows lands in the next paragraph

## 0.0.19

*2026-11-12*

Needs `@reductoai/docx` 0.0.37.

### Agent suggestions

* Fix: `restore` keeps a rejected card rejected when its ids were reused
* Fix: `restore` reads a card rejected in the margin, then undone, as accepted
* Fix: `restore` reads a card as rejected after accept, uncomment, revert and reject
* Fix: only a pending card is `stale`
* Fix: `revert` removes its comment's marks after a long delete moved them

## 0.0.18

*2026-11-11*

Needs `@reductoai/docx` 0.0.36.

### Agent suggestions

* `accept(id, { comment })` takes one text or `null` per comment of the card
* `accept(id, { review: { choice, ids } })` answers only the named revisions
* `group: "revision"` gives each answer to another author a card of its own
* `list()` gives each card `paragraphs` and `overlaps`
* `Suggestion.theirs` lists the other authors' revisions a card settles or edits on
* Header, footer and note cards take `accept(id, { text })`
* `savedRunToJSON` and `savedRunFromJSON` keep a `SavedRun` as text
* `createDefaultHost(..., { proxyUrl })` and `useProxy(url)` run a session in your own worker
* Faster: `load` 1.4 s → 0.5 s, `restore` 2.1 s → 0.9 s, `list()` 110 → 60 ms
* Fix: editing or deleting an accepted card's comment no longer breaks the card
* Fix: adding or deleting a comment no longer marks cards `stale`
* Fix: a card goes back in without a comment the user deleted
* Fix: an undone accept leaves the card where it was, as `revert` does
* Fix: `restore` keeps accepted cards accepted, and stale only if they were
* Fix: `restore` finds review and comment-only cards by their marks
* Fix: `sign` and `draft` leave other authors' marks as theirs
* Fix: `review` keeps the agent's own edits and works on deletions and replacements
* Fix: an accept after `revert` lands the card as the agent made it

### Custom components (alpha)

* `mountDocxEditor({ components })` mounts live views over component fallbacks

## 0.0.17

*2026-11-09*

Needs `@reductoai/docx` 0.0.35.

### Agent suggestions

* `draft(id)` and `accept(id, { draft })` let the host edit a card with any Word API
* `accept(id, { review })` answers another author's revisions: accept, reject, strike or revise
* `accept`, `acceptMany` and `acceptAll` take `sign` to sign a card's revisions as the reviewer
* `revert` takes an accepted card out, comments included, and keeps what other cards share
* `save` keeps a card out of reach as it stood (`SavedCard.waiting`)
* Fix: `revert` no longer deletes another author's insertion beside a comment anchor
* Fix: a card stays accepted after `save` and `restore`
* Fix: a rejected insertion with matching letters shows the whole word

## 0.0.16

*2026-11-09*

Needs `@reductoai/docx` 0.0.34.

### Agent suggestions

* `acceptMany(ids)` and `acceptAll` accept cards as one undo step
* `group: "paragraph"` makes one card per changed paragraph; `save`/`restore` keep it
* Settle cards accept or reject another author's revision, with preview and `revert`
* `accept(id, { comment })` rewords or drops (`null`) the card's comment
* `revert` works on comment-only cards and, after `restore`, on settle cards (`SavedCard.inverse`)
* Fix: another author's renumbered or split revisions are no longer the agent's
* Fix: `accept(id, { text })` on a struck insertion adds the words as the agent's
* Fix: `list()` no longer throws on a card accepted before it was listed
* Fix: new paragraphs get fresh `w14:paraId`s, so Word keeps them all

### Opening

* The first pages show while the rest lays out; the first page shows in about a third of the time
* A document opens in its Display for Review view, so the first key does not lay it out again
* Fix: default fonts paint Chinese, Japanese and Korean text

### Floating objects

* Press and drag selects and moves a float at once, as in Word; Escape puts it back
* A dragged float re-anchors to the paragraph under the pointer and keeps the guides
* Legacy VML shapes can be dragged
* Fix: floats leave table cells, cross pages and no longer snap back
* Fix: edge auto-scroll is capped at about a screen a second

### Rust layout engine (preview)

* `rustWasmUrl` lays the editor out in `engine.wasm`, with TypeScript as fallback
* The engine compiles once per page and is shared by each session worker
* Enter in a 195-page document: about 365 to 160 ms

### Workers

* Fix: the editor worker loads under Vite dev
* Spell check falls back to the page when its worker cannot load
* A console warning when the session runs on the page thread; `model.host.thread` says which

### Language

* `locale` and `messages` set the editor's language; `de`, `fr` and `es` ship
* Translated: review margin, comments, palette, menus, shortcuts and notices
* Comment times read in the editor's locale

### Review margin

* `slots.balloon` (React: `balloon`) draws custom balloons
* `slots.margin` and `slots.gutter` replace the review margin and the comment icons
* `model.review.layout`, `layoutMargin` and `metrics` give balloon placement
* `model.review.gutter`, `layoutGutter` and `openPin` give Simple Markup's comment icons
* `model.review.rectsOf`, `pick`, `marks`, `markKinds` and `decorate` read and style the marked text
* `model.review.setItems(kind, items)` adds your own records to the margin
* `model.review.inks` sets reviewer colours

### Live editing

* `serveEditorHost` returns `recordExternal(run)`: one undo step, sent to the server when it ends
* Version check: an editor and server too far apart stop with a `DocserverError` `code: "version"`
* An edit the server cannot read is not sent; the session stops with the same error
* `state.layoutMismatch` and a console warning when the docserver's `@reductoai/docx` differs
* Close code 4002 or `behind` reopens the document without an error
* Concurrent table edits stay whole; carets show in headers, footers, notes and text boxes
* `CollabSnapshot.sizes` and `LivePresence.story`
* Fix: no `crypto.randomUUID` error on plain http

### License

* Browser: mount `licenseProxy()` and call `useProxy(url)`; it becomes required in a later release
* Session usage is sent as `office_session_started`

## 0.0.15

*2026-11-04*

Needs `@reductoai/docx` 0.0.33.

### Live editing

* Live sessions report failures as `DocserverError` with `traceId` and `status`
* `server: { url, doc, token }` edits a docserver document live; `connectDocserver` for a mounted editor
* `token` can be a function that fetches a fresh token; a read token opens the document read-only
* `mountDocxEditor` takes a selector as well as an element

### Format bar

* The format bar no longer flickers between labels and icons at one window width

## 0.0.14

*2026-11-02*

Needs `@reductoai/docx` 0.0.32.

### Agent suggestions

* **Breaking:** `AgentSuggestions.reject` and `rejectAll` are undo steps and return a promise
* `AgentSuggestions.save(run)` and `restore(saved)` keep a run's cards across sessions
* An accepted card rejected in the review margin reads as `rejected`
* `AgentSuggestions.revert(id)` takes one accepted card back out, in any order, as one undo step
* `AgentSuggestions.revert(id)` on a rejected card makes it pending again
* `AgentSuggestions.accept(id, { text })` accepts a text card as the user rewrote it
* `AgentSuggestions.load(run, bytes, { keys })` names the agent's revisions by revision id
* An agent deletion over the counterparty's deletion keeps theirs
* `AgentSuggestions.acceptAll` accepts each run's cards as one batch: one layout and one undo step
* `AgentSuggestions.list()` reads only the paragraphs each card touches
* `model.applyCollabChanges(steps)` applies several collab changes as one undo step

### Format bar

* Navigation, Format, Search commands and Shortcuts buttons move into one View menu (⋮)
* The mode menu is one line per item; Suggesting has its own icon

### Speed

* Each key lays two pages and settles the rest in the background

## 0.0.13

*2026-10-30*

Needs `@reductoai/docx` 0.0.31.

### Format bar

* Undo and Redo buttons start the bar
* `toolbarItems: { hide, add }` hides or adds toolbar controls
* `suggesting: "off" | "on"` locks the editing mode
* `readOnly` is a mount option and a React prop

### Agent suggestions

* New entry `@reductoai/docx-editor/suggestions`: `AgentSuggestions` shows agent edits as cards
* A `refuse` policy (`refuseStale`, `refuseMissing` or custom) blocks a card

### Collab

* `startCollab()` without `send` starts a session of one, with no server
* `applyCollabChange`, `selectCollabRange` and `collabTokens` apply, select and read collab changes
* A change that writes parts keeps the review margin's balloons

### Editor

* Fields shade grey; "Field shading" picks Always, When selected or Never
* Option+Left/Right (Ctrl on Windows) stop at word, punctuation and tab edges as Word does
* Left and Right stop twice at an inline content control's edge
* Shift+Left/Right in a table select whole cells
* Up and Down keep the first press's column, also in and out of tables; an edit resets it
* A link's ScreenTip follows the pointer from link to link

## 0.0.12

*2026-10-28*

* **Breaking:** design tokens take an `--rd-` prefix (`--accent` → `--rd-accent`); see `tokens.css`
* Every stylesheet rule is scoped to `.reductoai`
* The spell-check worker loads in webpack and Next.js
* `createDefaultHost` takes a `metafile` backend, so a custom worker draws EMF and WMF
* A read-only editor no longer opens the on-screen keyboard on a touch screen

## 0.0.11

*2026-10-27*

* The stylesheet styles only the editor; `page.css` holds `html`/`body` rules

## 0.0.10

*2026-10-27*

* Design tokens sit in the `reductoai-tokens` layer, so host overrides win
* Opening a document closes the context menu and the date picker
* A turned shape with text shows its selection frame on its outline
* `StyleChoice.inUse` marks the styles in use, for Word's "In current document"
* `startCollab({ block })` gives each writer its own id block
* Docs: Find opens in `nav`; with `nav: null` the host shows its own find box

### Accessibility

* A live region speaks the caret's line, crossed characters, the selection and tracked changes
* In `readOnly`, pages carry a text layer for screen readers

### API

* `model.overlays.mount(page, node, box)` pins a host node to a page
* `links: { onClick, onHover }` on mount, `EditorModel` and React; `model.links` changes them
* `open(bytes, name, { markup })` and `document.options` open in Simple, No Markup or Original
* `selectionText()`, `selectionRects()` and `hitTest()` on `EditorModel`
* `modifyPrompt` and `answerModify`: password to modify and Read-only recommended ask on open
* `SYMBOL_SUBSETS`, `SPECIAL_CHARACTERS`, `LANGUAGES`, `languageName` and `MANUAL_TOC` exported
* `SHAPE_GROUPS` and `shapePreview` exported
* `tableThumb`, `quickLayoutThumb`, `effectLook`, `recolorLook`, `themeRow`, `themeSlotHex` exported

### UI

* A `w:framePr` frame shows its box; drag to move or size it
* A frame's selection box covers its paragraph borders
* A click on a frame's border selects that frame, not the nearest text in a neighbouring frame
* A thin or small picture, shape or frame shows only the handles that fit, so none cover each other
* In `readOnly`, a plain click follows a link
* A `keepView` reopen keeps Display for Review
* A Search commands button opens the command palette
* The header and footer fade while the body has the caret; `--chrome-dim: 0%` turns it off
* Fades mix toward the page color
* Table style gallery with thumbnails, grouped as in Word
* Shapes gallery beside Chart, grouped as in Word

### Palette

* Design: page color, watermark, theme colors and fonts, section break, remove page numbers
* Protection: protect, unprotect, password to modify, Read-only recommended
* Tables: sort, split, distribute rows, delete cells, table to text and back
* Paragraphs: drop cap, multilevel list, promote and demote, sort, paragraph spacing
* Styles: new style from selection, update style to match
* References: symbols, proofing language, no proofing, manual TOC
* References: captions, cross-references, table of figures, table of authorities, index, field codes
* References: mark citation, mark index entry, convert notes
* Pictures: crop, recolor, flip, order, align, transparency, effects and more
* Shapes: insert, change shape, crop to shape
* Charts: type, elements, quick layout, style, switch row/column, data edits

## 0.0.9

*2026-10-26*

### Editing

* Bold or any run format at a caret applies to the next typed text; two fast presses cancel out
* Keep Source Formatting keeps colour, size, font, headings and lists
* Paste options: `runClipboard` and `pasteCommand` take a `PasteMode` (`keep`, `merge`, `text`)
* Cmd+A while typing selects the whole story
* An edit that lands after you move to another field no longer takes focus back
* Find pane: Replace All is one undo step and keeps each hit's capitals
* New Comment at a caret comments the word
* Spell check skips Do Not Check text and other languages
* The context menu offers Restart and Continue numbering on a list item
* `insertTextFromFile` inserts a .docx at the caret
* `insertNote(note, mark?)` takes a custom mark
* `removeHeaderFooter` empties the header or footer
* `selectTablePart` selects a cell, row, column or table

### Pictures and shapes

* Click a shape where it paints: a line on its stroke, a filled shape inside its outline
* A turned shape or picture turns its frame, handles, caret and highlight
* Yellow adjust handles reshape a shape; green end dots move a connector's ends
* Typing on a selected shape puts text in it; the context menu has Add Text
* Double-click a shape with no text to type in it
* The pointer shows a move cursor over a shape
* `EditorModel.changePicture` replaces the selected picture
* A picked chart element is outlined along its own shape

### Review

* `review.show` and `review.setShown` are Word's Show Markup filter
* `model.setMarkup` and `model.markup` give Word's Display for Review
* All Markup with the review margin shut shows deletions inline
* `model.compareWith` compares the open document with another

### Navigation and view

* `setOutline` opens Outline view; `outline` holds its state
* `setZoom` and `zoom` set the zoom
* `setGridlines` shows table gridlines
* `setDrawingGrid` shows the drawing grid
* `verticalRuler: true` shows a vertical ruler with draggable margins
* Links open on Cmd+Click (Ctrl+Click elsewhere), with a tip and Open and Copy link in the menu
* Navigation pane and Go To put the target line at the top
* `scrollCaretIntoView("top")` does the same for a host
* `stepNote` and `showNotes` move between note marks and notes
* `bookmarksOf`, `goToBookmark`, `addBookmark` and `deleteBookmark` back the Bookmark dialog
* `caretPageOf` gives the caret's page
* An endnote shows "Endnote", not "Footnote"

### Headers and footers

* Double-click an empty page margin to add a header or footer
* An open header or footer shows Word's rule and tab; `--chrome-dim` sets how much it fades
* `--story-dim` sets how much the body fades while a header or footer is open
* `headerFooterInView`, `stepHeaderFooter` and `linkToPrevious` back the Header & Footer tab
* `enterHeaderFooter` opens the header or footer on the caret's page, and now returns a promise

### Page

* The page colour paints
* Line numbers take no caret
* A block content control is framed per page, and a table in one is framed whole
* A table of contents is shaded while the caret is in it

### Files

* `open` asks for a password on encrypted files; `unlock` opens them
* `openBlank` opens a blank document

### Toolbar

* Taller toolbar with larger controls; Undo, Redo and font size steps leave it
* Strike, superscript and subscript share one menu
* Insert Chart shows Excel's chart gallery
* Font size is a combo box
* Tool labels show when there is space
* Style and Font boxes show the picked entry in its own look
* Table tools show Word's ten border presets
* The chart gallery and table picker open above the More menu

### API

* `DocxEditor` takes `selectionActions` for the selection bar
* New slots: `selection` and `navClosed`
* `model.selectionBox()` gives the selection bar's box
* `mountDocxEditor` takes `fonts` beside `transport`
* The pages region sits on its own grid row, so a slot can cover it
* Ruler ticks over the margins carry `is-margin`
* The host answers `citations()`, `styleDefinition()`, `allStyles()` and more
* `lookCss` renders small caps
* Drop Cap is in the public command set and format state
* `changeCase` passes `to` through
* Exported for custom chrome: font and colour lists, `styleLabel` and more
* Exported presets: multilevel lists, theme colours and fonts, recolour, spacing, effects
* Exported types for outline, styles, references, themes, tables, sections and more

## 0.0.8

*2026-10-22*

* Needs `@reductoai/portable-fonts` ^0.0.3
* Review balloons, highlights and avatars take the author's colour instead of one red
* Review balloons keep each run's face, bold, italic, underline and strike
* Review balloons show a deleted paragraph mark and a deleted list item
