wordinweb 0.1.17 → 0.1.18

package/dist/index.d.ts

@@ -33,7 +33,7 @@ interface XmlElement {
  * everything untouched.
  */
 
-type BorderStyle = "none" | "single" | "double" | "dotted" | "dashed" | "thick" | "wave" | "dotDash" | "dotDotDash" | "triple";
+type BorderStyle = "none" | "single" | "double" | "dotted" | "dashed" | "thick" | "wave" | "dotDash" | "dotDotDash" | "thinThickSmallGap" | "triple";
 interface Border {
     style: BorderStyle;
     /** Stroke width in px. */
@@ -635,6 +635,7 @@ interface DrawingLine {
     y2: number;
     color: string;
     weight: number;
+    style?: "single" | "dotted" | "dashed";
 }
 interface DrawingImage {
     part: string;
@@ -755,6 +756,8 @@ interface DrawingPath {
         width: number;
         opacity?: number;
     };
+    /** Zero-based visible SmartArt node this path paints. */
+    smartArtNodeIndex?: number;
 }
 /**
  * Footnote/endnote reference mark. In body text (w:footnoteReference /
@@ -1672,6 +1675,16 @@ interface DrawingHitItem {
     ink?: boolean;
     /** Native SmartArt diagram selection target. */
     smartArt?: boolean;
+    /** Node hit boxes inside the SmartArt drawing, relative to this item. */
+    smartArtNodes?: Array<{
+        index: number;
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }>;
+    chartData?: ChartData;
+    smartArtData?: SmartArtData;
     /** A shape fill hit that sits UNDER the shape's own text spans (same z): a
      * click on bare fill selects or drags the shape, while clicks on its text
      * glyphs still reach the text editor. */
@@ -1989,8 +2002,9 @@ interface SelectionFormat {
     verticalAlign?: "superscript" | "subscript";
 }
 
-type ShapePreset = "line" | "rectangle" | "roundedRectangle" | "ellipse" | "diamond" | "textBox";
+type ShapePreset = "line" | "verticalLine" | "rectangle" | "roundedRectangle" | "ellipse" | "diamond" | "textBox";
 type WordArtPreset = "plain" | "archUp" | "archDown" | "wave" | "chevron";
+type DrawingLineDash = "solid" | "dashed" | "dotted";
 type DrawingTool = {
     kind?: "pen";
     color: string;
@@ -2006,7 +2020,18 @@ type DrawingTool = {
     kind: "lasso";
 };
 
+interface SmartArtTextFormat {
+    fontFamily: string;
+    fontSizePt: number;
+    color: string;
+    bold: boolean;
+    italic: boolean;
+    alignment: "left" | "center" | "right";
+}
+
 type ObjectArrangeAction = "alignLeft" | "alignCenter" | "alignRight" | "alignTop" | "alignMiddle" | "alignBottom" | "rotateLeft" | "rotateRight" | "bringToFront" | "sendToBack";
+type SelectedObjectKind = "shape" | "line" | "smartArt" | "chart" | "image" | "model3d";
+type SelectedObjectCommand = "altText" | "editText" | "fill" | "outline" | "lineStyle" | "rotate" | "size" | "position" | "wrapInline" | "wrapSquare" | "wrapTopAndBottom" | "wrapFront" | "wrapBehind" | "bringForward" | "sendBackward" | "reset3d" | "delete";
 
 type ParagraphAlignment = "left" | "center" | "right" | "justify";
 interface PageLayoutPatch {
@@ -2052,6 +2077,14 @@ type TableOp = "rowAbove" | "rowBelow" | "deleteRow" | "colLeft" | "colRight" |
     v: "top" | "center" | "bottom";
 };
 
+type ParagraphDividerStyle = "single" | "double" | "dotted" | "dashed" | "thinThickSmallGap";
+interface ParagraphDivider {
+    style: ParagraphDividerStyle;
+    color: string;
+    widthPt: number;
+    spacePt: number;
+}
+
 interface CoverPageContent {
     title: string;
     subtitle?: string;
@@ -2100,7 +2133,7 @@ interface ToolbarMenuSelectProps {
  * 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" | "help" | "download";
+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" | "divider" | "textBox" | "wordArt" | "drawing" | "arrange" | "dropCap" | "headerFooter" | "coverPage" | "pageNumber" | "break" | "layout" | "help" | "download";
 type ToolbarMode = "simple" | "advanced";
 interface DocxToolbarProps {
     api: DocxViewApi | null;
@@ -2140,17 +2173,29 @@ interface DocxViewApi {
     /** Insert a Unicode symbol through the normal undo/suggestion-aware typing path. */
     insertSymbol(symbol: string): boolean;
     /** Insert a floating editable DrawingML shape at the caret. */
-    insertShape(preset: ShapePreset, text?: string): boolean;
+    insertShape(preset: ShapePreset, text?: string, lineStyle?: {
+        color: string;
+        width: number;
+        dash: DrawingLineDash;
+    }): boolean;
     /** Insert editable DrawingML WordArt at the caret. */
     insertWordArt(text: string, preset?: WordArtPreset): boolean;
     /** Insert a native editable ChartML chart at the caret. */
     insertChart(data: ChartData): boolean;
     /** Replace the selected native chart's type and data. */
     updateSelectedChart(data: ChartData): boolean;
+    /** Data for the selected native chart, or null when another object is selected. */
+    getSelectedChart(): ChartData | null;
     /** Insert a native editable SmartArt diagram at the caret. */
     insertSmartArt(data: SmartArtData): boolean;
     /** Replace the selected native SmartArt diagram's layout and node text. */
     updateSelectedSmartArt(data: SmartArtData): boolean;
+    /** Data for the selected native SmartArt diagram, or null when another object is selected. */
+    getSelectedSmartArt(): SmartArtData | null;
+    /** Text formatting for the selected SmartArt node, or the first node when the group is selected. */
+    getSelectedSmartArtTextFormat(): SmartArtTextFormat | null;
+    /** Format the selected SmartArt node, or every node when the group is selected. */
+    setSelectedSmartArtTextFormat(patch: Partial<SmartArtTextFormat>): boolean;
     /** Insert a native Office 3D model with an optional custom poster image. */
     insertModel3D(file: Blob, poster?: Blob): Promise<boolean>;
     /** Insert Word online-video metadata with a browser-safe poster. */
@@ -2165,6 +2210,15 @@ interface DocxViewApi {
     arrangeObject(action: ObjectArrangeAction): boolean;
     /** True while an image, shape, or ink group is selected. */
     hasSelectedObject(): boolean;
+    /** Kind of the selected object, used by contextual formatting controls. */
+    getSelectedObjectContext(): {
+        kind: SelectedObjectKind;
+        canEditText: boolean;
+        smartArtNodeSelected?: boolean;
+        smartArtNodeIndex?: number;
+    } | null;
+    /** Run a formatting command against the current selected object. */
+    runSelectedObjectCommand(command: SelectedObjectCommand): boolean;
     undo(): void;
     redo(): void;
     canUndo(): boolean;
@@ -2173,6 +2227,8 @@ interface DocxViewApi {
     insertTable(rows: number, cols: number): void;
     /** Row/column/table operations on the table containing the caret. */
     tableOp(op: TableOp): void;
+    /** Current table-cell fill, undefined when the caret is outside a table. */
+    getTableCellFill(): string | null | undefined;
     /** Insert an image file at the caret (inline, natural size clamped to column). */
     insertImage(file: Blob): Promise<void>;
     /** Capture a screen, window, or browser tab and insert the current frame as a PNG picture. */
@@ -2198,6 +2254,10 @@ interface DocxViewApi {
         beforePt?: number | null;
         afterPt?: number | null;
     }): void;
+    /** Create, customize, or remove the bottom-border divider on the selected paragraph(s). */
+    setParagraphDivider(divider: ParagraphDivider | null): boolean;
+    /** Direct bottom-border divider on the caret paragraph. */
+    getParagraphDivider(): ParagraphDivider | null;
     /** Apply or remove a native Word drop cap on the caret paragraph. */
     setDropCap(mode: "drop" | "margin" | null, lines?: number): boolean;
     /** Remove direct character formatting from the selection. */