wordinweb 0.1.9 → 0.1.11

package/README.md

@@ -119,7 +119,7 @@ The object passed to `onReady`. Every command operates on the current selection
 - `insertBlankPage()` — inserts a complete blank page at the caret.
 - `insertCoverPage({ title, subtitle?, author? })` — prepends an editable, styled cover page.
 - `setLineNumbering(patch, scope?)`, `getLineNumbering()`.
-- `openHeaderFooter("header" | "footer")`, `closeHeaderFooter()` — create or directly enter page header/footer editing; Escape closes it.
+- `openHeaderFooter("header" | "footer")`, `closeHeaderFooter()` — create or directly enter the repeating page layer; shapes and lines inserted there repeat on the pages using that header/footer. Escape closes it.
 
 **Tables**
 - `insertTable(rows, cols)`.
@@ -139,7 +139,7 @@ The object passed to `onReady`. Every command operates on the current selection
 - `insertField(instruction, cachedResult?)`, `insertDateTime("date" | "time", picture?)` — live Word fields.
 - `addBookmark(name)`, `listBookmarks()`, `insertCrossReference(name, "text" | "page")` — named bookmark targets and live `REF` / `PAGEREF` fields.
 - `insertEquation(linear)`, `insertSymbol(symbol)` — native editable OMML equations and arbitrary Unicode symbols.
-- `insertShape(preset, text?)` — floating editable DrawingML rectangles, rounded rectangles, ellipses, diamonds, and text boxes. Advanced mode also exposes Text Box as its own Insert control.
+- `insertShape(preset, text?)` — floating editable DrawingML lines, rectangles, rounded rectangles, ellipses, diamonds, and text boxes. Selected objects expose exact page position, size, outline, wrapping, and layer controls.
 - `insertWordArt(text, preset?)` — editable DrawingML WordArt with plain, arch, wave, and chevron presets.
 - `insertChart(data)`, `updateSelectedChart(data)` — native editable ChartML with its embedded workbook.
 - `insertSmartArt(data)`, `updateSelectedSmartArt(data)` — native editable SmartArt data, layout, style, colors, and cached drawing parts.
@@ -167,6 +167,10 @@ The object passed to `onReady`. Every command operates on the current selection
 
 A ready-made formatting toolbar for an editable `DocxView`. Use `mode="simple"` for the basic Home editing strip or `mode="advanced"` for the full Home / Insert / Draw / Layout ribbon supported by the installed version.
 Layout includes Word-style paper presets plus a custom width/height dialog; both document and current-section scope emit native page-size properties.
+Editable text also has a right-click menu for clipboard, formatting, links,
+comments, lists, and alignment. Word-style shortcuts include heading levels,
+page breaks, links, comments, lists, and paragraph alignment in addition to the
+standard formatting and history commands.
 
 | Prop | Type | What it does |
 | --- | --- | --- |
@@ -198,6 +202,24 @@ Every color the chrome paints — the toolbar, comment cards, selection, caret,
 | `--dxw-layout-menu-width` | `304px` | Layout option-menu width |
 | `--dxw-layout-menu-max-height` | `480px` | Layout option-menu scroll limit |
 | `--dxw-layout-preview-bg` | `#fff` | Paper fill in Layout option previews |
+| `--dxw-select-height` | `26px` | Custom select trigger height |
+| `--dxw-select-border` | `transparent` | Custom select trigger border color |
+| `--dxw-select-radius` | `4px` | Custom select trigger corner radius |
+| `--dxw-select-bg` | `transparent` | Custom select trigger fill |
+| `--dxw-select-fg` | toolbar foreground | Custom select trigger text |
+| `--dxw-select-font` | `13px system-ui` | Custom select trigger font |
+| `--dxw-select-padding` | `0 6px` | Custom select trigger padding |
+| `--dxw-select-menu-bg` | popover background | Custom select menu fill |
+| `--dxw-select-menu-border` | toolbar border | Custom select menu border color |
+| `--dxw-select-menu-radius` | `8px` | Custom select menu corner radius |
+| `--dxw-select-menu-shadow` | popover shadow | Custom select menu shadow |
+| `--dxw-select-menu-max-height` | `320px` | Custom select menu scroll limit |
+| `--dxw-color-menu-width` | `236px` | Text and drawing color palette width |
+| `--dxw-dialog-backdrop` | `rgba(32,33,36,.38)` | Editor dialog scrim |
+| `--dxw-dialog-z-index` | `1000` | Editor dialog stacking level |
+| `--dxw-dialog-width` | `420px` | Editor dialog width |
+| `--dxw-dialog-radius` | `10px` | Editor dialog corner radius |
+| `--dxw-dialog-field-bg` | popover background | Editor dialog field fill |
 | `--dxw-canvas-bg` | `#e8eaed` | Scroll area behind the pages |
 | `--dxw-page-bg` | `#ffffff` | Page paper |
 | `--dxw-page-shadow` | `0 1px 3px …, 0 4px 14px …` | Page drop shadow |
@@ -238,6 +260,31 @@ Or in a stylesheet:
 .dxw-dark { --dxw-toolbar-bg: #1f2937; --dxw-toolbar-fg: #e5e7eb; /* … */ }
 ```
 
+### Custom menus and dialogs
+
+All visible toolbar choices use WordInWeb-rendered controls rather than the
+browser's native select, prompt, or color-picker UI. `ToolbarMenuSelect` is
+exported for host-app controls that should match the toolbar:
+
+```tsx
+<ToolbarMenuSelect
+  value={zoom}
+  ariaLabel="Document zoom"
+  options={[
+    { value: "0.75", label: "75%" },
+    { value: "1", label: "100%" },
+    { value: "1.25", label: "125%" },
+  ]}
+  onChange={setZoom}
+/>
+```
+
+For selector-level styling, the stable hooks are
+`.dxw-menu-select-trigger`, `.dxw-menu-select-menu`,
+`.dxw-menu-select-option`, `.dxw-color-menu`, `.dxw-color-swatch`,
+`.dxw-input-dialog`, `.dxw-input-dialog-field`, and the dialog action button
+classes. Prefer the variables above for theme changes.
+
 Layout controls also expose stable `.dxw-layout-ribbon`, `.dxw-layout-menu-trigger`,
 `.dxw-layout-menu`, `.dxw-layout-menu-item`, and `.dxw-layout-preview` classes.
 Their `data-dxw-layout-menu`, `data-dxw-layout-option`, and

package/dist/index.d.ts

@@ -109,6 +109,11 @@ interface RunProps {
     smallCaps?: boolean;
     /** Letter spacing px (w:spacing, twips in OOXML). */
     letterSpacing?: number;
+    /** Minimum font size in px at which w:kern enables pair kerning; null is
+     * the explicit w:kern=0 override. */
+    kerningThreshold?: number | null;
+    /** Paint-only letter spacing when layout advances intentionally differ. */
+    paintLetterSpacing?: number;
     /** w:w horizontal character scaling as a fraction (1.5 = 150%). */
     textScale?: number;
     /** w:fitText target width in px: the run's advances scale so its text
@@ -376,6 +381,9 @@ interface MathContent {
      * display-style layout - larger n-ary operators with limits stacked
      * above/below, and full-size fraction numerators/denominators. */
     display?: boolean;
+    /** Display group with several direct equations. Word leaves a small
+     * advance after script clusters in these grouped displays. */
+    multiEquationDisplay?: boolean;
     /** m:oMathParaPr/m:jc - display-equation justification. Absent: the
      * document default (settings m:mathPr/m:defJc, itself "centerGroup" when
      * unset). */
@@ -521,13 +529,11 @@ interface ShapeWordArt {
     /** Clockwise degrees. */
     rotation: number;
     behind?: boolean;
-    /** The v:textpath font-size (px). Only used when the text is NOT fit to the
-     * shape (see noFit). */
+    /** The source v:textpath font-size (px). */
     fontSize?: number;
     /** The referenced v:shapetype has a malformed text-guide path (missing
-     * coordinates), so Word cannot compute the fitshape scale and falls back to
-     * drawing the string at its nominal font-size — a near-invisible mark rather
-     * than a box-filling watermark. Render at fontSize, unstretched, to match. */
+     * coordinates), so Word collapses its horizontal glyph outlines into a thin
+     * vertical band instead of painting a box-filling watermark. */
     noFit?: boolean;
     /** Source VML shape element (v:shape / v:rect) for interactive editing:
      * the v:textpath string, fill/opacity, and rotation live under it. */
@@ -724,6 +730,8 @@ interface DrawingTextShape {
     };
     /** Vertical anchoring of the text inside the box (bodyPr anchor). */
     textAnchor?: "top" | "middle" | "bottom";
+    /** DrawingML cached text paint-only baseline adjustment in px. */
+    paintOffsetY?: number;
 }
 interface DrawingPath {
     /** Position/size inside the drawing, px. */
@@ -753,6 +761,8 @@ interface NoteRefContent {
     noteType: "footnote" | "endnote";
     id: number;
     self?: boolean;
+    /** The document supplies the visible mark in the following run content. */
+    customMarkFollows?: boolean;
 }
 /** w:ruby — an East-Asian ruby (furigana) cluster: an annotation run (w:rt)
  * riding above a base run (w:rubyBase). Both sides render as their own runs;
@@ -801,6 +811,8 @@ interface Paragraph {
 interface TableCellProps {
     /** Preferred width px (from tcW when dxa). */
     width?: number;
+    /** The source explicitly declares tcW type="auto" (distinct from no tcW). */
+    widthAuto?: boolean;
     gridSpan: number;
     vMerge?: "restart" | "continue";
     borders?: {
@@ -1138,6 +1150,9 @@ declare class DocxDocument {
     /** Note content by note id (render-only; sources stripped). */
     readonly footnotes: Map<number, Block[]>;
     readonly endnotes: Map<number, Block[]>;
+    /** The separator paragraph controls the gap between its rule and the first
+     * footnote. */
+    readonly footnoteSeparator: Block[];
     /** `_Ref` cross-reference bookmark ranges (name → captured runs). REF
      * fields re-render the referenced text from these — Word recomputes REF on
      * open, so the cached field result in the file is stale. */
@@ -1226,6 +1241,10 @@ declare class DocxDocument {
      * single-threaded and sequential per section. */
     charGridEa: boolean;
     private constructor();
+    /** Resolve content controls mapped to standard package core properties.
+     * Word refreshes these bindings on open, so the serialized sdtContent can
+     * be stale even though the visible value comes from docProps/core.xml. */
+    private hydrateCorePropertyControls;
     /** Repair only objects emitted by older WordInWeb builds that Word rejects. */
     private repairLegacyWordInWebObjects;
     /**
@@ -1420,6 +1439,8 @@ interface FontSpec {
     size: number;
     bold: boolean;
     italic: boolean;
+    /** Pair kerning is active because the run met its w:kern size threshold. */
+    kerning?: boolean;
     /** Optional PAINT-only family tried before `family` in the CSS stack, without
      * affecting metrics or width lookups (keyed by `family`). Used for CJK: the
      * line-pitch profile stays keyed by the macOS substitute face while the real
@@ -1684,10 +1705,10 @@ interface WordArtItem {
     /** Clockwise degrees. */
     rotation: number;
     behind?: boolean;
-    /** v:textpath font-size (px), used only when noFit is set. */
+    /** Source v:textpath font-size (px). */
     fontSize?: number;
-    /** Malformed shapetype guide path: render at nominal fontSize, unstretched
-     * (Word can't fitshape, so it draws a near-invisible mark). */
+    /** Malformed shapetype guide path: Word collapses the fitted glyph outlines
+     * into a thin vertical band. */
     noFit?: boolean;
     /** Source VML shape element (v:shape / v:rect), for interactive select/edit. */
     src?: XmlElement;
@@ -1943,7 +1964,7 @@ interface SelectionFormat {
     verticalAlign?: "superscript" | "subscript";
 }
 
-type ShapePreset = "rectangle" | "roundedRectangle" | "ellipse" | "diamond" | "textBox";
+type ShapePreset = "line" | "rectangle" | "roundedRectangle" | "ellipse" | "diamond" | "textBox";
 type WordArtPreset = "plain" | "archUp" | "archDown" | "wave" | "chevron";
 type DrawingTool = {
     kind?: "pen";
@@ -2027,6 +2048,30 @@ interface MissingFont {
     sample: string;
 }
 
+interface ToolbarMenuSelectOption {
+    value: string;
+    label: React.ReactNode;
+    group?: string;
+    disabled?: boolean;
+    fontFamily?: string;
+}
+interface ToolbarMenuSelectProps {
+    value: string;
+    options: ToolbarMenuSelectOption[];
+    onChange: (value: string) => void;
+    placeholder?: React.ReactNode;
+    title?: string;
+    ariaLabel?: string;
+    triggerAriaLabel?: string;
+    width?: number | string;
+    menuWidth?: number;
+    className?: string;
+    style?: React.CSSProperties;
+}
+/** CSS-overridable replacement for visible native selects. An inert,
+ * transparent select is kept as an event bridge for existing integrations;
+ * every user-facing part is a button/listbox rendered by us. */
+declare function ToolbarMenuSelect({ value, options, onChange, placeholder, title, ariaLabel, triggerAriaLabel, width, menuWidth, className, style, }: ToolbarMenuSelectProps): react.JSX.Element;
 /** Toolbar control groups a host can disable via the `features` prop. */
 type ToolbarFeature = "history" | "styles" | "font" | "size" | "format" | "color" | "highlight" | "alignment" | "indent" | "spacing" | "link" | "lists" | "table" | "image" | "icon" | "screenshot" | "model3D" | "media" | "object" | "chart" | "smartArt" | "comment" | "footnote" | "bookmark" | "crossReference" | "dateTime" | "field" | "equation" | "symbol" | "shape" | "textBox" | "wordArt" | "drawing" | "arrange" | "dropCap" | "headerFooter" | "coverPage" | "pageNumber" | "break" | "layout" | "download";
 type ToolbarMode = "simple" | "advanced";
@@ -2250,4 +2295,4 @@ interface DocxViewProps {
  */
 declare function DocxView({ source, zoom, fitWidth, narrowWidth, editable, className, style, onLoad, onReady, onError, commentAuthor, showComments, revisions, onMissingFonts, }: DocxViewProps): react.JSX.Element;
 
-export { type CoverPageContent, DocxDocument, DocxToolbar, type DocxToolbarProps, DocxView, type DocxViewApi, type DocxViewProps, type DrawingTool, type LineNumberingPatch, type PageLayoutPatch, type ParagraphAlignment, type RunFormatPatch, type ScreenshotInsertResult, type SelectionFormat, type ShapePreset, type ToolbarFeature, type ToolbarMode, layoutDocument, printPages, renderToDom };
+export { type CoverPageContent, DocxDocument, DocxToolbar, type DocxToolbarProps, DocxView, type DocxViewApi, type DocxViewProps, type DrawingTool, type LineNumberingPatch, type PageLayoutPatch, type ParagraphAlignment, type RunFormatPatch, type ScreenshotInsertResult, type SelectionFormat, type ShapePreset, type ToolbarFeature, ToolbarMenuSelect, type ToolbarMenuSelectOption, type ToolbarMenuSelectProps, type ToolbarMode, layoutDocument, printPages, renderToDom };