@twip/web 0.0.0-canary-3e48fc9 → 0.0.0-canary-5a4f96e

package/dist/commands.d.ts

@@ -1,7 +1,7 @@
 import type { RichText } from './review.js';
 import type { ControlKind, ControlOptions, DataBinding } from './services/elements.js';
 import type { TabAlignment, TabLeader } from './services/ruler.js';
-import type { HighlightColor, LineSpacing, MarkupView, ObjectWrap, RowHeight, TableWidth, UnderlineStyle } from './state.js';
+import type { HighlightColor, HorizontalPosition, LineSpacing, MarkupView, ObjectWrap, RowHeight, TableWidth, UnderlineStyle, VerticalPosition, WrapSide } from './state.js';
 import type { Color, CommentId, ElementId, Points, RevisionId, StyleId } from './types.js';
 /** Which elements a field command acts on: the given ids, or the selection's by default. */
 export interface FieldTargets {
@@ -380,6 +380,25 @@ export interface Commands {
     setObjectWrap(wrap: ObjectWrap): Promise<void>;
     /** Locks a floating object's anchor. */
     setAnchorLocked(on: boolean): Promise<void>;
+    /**
+     * Places the floating object: each axis given is aligned, offset, or (with neither) kept where it is and measured
+     * from its new reference; `vertical: { relativeTo: 'page' }` fixes it on the page, `'paragraph'` moves it with text.
+     * Unset fields keep their value.
+     */
+    setObjectPosition(options: {
+        horizontal?: HorizontalPosition;
+        vertical?: VerticalPosition;
+        allowOverlap?: boolean;
+        layoutInCell?: boolean;
+    }): Promise<void>;
+    /** Sets the sides text wraps on around the floating object and its distance from the text, 0 to 1584; unset fields keep their value. */
+    setObjectWrapOptions(options: {
+        side?: WrapSide;
+        top?: Points;
+        bottom?: Points;
+        left?: Points;
+        right?: Points;
+    }): Promise<void>;
     /** Sets the alternative text, or marks the object decorative. */
     setAltText(options: {
         text: string;
@@ -570,6 +589,7 @@ export interface Commands {
         formattingMarks?: boolean;
         gridlines?: boolean;
         textBoundaries?: boolean;
+        liveLayout?: boolean;
     }): Promise<void>;
     /** Switches between editing and design mode. */
     setMode(mode: 'editing' | 'design'): Promise<void>;

package/dist/commands.js

@@ -117,6 +117,8 @@ const encodings = {
     resetObjectSize: 'none',
     setObjectWrap: 'value',
     setAnchorLocked: 'value',
+    setObjectPosition: 'spread',
+    setObjectWrapOptions: 'spread',
     setAltText: 'spread',
     deleteObject: 'none',
     setField: 'spread',

package/dist/index.d.ts

@@ -7,7 +7,7 @@
 export { Editor, HeadlessEditor } from './editor.js';
 export type { ExportResult, MountOptions, SessionOptions } from './editor.js';
 export type { CommandEntry, CommandId, CommandInfo, Commands, FieldTargets, NoArgumentCommandId, Op, OpArgs, PlaceholderLook, } from './commands.js';
-export type { CharacterFormatting, CommandState, CommandValues, EditorState, ElementContext, HighlightColor, LineSpacing, MarkupView, Mixed, ObjectSelection, ObjectWrap, PageFormatting, ParagraphFormatting, ReviewState, RowHeight, SelectionSummary, TableSelection, TableStyleOptions, TableWidth, Tri, UnderlineStyle, ViewState, } from './state.js';
+export type { CharacterFormatting, CommandState, CommandValues, EditorState, ElementContext, HighlightColor, HorizontalPosition, HorizontalReference, LineSpacing, MarkupView, Mixed, ObjectHorizontalAlignment, ObjectPlacement, ObjectSelection, ObjectVerticalAlignment, ObjectWrap, PageFormatting, ParagraphFormatting, ReviewState, RowHeight, SelectionSummary, TableSelection, TableStyleOptions, TableWidth, TextDistance, Tri, UnderlineStyle, VerticalPosition, VerticalReference, ViewState, WrapSide, } from './state.js';
 export type { HostCommand, Tooltip, TransactionRecord, TwipEvents } from './events.js';
 export { EditorError } from './errors.js';
 export type { ErrorCode } from './errors.js';

package/dist/state.d.ts

@@ -170,6 +170,7 @@ export interface CommandValues {
         formattingMarks: boolean;
         gridlines: boolean;
         textBoundaries: boolean;
+        liveLayout: boolean;
     };
     /** The mode. */
     setMode: EditorState['mode'];
@@ -306,9 +307,71 @@ export interface ObjectSelection {
     decorative: boolean;
     /** Whether a floating object's anchor is locked; `null` when inline. */
     anchorLocked: boolean | null;
+    /** Where a floating object is and how text keeps from it; `null` when inline. */
+    placement: ObjectPlacement | null;
 }
 /** How text wraps around an object. */
 export type ObjectWrap = 'inline' | 'square' | 'tight' | 'through' | 'topAndBottom' | 'behindText' | 'inFrontOfText';
+/** What a floating object's horizontal position is measured from. */
+export type HorizontalReference = 'column' | 'margin' | 'page' | 'character' | 'leftMargin' | 'rightMargin' | 'insideMargin' | 'outsideMargin';
+/** What a floating object's vertical position is measured from: `paragraph` and `line` move it with the text. */
+export type VerticalReference = 'paragraph' | 'line' | 'margin' | 'page' | 'topMargin' | 'bottomMargin' | 'insideMargin' | 'outsideMargin';
+/** A floating object aligned across its horizontal reference. */
+export type ObjectHorizontalAlignment = 'left' | 'center' | 'right' | 'inside' | 'outside';
+/** A floating object aligned across its vertical reference. */
+export type ObjectVerticalAlignment = 'top' | 'center' | 'bottom' | 'inside' | 'outside';
+/** Which sides of a floating object text wraps on. */
+export type WrapSide = 'bothSides' | 'left' | 'right' | 'largest';
+/**
+ * A floating object's horizontal place: aligned across its reference, or an offset from the reference's left edge.
+ * Set with neither, the object stays where it is, measured from the new reference.
+ */
+export interface HorizontalPosition {
+    /** What it is measured from. */
+    relativeTo: HorizontalReference;
+    /** Aligned across the reference. */
+    align?: ObjectHorizontalAlignment;
+    /** Right of the reference's left edge, −1584 to 1584. */
+    offset?: Points;
+}
+/**
+ * A floating object's vertical place: aligned across its reference, or an offset below the reference's top. Set with
+ * neither, the object stays where it is, measured from the new reference.
+ */
+export interface VerticalPosition {
+    /** What it is measured from. */
+    relativeTo: VerticalReference;
+    /** Aligned across the reference. */
+    align?: ObjectVerticalAlignment;
+    /** Below the reference's top, −1584 to 1584. */
+    offset?: Points;
+}
+/** How far text keeps from a floating object. */
+export interface TextDistance {
+    /** Above it. */
+    top: Points;
+    /** Below it. */
+    bottom: Points;
+    /** On its left. */
+    left: Points;
+    /** On its right. */
+    right: Points;
+}
+/** A floating object's place and its wrapping options. */
+export interface ObjectPlacement {
+    /** The horizontal place: an alignment or an offset. */
+    horizontal: HorizontalPosition;
+    /** The vertical place: an alignment or an offset. */
+    vertical: VerticalPosition;
+    /** Other floating objects may overlap it. */
+    allowOverlap: boolean;
+    /** In a table cell, it is kept within the cell. */
+    layoutInCell: boolean;
+    /** The sides text wraps on. */
+    wrapSide: WrapSide;
+    /** The distance from the text. */
+    distance: TextDistance;
+}
 /** An element the selection is in or covers. */
 export interface ElementContext {
     /** The element. */
@@ -436,6 +499,8 @@ export interface ViewState {
     gridlines: boolean;
     /** Text boundaries are shown. */
     textBoundaries: boolean;
+    /** Text wraps around an object again as it is dragged; otherwise a preview shows until the release. */
+    liveLayout: boolean;
     /** Field codes are shown. */
     fieldCodes: boolean;
     /** Which built-in rulers are shown. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twip/web",
-  "version": "0.0.0-canary-3e48fc9",
+  "version": "0.0.0-canary-5a4f96e",
   "description": "The Twip DOCX editor for the browser and Node: a managed, framework-independent editor over the WebAssembly engine.",
   "type": "module",
   "license": "Apache-2.0",