@docx-editor.dev/react 2.28.0 → 2.30.0

package/dist/index.d.mts

@@ -10,7 +10,7 @@
  */
 import * as react from 'react';
 import react__default, { ReactNode, CSSProperties, ReactElement, ComponentType, ForwardRefExoticComponent, RefAttributes, HTMLAttributes, Ref } from 'react';
-import { RevisionMarkupDialogSession, ResolvedRevisionMarkup, RevisionMarkupOptions, ChromeExportFormat, InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, EditorModule, ReviewDisplayMode, FieldResultsMode, ImageDecodePort, ChromeGroupId, SupportedImageMime, TableChromeSlotId, ChromeExportHandlers, DocumentSearchHighlight, DocumentSearchFindOptions, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, EditorCommandExecute, ToolbarValueMap, HighlightSource, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent, HistoryGroupBindingOptions } from '@docx-editor.dev/core/editor';
+import { RevisionMarkupDialogSession, ResolvedRevisionMarkup, RevisionMarkupOptions, ChromeExportFormat, InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, FontShapingOptions, EditorModule, ReviewDisplayMode, FieldResultsMode, ContentLockPolicy, LockedControlNavigation, ImageDecodePort, ChromeGroupId, SupportedImageMime, TableChromeSlotId, ChromeExportHandlers, DocumentSearchHighlight, DocumentSearchFindOptions, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, EditorCommandExecute, ToolbarValueMap, HighlightSource, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent, HistoryGroupBindingOptions } from '@docx-editor.dev/core/editor';
 export { CHROME_GROUPS, CHROME_MENUS, ChromeExportFormat, ChromeExportHandlers, ChromeMenu, ChromeMenuEntry, ChromeMenuId, ChromeMenuItemEntry, ChromeMenuSeparatorEntry, ChromeMenuSubmenuEntry, ChromeSlotId, ClearRefreshHighlightsOptions, DEFAULT_FONT, DocumentRefresh, DocumentRefreshError, DocumentRefreshState, DocumentSearchFindOptions, DocumentSearchHighlight, DocumentSearchNavigateOptions, DocumentSearchOptions, FontConfigurationBase, FontConfigurationFragment, FontLoadFailure, FontLoadFailureReason, FontOrigin, FontResolutionRequest, FontResolver, FontResolverMark, FontUrlSource, HIGHLIGHT_REFRESH_MS, HighlightSource, ImageWrapTarget, LOADING_SNAPSHOT, LoadFontsRequest, LoadFontsResult, MAX_RESOLVER_FAMILIES, MarkedFontResolver, NavigateToChangeOptions, PX_PER_CM, PX_PER_INCH, ParagraphFlagState, ParagraphFormatRead, ParagraphFormatUpdate, ParagraphTabStop, RefreshChange, RefreshChangeInput, RefreshFailureCode, RefreshHighlightAnimation, RefreshHighlightOptions, RefreshLocation, RefreshResult, RefreshSubmission, RefreshUpdate, ResolvedRevisionMarkup, ReviewAuthorInfo, ReviewDisplayMode, RevisionAuthorAssignments, RevisionAuthorStyle, RevisionChangedLinesMark, RevisionDeletionMark, RevisionMarkupChromeHandlers, RevisionMarkupColor, RevisionMarkupDialogSession, RevisionMarkupMark, RevisionMarkupNamedColor, RevisionMarkupOptions, RevisionStyles, RulerTick, RulerUnit, SEARCH_DEBOUNCE_MS, SEARCH_HIGHLIGHT_PRIORITY, SEARCH_HIGHLIGHT_SET, SEARCH_MATCH_LIMIT, ToolbarCommandState, WORD_DEFAULT_FONT, chromeMenuSlots, commandForSlot, composeFontConfiguration, composeFontOrigins, createDocumentRefresh, createFontSource, defineFontResolver, generateRulerTicks, isFontResolver, loadFonts, rulerPageBox, runToolbarCommand, toolbarCommandState } from '@docx-editor.dev/core/editor';
 import { Editor, ViewScope, EditorCommand, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TextMatch, DocumentHandle, EditorExecOptions, ExecResult, EditorScope, EditorSnapshot, EditorEvents, HighlightOptions, HighlightResult, HighlightRange, HighlightHit, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
 export { AnchorHighlightAnimation, AnchorHighlightOptions, ClearAnchorHighlightOptions, Editor, EditorCommand, EditorFontError, EditorFontErrorCode, EditorQuery, EditorScope, EditorSnapshot, FontConfiguration, FontFaceRequest, FontSource, FontSourceSubstitution, HighlightHit, HighlightOptions, HighlightRange, HighlightRect, HighlightResult, PageSetup, ScrollToAnchorOptions, TextMatch } from '@docx-editor.dev/core/contracts/editor';
@@ -1614,8 +1614,8 @@ interface ReviewRailRegistry {
 declare const ReviewRailContext: react.Context<ReviewRailRegistry | null>;
 
 /**
- * Props for `DocxEditor.Root`. Only `document`, `fonts`, and `imageDecodePort` identity remounts
- * the editor. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
+ * Props for `DocxEditor.Root`. `document`, `fonts` and `imageDecodePort` identity changes remount
+ * the editor. Changing `fontShaping.maxFontBytes` also remounts. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
  * instance setters. `modules` is sampled at mount only.
  *
  * @public
@@ -1636,6 +1636,8 @@ interface DocxEditorRootProps {
      * failures degrade to the fixed measurer and report through `onFontError`.
      */
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** Explicit shaping byte ceiling; a changed maxFontBytes value remounts. */
+    fontShaping?: FontShapingOptions;
     /** Author for later comments, replies, and tracked changes. Changes apply without a remount. */
     author?: string;
     /**
@@ -1691,6 +1693,20 @@ interface DocxEditorRootProps {
      * with a collaboration module.
      */
     fieldResults?: FieldResultsMode;
+    /**
+     * Opt-in relaxation of content-control locks. With `allowFormattingInLockedContent: true`,
+     * readers can format `contentLocked` and `sdtContentLocked` controls while their text stays
+     * protected. Read once, when the editor is created: a later change in value is ignored,
+     * with a development warning.
+     */
+    contentLockPolicy?: ContentLockPolicy;
+    /**
+     * How the caret moves through an inline content control whose content is locked.
+     * `'characters'` (the default) walks through its characters, as Word does. `'atomic'` makes
+     * the control one caret unit. Read once, when the editor is created: a later change is
+     * ignored, with a development warning.
+     */
+    lockedControlNavigation?: LockedControlNavigation;
     /** Fired once per instance, after it is published to the tree (and after any
      *  `DocxEditor.Content` in the same commit has attached its mount point). A large
      *  document mounts behind one painted frame; `onReady` fires AFTER that mount lands,
@@ -3051,6 +3067,8 @@ interface DocxEditorProps {
      * measured. Omit it to mount in one line; supply it when break positions matter.
      */
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** Explicit shaping byte ceiling. A changed maxFontBytes value remounts; equal values keep the instance. */
+    fontShaping?: FontShapingOptions;
     /**
      * Title-bar slots. The host owns what goes here — brand lockup, switchers, theme
      * toggle, Open/New/Save controls — and passes them in; the editor renders them
@@ -3239,6 +3257,20 @@ interface DocxEditorProps {
      * with a collaboration module.
      */
     fieldResults?: FieldResultsMode;
+    /**
+     * Opt-in relaxation of content-control locks. With `allowFormattingInLockedContent: true`,
+     * readers can format `contentLocked` and `sdtContentLocked` controls while their text stays
+     * protected. Read once, when the editor is created: a later change in value is ignored,
+     * with a development warning.
+     */
+    contentLockPolicy?: ContentLockPolicy;
+    /**
+     * How the caret moves through an inline content control whose content is locked.
+     * `'characters'` (the default) walks through its characters, as Word does. `'atomic'` makes
+     * the control one caret unit. Read once, when the editor is created: a later change is
+     * ignored, with a development warning.
+     */
+    lockedControlNavigation?: LockedControlNavigation;
     /**
      * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
      * Changes apply to subsequent edits without a remount; stored date formats are preserved.

package/dist/index.d.ts

@@ -10,7 +10,7 @@
  */
 import * as react from 'react';
 import react__default, { ReactNode, CSSProperties, ReactElement, ComponentType, ForwardRefExoticComponent, RefAttributes, HTMLAttributes, Ref } from 'react';
-import { RevisionMarkupDialogSession, ResolvedRevisionMarkup, RevisionMarkupOptions, ChromeExportFormat, InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, EditorModule, ReviewDisplayMode, FieldResultsMode, ImageDecodePort, ChromeGroupId, SupportedImageMime, TableChromeSlotId, ChromeExportHandlers, DocumentSearchHighlight, DocumentSearchFindOptions, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, EditorCommandExecute, ToolbarValueMap, HighlightSource, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent, HistoryGroupBindingOptions } from '@docx-editor.dev/core/editor';
+import { RevisionMarkupDialogSession, ResolvedRevisionMarkup, RevisionMarkupOptions, ChromeExportFormat, InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, FontShapingOptions, EditorModule, ReviewDisplayMode, FieldResultsMode, ContentLockPolicy, LockedControlNavigation, ImageDecodePort, ChromeGroupId, SupportedImageMime, TableChromeSlotId, ChromeExportHandlers, DocumentSearchHighlight, DocumentSearchFindOptions, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, EditorCommandExecute, ToolbarValueMap, HighlightSource, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent, HistoryGroupBindingOptions } from '@docx-editor.dev/core/editor';
 export { CHROME_GROUPS, CHROME_MENUS, ChromeExportFormat, ChromeExportHandlers, ChromeMenu, ChromeMenuEntry, ChromeMenuId, ChromeMenuItemEntry, ChromeMenuSeparatorEntry, ChromeMenuSubmenuEntry, ChromeSlotId, ClearRefreshHighlightsOptions, DEFAULT_FONT, DocumentRefresh, DocumentRefreshError, DocumentRefreshState, DocumentSearchFindOptions, DocumentSearchHighlight, DocumentSearchNavigateOptions, DocumentSearchOptions, FontConfigurationBase, FontConfigurationFragment, FontLoadFailure, FontLoadFailureReason, FontOrigin, FontResolutionRequest, FontResolver, FontResolverMark, FontUrlSource, HIGHLIGHT_REFRESH_MS, HighlightSource, ImageWrapTarget, LOADING_SNAPSHOT, LoadFontsRequest, LoadFontsResult, MAX_RESOLVER_FAMILIES, MarkedFontResolver, NavigateToChangeOptions, PX_PER_CM, PX_PER_INCH, ParagraphFlagState, ParagraphFormatRead, ParagraphFormatUpdate, ParagraphTabStop, RefreshChange, RefreshChangeInput, RefreshFailureCode, RefreshHighlightAnimation, RefreshHighlightOptions, RefreshLocation, RefreshResult, RefreshSubmission, RefreshUpdate, ResolvedRevisionMarkup, ReviewAuthorInfo, ReviewDisplayMode, RevisionAuthorAssignments, RevisionAuthorStyle, RevisionChangedLinesMark, RevisionDeletionMark, RevisionMarkupChromeHandlers, RevisionMarkupColor, RevisionMarkupDialogSession, RevisionMarkupMark, RevisionMarkupNamedColor, RevisionMarkupOptions, RevisionStyles, RulerTick, RulerUnit, SEARCH_DEBOUNCE_MS, SEARCH_HIGHLIGHT_PRIORITY, SEARCH_HIGHLIGHT_SET, SEARCH_MATCH_LIMIT, ToolbarCommandState, WORD_DEFAULT_FONT, chromeMenuSlots, commandForSlot, composeFontConfiguration, composeFontOrigins, createDocumentRefresh, createFontSource, defineFontResolver, generateRulerTicks, isFontResolver, loadFonts, rulerPageBox, runToolbarCommand, toolbarCommandState } from '@docx-editor.dev/core/editor';
 import { Editor, ViewScope, EditorCommand, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TextMatch, DocumentHandle, EditorExecOptions, ExecResult, EditorScope, EditorSnapshot, EditorEvents, HighlightOptions, HighlightResult, HighlightRange, HighlightHit, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
 export { AnchorHighlightAnimation, AnchorHighlightOptions, ClearAnchorHighlightOptions, Editor, EditorCommand, EditorFontError, EditorFontErrorCode, EditorQuery, EditorScope, EditorSnapshot, FontConfiguration, FontFaceRequest, FontSource, FontSourceSubstitution, HighlightHit, HighlightOptions, HighlightRange, HighlightRect, HighlightResult, PageSetup, ScrollToAnchorOptions, TextMatch } from '@docx-editor.dev/core/contracts/editor';
@@ -1614,8 +1614,8 @@ interface ReviewRailRegistry {
 declare const ReviewRailContext: react.Context<ReviewRailRegistry | null>;
 
 /**
- * Props for `DocxEditor.Root`. Only `document`, `fonts`, and `imageDecodePort` identity remounts
- * the editor. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
+ * Props for `DocxEditor.Root`. `document`, `fonts` and `imageDecodePort` identity changes remount
+ * the editor. Changing `fontShaping.maxFontBytes` also remounts. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
  * instance setters. `modules` is sampled at mount only.
  *
  * @public
@@ -1636,6 +1636,8 @@ interface DocxEditorRootProps {
      * failures degrade to the fixed measurer and report through `onFontError`.
      */
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** Explicit shaping byte ceiling; a changed maxFontBytes value remounts. */
+    fontShaping?: FontShapingOptions;
     /** Author for later comments, replies, and tracked changes. Changes apply without a remount. */
     author?: string;
     /**
@@ -1691,6 +1693,20 @@ interface DocxEditorRootProps {
      * with a collaboration module.
      */
     fieldResults?: FieldResultsMode;
+    /**
+     * Opt-in relaxation of content-control locks. With `allowFormattingInLockedContent: true`,
+     * readers can format `contentLocked` and `sdtContentLocked` controls while their text stays
+     * protected. Read once, when the editor is created: a later change in value is ignored,
+     * with a development warning.
+     */
+    contentLockPolicy?: ContentLockPolicy;
+    /**
+     * How the caret moves through an inline content control whose content is locked.
+     * `'characters'` (the default) walks through its characters, as Word does. `'atomic'` makes
+     * the control one caret unit. Read once, when the editor is created: a later change is
+     * ignored, with a development warning.
+     */
+    lockedControlNavigation?: LockedControlNavigation;
     /** Fired once per instance, after it is published to the tree (and after any
      *  `DocxEditor.Content` in the same commit has attached its mount point). A large
      *  document mounts behind one painted frame; `onReady` fires AFTER that mount lands,
@@ -3051,6 +3067,8 @@ interface DocxEditorProps {
      * measured. Omit it to mount in one line; supply it when break positions matter.
      */
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** Explicit shaping byte ceiling. A changed maxFontBytes value remounts; equal values keep the instance. */
+    fontShaping?: FontShapingOptions;
     /**
      * Title-bar slots. The host owns what goes here — brand lockup, switchers, theme
      * toggle, Open/New/Save controls — and passes them in; the editor renders them
@@ -3239,6 +3257,20 @@ interface DocxEditorProps {
      * with a collaboration module.
      */
     fieldResults?: FieldResultsMode;
+    /**
+     * Opt-in relaxation of content-control locks. With `allowFormattingInLockedContent: true`,
+     * readers can format `contentLocked` and `sdtContentLocked` controls while their text stays
+     * protected. Read once, when the editor is created: a later change in value is ignored,
+     * with a development warning.
+     */
+    contentLockPolicy?: ContentLockPolicy;
+    /**
+     * How the caret moves through an inline content control whose content is locked.
+     * `'characters'` (the default) walks through its characters, as Word does. `'atomic'` makes
+     * the control one caret unit. Read once, when the editor is created: a later change is
+     * ignored, with a development warning.
+     */
+    lockedControlNavigation?: LockedControlNavigation;
     /**
      * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
      * Changes apply to subsequent edits without a remount; stored date formats are preserved.