@docx-editor.dev/react 2.20.0 → 2.21.1

package/README.md

@@ -14,20 +14,20 @@
 
 # @docx-editor.dev/react
 
-WYSIWYG `.docx` editor for React. Opens a Word file in the browser, paints the real paginated
-layout, edits it in place, and writes a `.docx` back out. No upload service, no conversion
-backend: parsing and serialization both happen client-side.
+A visual `.docx` editor for React. Open a Word document, edit its paginated layout, and save a DOCX file. Parsing and serialization run in the browser.
 
-Saving has a lossless semantic round-trip. Untouched content, unsupported OOXML, and package
-payloads survive editing and save. Two oracles gate that in CI, so opening a document here
-cannot quietly destroy it.
+Saving preserves untouched content, unsupported OOXML, and package payloads. Continuous integration (CI) checks document structure and save-and-reopen behavior.
+
+Install the adapter and its required engine peer:
 
 ```bash
-npm install @docx-editor.dev/react
+npm install @docx-editor.dev/react @docx-editor.dev/core
 ```
 
 ## Quick start
 
+Import the stylesheet once and give the editor a container with a defined height:
+
 ```tsx
 import { useState } from 'react';
 import { DocxEditor } from '@docx-editor.dev/react';
@@ -54,17 +54,13 @@ export function App() {
 }
 ```
 
-`<DocxEditor>` is the full packaged editor: title bar, menu, toolbar, navigation pane,
-context menu, and the painted document. It fills its parent, so give it a box with a real
-height, and import the stylesheet once.
+`<DocxEditor>` is the full packaged editor: title bar, menu, toolbar, navigation pane, context menu, and the painted document. It fills its parent, so give it a box with a real height, and import the stylesheet once.
 
-> **Next.js / SSR:** the editor measures text in the DOM at mount, so render it client-side
-> (`dynamic(..., { ssr: false })`).
+For Next.js and server-side rendering (SSR), load the editor in the browser. Use `dynamic(..., { ssr: false })` inside a Client Component.
 
 ## Build your own UI
 
-The packaged chrome is one arrangement of public parts. Every packaged control uses the same
-hooks you would; there is no private API behind it.
+The packaged chrome is one arrangement of public parts. Every packaged control uses the same hooks you would; there is no private API behind it.
 
 ```tsx
 import { DocxEditor, useEditorCommand } from '@docx-editor.dev/react';
@@ -78,7 +74,7 @@ function BoldButton() {
       disabled={!bold.isEnabled}
       data-active={bold.isActive || undefined}
     >
-      B
+      Bold
     </button>
   );
 }
@@ -95,38 +91,30 @@ export function Editor({ bytes }: { bytes: Uint8Array }) {
 }
 ```
 
-`Root` owns the editor instance, `Viewport` is the scroll container, `Content` is where pages
-are painted. Everything else (toolbar, menu, rulers, navigation, link popover, context menu)
-is optional and placed by name.
+`Root` owns the editor instance, `Viewport` is the scroll container, `Content` is where pages are painted. Everything else (toolbar, menu, rulers, navigation, link popover, context menu) is optional and placed by name.
 
-The customization ladder, in order: `className` and `data-active` → the `icon` prop →
-`asChild` (merge behavior onto your own element) → in-place slot override (`hidden`,
-`preset={false}`) → the hooks.
+The customization ladder, in order: `className` and `data-active` → the `icon` prop → `asChild` (merge behavior onto your own element) → in-place slot override (`hidden`, `preset={false}`) → the hooks.
 
 ## Hooks
 
-| Hook                                           | What it gives you                                    |
-| ---------------------------------------------- | ---------------------------------------------------- |
-| `useEditorCommand(slot)`                       | `execute`, `isActive`, `isEnabled`, `disabledReason` |
-| `useEditorState(selector)`                     | A memoized slice of the editor snapshot              |
-| `useDocxEditor()`                              | The editor instance, or `null` before mount          |
-| `useEditorEvent(event, fn)`                    | `change`, `selectionChange`, `error`                 |
-| `useFontFamily()` / `useParagraphStyle()`      | Value controls: current value, options, setter       |
-| `usePageSetup()`                               | Margins, orientation, paper size                     |
-| `useDocumentOutline()` / `useDocumentSearch()` | The navigation pane, headless                        |
-| `useContentControl()`                          | Word content controls at the caret                   |
+| Hook | What it gives you |
+| --- | --- |
+| `useEditorCommand(slot)` | `execute`, `isActive`, `isEnabled`, `disabledReason` |
+| `useEditorState(selector)` | A memoized slice of the editor snapshot |
+| `useDocxEditor()` | The editor instance, or `null` before mount |
+| `useEditorEvent(event, fn)` | `change`, `selectionChange`, `error` |
+| `useFontFamily()` / `useParagraphStyle()` | Value controls: current value, options, setter |
+| `usePageSetup()` | Margins, orientation, paper size |
+| `useDocumentOutline()` / `useDocumentSearch()` | The navigation pane, headless |
+| `useContentControl()` | Word content controls at the caret |
 
-Enabled state has exactly one source. A control that hardcodes `disabled` will drift from the
-engine. Read `isEnabled` and show `disabledReason`.
+Enabled state has exactly one source. A control that hardcodes `disabled` will drift from the engine. Read `isEnabled` and show `disabledReason`.
 
 ## Companion packages
 
-- [`@docx-editor.dev/pro`](https://www.npmjs.com/package/@docx-editor.dev/pro) — tracked
-  changes, comments, custom nodes
-- [`@docx-editor.dev/editor-api`](https://www.npmjs.com/package/@docx-editor.dev/editor-api) —
-  Office.js-compatible editing API, on a server or against an open editor
-- [`@docx-editor.dev/core`](https://www.npmjs.com/package/@docx-editor.dev/core) — the engine
-  this adapter renders
+- [`@docx-editor.dev/pro`](https://www.npmjs.com/package/@docx-editor.dev/pro) — tracked changes, comments, custom nodes
+- [`@docx-editor.dev/editor-api`](https://www.npmjs.com/package/@docx-editor.dev/editor-api) — A supported subset of the Word Office.js API for server and browser editing
+- [`@docx-editor.dev/core`](https://www.npmjs.com/package/@docx-editor.dev/core) — the engine this adapter renders
 
 ## Documentation
 

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import * as react from 'react';
 import react__default, { ReactNode, ReactElement, CSSProperties, ComponentType, ForwardRefExoticComponent, RefAttributes, HTMLAttributes, Ref } from 'react';
-import { Editor, ViewScope, EditorCommand, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TextMatch, DocumentHandle, EditorScope, ExecResult, EditorSnapshot, EditorEvents, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
+import { Editor, ViewScope, EditorCommand, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TextMatch, DocumentHandle, EditorExecOptions, ExecResult, EditorScope, EditorSnapshot, EditorEvents, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
 export { Editor, EditorCommand, EditorFontError, EditorFontErrorCode, EditorQuery, EditorScope, EditorSnapshot, FontConfiguration, FontFaceRequest, FontSource, FontSourceSubstitution, PageSetup } from '@docx-editor.dev/core/contracts/editor';
-import { InvalidTextFormFieldSession, ContentControlWidgetSession, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, EditorModule, ImageDecodePort, SupportedImageMime, TableChromeSlotId, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, ImageWrapTarget, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent } from '@docx-editor.dev/core/editor';
+import { InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, ChromeMenuId, ChromeSlotId, ChromeMenuEntry, DocxEditorInstance, FontConfigurationFragment, FontResolver, EditorModule, ImageDecodePort, SupportedImageMime, TableChromeSlotId, SurfaceHyperlink, FontOrigin, MarkedFontResolver, ReviewAuthorInfo, EditorCommandExecute, ToolbarValueMap, ParagraphFormatRead, ParagraphFormatUpdate, TextMeasurer, PaginatedSurfaceState, NavigationCommand, SurfaceFormatting, SectionProperties, RulerIndent, HistoryGroupBindingOptions } from '@docx-editor.dev/core/editor';
 export { CHROME_GROUPS, CHROME_MENUS, ChromeMenu, ChromeMenuEntry, ChromeMenuId, ChromeMenuItemEntry, ChromeMenuSeparatorEntry, ChromeMenuSubmenuEntry, ChromeSlotId, FontConfigurationBase, FontConfigurationFragment, FontLoadFailure, FontLoadFailureReason, FontOrigin, FontResolutionRequest, FontResolver, FontResolverMark, FontUrlSource, ImageWrapTarget, LOADING_SNAPSHOT, LoadFontsRequest, LoadFontsResult, MAX_RESOLVER_FAMILIES, MarkedFontResolver, PX_PER_CM, PX_PER_INCH, ParagraphFlagState, ParagraphFormatRead, ParagraphFormatUpdate, ParagraphTabStop, ReviewAuthorInfo, RevisionAuthorAssignments, RevisionAuthorStyle, RevisionStyles, RulerTick, RulerUnit, ToolbarCommandState, WORD_DEFAULT_FONT, chromeMenuSlots, commandForSlot, composeFontConfiguration, composeFontOrigins, createFontSource, defineFontResolver, generateRulerTicks, isFontResolver, loadFonts, rulerPageBox, runToolbarCommand, toolbarCommandState } from '@docx-editor.dev/core/editor';
 import { TFunction, Translations, LocaleStrings } from '@docx-editor.dev/i18n';
 export { TranslationKey } from '@docx-editor.dev/i18n';
@@ -170,15 +170,180 @@ interface DocxEditorInvalidTextFormFieldDialogProps {
 /** Default acknowledgement shell for a custom popup renderer. @public */
 declare function DocxEditorInvalidTextFormFieldDialog(props: DocxEditorInvalidTextFormFieldDialogProps): react.JSX.Element;
 
+/** One selectable entry of a dropdown or combo-box control. @public */
+interface ContentControlWidgetEntry {
+    readonly displayText: string;
+    readonly value: string;
+}
+/**
+ * The draft state a content-control value pop-up renders over.
+ *
+ * Read it from `useContentControlWidget()` inside `DocxEditorContentControlWidget`, or from a
+ * fully custom `popups.contentControlWidget` renderer that mounts the provider through the
+ * packaged root. `value` is the draft; `apply()` commits it through the session, which the
+ * engine validates. The calendar members drive the date picker: `calendar` is the month in
+ * view, built for the session's locale.
+ * @public
+ */
+interface UseContentControlWidgetResult {
+    readonly session: ContentControlWidgetSession;
+    readonly kind: ContentControlWidgetSession['kind'];
+    readonly items: readonly ContentControlWidgetEntry[];
+    readonly value: string;
+    setValue(value: string): void;
+    /** The engine still accepts a write for this control. */
+    readonly isEnabled: boolean;
+    /** The last `apply()` was refused by the engine. */
+    readonly refused: boolean;
+    /** Commit `value`, or an explicit one; false when the engine refused it. */
+    apply(value?: string): boolean;
+    cancel(): void;
+    readonly calendar: CalendarMonth;
+    previousMonth(): void;
+    nextMonth(): void;
+    /** Commit one calendar day (`YYYY-MM-DD`). */
+    selectDay(iso: string): boolean;
+    /** Commit the current local date. */
+    selectToday(): boolean;
+    /** The day keyboard focus should land on after the grid renders, if any. */
+    readonly focusIso: string | null;
+    /** Move keyboard focus to a day, turning the month if it lies outside the view. */
+    focusDay(iso: string): void;
+    /** Numeric regional date entry, separate from the ISO value. */
+    readonly dateText: string;
+    setDateText(text: string): void;
+    applyDateText(): boolean;
+    /** Jump to a month without committing. Month is zero-based; year is 100–9999. */
+    showMonth(year: number, month: number): void;
+    /** ID shared by the combo input and listbox. */
+    readonly listId: string;
+    /** Shared typeahead and roving-focus behavior for replacement lists. */
+    readonly listNavigation: ContentControlListNavigation;
+    /** Picture sessions: the image types `replaceImage` takes, as a file input `accept` list. */
+    readonly accept: string;
+    /**
+     * Picture sessions: replace the control's image from a file or its bytes. The engine
+     * checks the format and size; false (and `refused`) when it declines or the session is
+     * not a picture session.
+     */
+    replaceImage(source: Blob | Uint8Array): Promise<boolean>;
+}
+/** Draft state of the enclosing content-control value pop-up. @public */
+declare function useContentControlWidget(): UseContentControlWidgetResult;
+
+/**
+ * Presentation overrides for a value pop-up part. @public
+ *
+ * Anything beyond these members reaches the rendered element, so a part takes an `id`, an
+ * `aria-*` label or a `data-*` test hook. The part's own wiring wins every collision. Pass
+ * `asChild` to own the element outright and keep its behavior.
+ */
+interface DocxEditorContentControlWidgetPartProps {
+    className?: string;
+    style?: CSSProperties;
+    hidden?: boolean;
+    asChild?: boolean;
+    children?: DocxEditorChildren;
+    id?: string;
+    title?: string;
+    'aria-label'?: string;
+    [attribute: `data-${string}`]: unknown;
+    [attribute: `aria-${string}`]: unknown;
+}
+/** Month navigation row with month and year controls. @public */
+declare function ContentControlWidgetHeader(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Steps the calendar back one month. @public */
+declare function ContentControlWidgetPreviousMonth(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Steps the calendar forward one month. @public */
+declare function ContentControlWidgetNextMonth(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** The month and year in view. @public */
+declare function ContentControlWidgetTitle(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Seven weekday labels in the locale's order. @public */
+declare function ContentControlWidgetWeekdays(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Props for one calendar cell. @public */
+interface ContentControlWidgetDayProps extends DocxEditorContentControlWidgetPartProps {
+    day: CalendarDay;
+}
+/** One calendar cell; a press commits that date, arrow keys roam the grid. @public */
+declare function ContentControlWidgetDay({ day, ...props }: ContentControlWidgetDayProps): ReactNode;
+/** The six-week grid of `Day` cells. @public */
+declare function ContentControlWidgetGrid(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Commits the current local date. @public */
+declare function ContentControlWidgetToday(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** The whole date picker, including regional date entry and actions. @public */
+declare function ContentControlWidgetCalendar(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Props for one list entry. @public */
+interface ContentControlWidgetItemProps extends DocxEditorContentControlWidgetPartProps {
+    item: ContentControlWidgetEntry;
+}
+/** One dropdown or combo-box entry; a press commits its value. @public */
+declare function ContentControlWidgetItem({ item, ...props }: ContentControlWidgetItemProps): ReactNode;
+/** The list of `Item` entries the control declares. @public */
+declare function ContentControlWidgetList(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Free-text entry for a combo box; Enter commits. @public */
+declare function ContentControlWidgetInput(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** The engine refused the last value. @public */
+declare function ContentControlWidgetError(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Commits the draft value. @public */
+declare function ContentControlWidgetApply(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Closes without a write. @public */
+declare function ContentControlWidgetCancel(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Cancel and Apply row. @public */
+declare function ContentControlWidgetFooter(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Month selector and numeric year entry. @public */
+declare function ContentControlWidgetNavigation(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Jump directly to a month. @public */
+declare function ContentControlWidgetMonth(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Jump directly to a four-digit year. @public */
+declare function ContentControlWidgetYear(props: DocxEditorContentControlWidgetPartProps): ReactNode;
+/** Props for the picture file input. @public */
+interface ContentControlWidgetPictureProps extends DocxEditorContentControlWidgetPartProps {
+    /** Open the browser's file dialog as soon as the part mounts. Defaults to true. */
+    autoOpen?: boolean;
+}
+/**
+ * The file input of a picture session. A chosen file replaces the control's image through
+ * the session; closing the dialog without a file cancels the session. @public
+ */
+declare function ContentControlWidgetPicture({ autoOpen, ...props }: ContentControlWidgetPictureProps): ReactNode;
+
 /** Value-widget session and optional replacement controls. @public */
 interface DocxEditorContentControlWidgetProps {
     session: ContentControlWidgetSession;
     className?: string;
     style?: CSSProperties;
+    /**
+     * Replaces the packaged arrangement. Compose it from the compound's parts
+     * (`DocxEditorContentControlWidget.Calendar`, `.List`, …) or from `useContentControlWidget()`.
+     */
     children?: DocxEditorChildren;
 }
+/** The compound pop-up with its parts attached as statics. @public */
+interface DocxEditorContentControlWidgetNamespace {
+    (props: DocxEditorContentControlWidgetProps): ReactNode;
+    readonly Navigation: typeof ContentControlWidgetNavigation;
+    readonly Month: typeof ContentControlWidgetMonth;
+    readonly Year: typeof ContentControlWidgetYear;
+    readonly Calendar: typeof ContentControlWidgetCalendar;
+    readonly Header: typeof ContentControlWidgetHeader;
+    readonly PreviousMonth: typeof ContentControlWidgetPreviousMonth;
+    readonly Title: typeof ContentControlWidgetTitle;
+    readonly NextMonth: typeof ContentControlWidgetNextMonth;
+    readonly Weekdays: typeof ContentControlWidgetWeekdays;
+    readonly Grid: typeof ContentControlWidgetGrid;
+    readonly Day: typeof ContentControlWidgetDay;
+    readonly Today: typeof ContentControlWidgetToday;
+    readonly List: typeof ContentControlWidgetList;
+    readonly Item: typeof ContentControlWidgetItem;
+    readonly Input: typeof ContentControlWidgetInput;
+    readonly Picture: typeof ContentControlWidgetPicture;
+    readonly Error: typeof ContentControlWidgetError;
+    readonly Footer: typeof ContentControlWidgetFooter;
+    readonly Apply: typeof ContentControlWidgetApply;
+    readonly Cancel: typeof ContentControlWidgetCancel;
+}
 /** Compact value editor for a configured content-control popup. @public */
-declare function DocxEditorContentControlWidget(props: DocxEditorContentControlWidgetProps): react.JSX.Element;
+declare const DocxEditorContentControlWidget: DocxEditorContentControlWidgetNamespace;
 
 /**
  * Presentation overrides for a dialog part. @public
@@ -1253,6 +1418,18 @@ declare function useContextMenuTarget(): HTMLElement | null;
 /** Render overrides for automatically mounted editor popups. `false` disables automatic rendering. @public */
 interface DocxEditorPopups {
     contentControlWidget?: DocxEditorPopup<DocxEditorContentControlWidgetProps>;
+    /**
+     * Renderer for checkbox presses. Omitted, the engine toggles the box itself and
+     * `contentControlWidget` never sees a checkbox session. Configure it to confirm, refuse or
+     * restyle the toggle; `DocxEditorContentControlWidget` without children applies it at once.
+     */
+    contentControlCheckbox?: DocxEditorPopup<DocxEditorContentControlWidgetProps>;
+    /**
+     * Renderer for picture presses. Omitted, the engine opens its own file picker and
+     * `contentControlWidget` never sees a picture session. Configure it to pick from your own
+     * source; `DocxEditorContentControlWidget` without children opens a file picker at once.
+     */
+    contentControlPicture?: DocxEditorPopup<DocxEditorContentControlWidgetProps>;
     invalidTextFormField?: DocxEditorPopup<DocxEditorInvalidTextFormFieldDialogProps>;
     imageProperties?: DocxEditorPopup<DocxEditorImagePropertiesDialogProps>;
     imageAltText?: DocxEditorPopup<DocxEditorImageAltTextPopupProps>;
@@ -2451,7 +2628,7 @@ interface DocxEditorProps {
      * HarfBuzz and measures line and page breaks from real font metrics. Without it, layout
      * runs on a fixed monospace approximation: glyphs still paint in their true faces, so the
      * page looks right, but wrap points and pagination are estimated rather than
-     * Word-accurate. Omit it to mount in one line; supply it when breaks must match Word.
+     * measured. Omit it to mount in one line; supply it when break positions matter.
      */
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
     /**
@@ -2660,9 +2837,7 @@ interface DocxEditorRef {
     getEditor(): Editor | null;
     focus(): void;
     /** Run a typed command through the facade; refused with `notFound` before mount. */
-    exec(command: EditorCommand, options?: {
-        scope?: EditorScope;
-    }): ExecResult;
+    exec(command: EditorCommand, options?: EditorExecOptions): ExecResult;
     /** The current read model; a loading, non-editable snapshot before mount. */
     snapshot(options?: {
         scope?: EditorScope;
@@ -3343,7 +3518,7 @@ interface EditorCommandState {
      *
      * @returns `true` when the engine accepted and ran the command; `false` on refusal.
      */
-    readonly execute: () => boolean;
+    readonly execute: EditorCommandExecute;
     /** Whether the command is currently applied at the selection (bold on bold text). */
     readonly isActive: boolean;
     /** Whether the engine will honour the command right now. */
@@ -3369,28 +3544,17 @@ interface EditorCommandState {
  */
 declare function useEditorCommand(target: ChromeSlotId | EditorCommand): EditorCommandState;
 
-/**
- * Live state for a value-typed toolbar control.
- *
- * @public
- */
+/** Live state and typed execution for a value control. @public */
 interface EditorValueCommandState<T extends string | number> {
-    readonly execute: (value: T) => void;
+    readonly execute: (value: T, options?: EditorExecOptions) => ExecResult;
+    /** Null for mixed or unavailable formatting. */
     readonly value: T | null;
     readonly options: readonly T[];
     readonly isEnabled: boolean;
     readonly disabledReason: string | null;
 }
-/**
- * Bind a value-typed chrome slot (`image.wrap`, `image.altText`) to the editor.
- *
- * @public
- */
-declare function useEditorValueCommand(slotId: 'image.wrap'): EditorValueCommandState<ImageWrapTarget>;
-/**
- * @public
- */
-declare function useEditorValueCommand(slotId: 'image.altText'): EditorValueCommandState<string>;
+/** Bind a value slot. Font size values use half-points; colors use six digits without `#`. @public */
+declare function useEditorValueCommand<K extends keyof ToolbarValueMap>(slotId: K): EditorValueCommandState<ToolbarValueMap[K]>;
 
 /** @public */
 type DocxEditorRefCallback<T> = (node: T | null) => void;
@@ -4253,4 +4417,12 @@ declare function VerticalRuler({ pageSetup, zoom, editable, onTopMarginChange, o
  */
 declare function useEditorSnapshot(editor: Editor | null): number;
 
-export { CONTENT_CONTROL_SLOTS, type ChromeTranslate, type ContentControlActionProps, type ContentControlInspectorState, type ContentControlLock, type ContentControlPartProps, type ContentControlProps, type ContentControlSlotId, type ContextMenuAnchor, ContextMenuCellVerticalAlignment, type ContextMenuCommandProps, type ContextMenuContextValue, ContextMenuCopy, ContextMenuCopyFormatting, ContextMenuCut, ContextMenuDelete, ContextMenuDeleteTable, ContextMenuDeleteTableColumn, ContextMenuDeleteTableRow, ContextMenuInsertColumnLeft, ContextMenuInsertColumnRight, ContextMenuInsertRowAbove, ContextMenuInsertRowBelow, ContextMenuItem, type ContextMenuItemProps, ContextMenuPaste, ContextMenuPasteFormatting, ContextMenuPasteWithoutFormatting, ContextMenuRefreshToc, ContextMenuRefreshTocPageNumbers, ContextMenuSelectAll, type ContextMenuTableRowProps, type DialogCustomizationProps, type DialogPartProps, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, DocxEditorContentControlWidget, type DocxEditorContentControlWidgetProps, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImageAltTextPopup, type DocxEditorImageAltTextPopupProps, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorInvalidTextFormFieldDialog, type DocxEditorInvalidTextFormFieldDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotePreview, type DocxEditorNotePreviewProps, DocxEditorNotePropertiesDialog, type DocxEditorNotePropertiesDialogProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorNotesContextMenu, type DocxEditorNotesContextMenuProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorPopup, type DocxEditorPopups, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, DocxEditorTextFormFieldDialog, type DocxEditorTextFormFieldDialogProps, DocxEditorToolbar, type DocxEditorToolbarNamespace, type DocxEditorToolbarProps, DocxEditorVerticalRuler, DocxEditorViewport, type DocxEditorViewportProps, type DocxFontOrigin, type DocxFontsInput, type DocxFontsSource, type DocxSource, type EditorCaret, type EditorCommandState, type EditorMode, type EditorValueCommandState, type FontFamilyItemProps, type FontFamilyNamespace, type FontFamilyPartProps, type FontFamilyProps, type FontsInput, type HeaderFooterState, HorizontalRuler, type HorizontalRulerProps$1 as HorizontalRulerProps, type HyperLinkActionProps, type HyperLinkPartProps, type HyperLinkProps, type HyperlinkPopupAnchor, type HyperlinkPopupMode, type HyperlinkPopupState, ImageAltText, ImageInsertProvider, ImageInsertTrigger, ImagePropertiesTrigger, type ImagePropertiesTriggerProps, ImageWrap, type IndentUpdate, LocaleProvider, type LocaleProviderProps, Logo, type MaybeRefOrGetter, type MenuActionProps, MenuBar, type MenuGroupProps, type MenuId, type MenuItemProps, type MenuPartComponent, type MenuProps, type MenuReportIssueProps, type MenuReviewersProps, type MenuRowProps, type MenuSeparatorProps, type MenuSubmenuProps, type MenuTableGridProps, NAVIGATION_PANE_GAP, NAVIGATION_PANE_INSET, NAVIGATION_PANE_WIDTH, NavigationClose, NavigationFind, NavigationHeader, NavigationHeadings, type NavigationPartProps, type NavigationShiftInput, NavigationTab, type NavigationTabProps, type NavigationTab$1 as NavigationTabValue, NavigationTabs, NavigationTitle, NavigationToggle, type NormalizedImagePayload, type NotePropertiesState, OUTLINE_BUTTON_LEFT_OFFSET, OUTLINE_BUTTON_RESERVED_SPACE, OUTLINE_LEFT_OFFSET, OUTLINE_RESERVED_SPACE, type OutlineHeading$1 as OutlineHeading, type OutlineHeadingItem, PageIndicator, type PageIndicatorProps, PageNumberTranslationContext, type PageSetupDialogFields, type PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ProvideDocxEditorResult, REVIEW_MARKERS_GUTTER, REVIEW_PANE_GUTTER, RULER_WIDTH, type ReviewGutter, type ReviewGutterInput, ReviewRailContext, type ReviewRailRegistry, SEARCH_DEBOUNCE_MS, SEARCH_MATCH_LIMIT, type ScopedChromeAnchor, Slot, type SlotProps, type TableBorderColorNamespace, type TableBorderStyleNamespace, type TableBorderTargetNamespace, type TableBorderWidthNamespace, type TableCellFillNamespace, type TableChromeItemProps, type TableChromePartComponent, type TableChromePartProps, type TextFormFieldDialogFields, TitleBar, TitleBarRight, Toolbar, type ToolbarActionProps, type ToolbarAlignmentComponent, ToolbarButton, type ToolbarButtonProps$1 as ToolbarButtonProps, ToolbarContext, type ToolbarContextValue, ToolbarGroup, ToolbarImageProperties, type ToolbarPartComponent, type ToolbarPartProps, type ToolbarProps, type ToolbarReviewersProps, type ToolbarSeparatorProps, type ToolbarSlotPartComponent, type ToolbarSlotPartProps, type ToolbarTranslate, type UseContentControlResult, type UseDialogReturn, type UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupDialogReturn, type UsePageSetupReturn, type UseParagraphDialogReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseTextFormFieldDialogReturn, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, definePopup, editorStateActiveSubscriptionCount, isFieldLink, navigationPaneReservation, navigationShift, normalizeImageBytes, notificationYieldsToTask, useProvidedDocxEditor as provideDocxEditor, reviewGutter, useChromeTranslate, useContentControl, useContentControlInstance, useContextMenuTarget, useDocumentOutline, useDocumentSearch, useDocxEditor, useDocxSource, useEditorCaret, useEditorCommand, useEditorEvent, useEditorSnapshot, useEditorState, useEditorValueCommand, useFontFamily, useFonts, useHeaderFooterState, useHyperlinkPopup, useHyperlinkPopupInstance, useNavigationPane, useNavigationShift, useNotePropertiesState, useNoteScopeState, usePageSetup, usePageSetupDialog, useParagraphDialog, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useTextFormFieldDialog, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };
+/** @public */
+interface UseHistoryGroupReturn {
+    readonly ref: (element: HTMLElement | null) => void;
+    readonly options: () => EditorExecOptions;
+}
+/** Bind a control's native gesture lifecycle. Apply values through the existing command hooks. @public */
+declare function useHistoryGroup({ kind }: HistoryGroupBindingOptions): UseHistoryGroupReturn;
+
+export { CONTENT_CONTROL_SLOTS, type ChromeTranslate, type ContentControlActionProps, type ContentControlInspectorState, type ContentControlLock, type ContentControlPartProps, type ContentControlProps, type ContentControlSlotId, type ContentControlWidgetDayProps, type ContentControlWidgetEntry, type ContentControlWidgetItemProps, type ContentControlWidgetPictureProps, type ContextMenuAnchor, ContextMenuCellVerticalAlignment, type ContextMenuCommandProps, type ContextMenuContextValue, ContextMenuCopy, ContextMenuCopyFormatting, ContextMenuCut, ContextMenuDelete, ContextMenuDeleteTable, ContextMenuDeleteTableColumn, ContextMenuDeleteTableRow, ContextMenuInsertColumnLeft, ContextMenuInsertColumnRight, ContextMenuInsertRowAbove, ContextMenuInsertRowBelow, ContextMenuItem, type ContextMenuItemProps, ContextMenuPaste, ContextMenuPasteFormatting, ContextMenuPasteWithoutFormatting, ContextMenuRefreshToc, ContextMenuRefreshTocPageNumbers, ContextMenuSelectAll, type ContextMenuTableRowProps, type DialogCustomizationProps, type DialogPartProps, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, DocxEditorContentControlWidget, type DocxEditorContentControlWidgetNamespace, type DocxEditorContentControlWidgetPartProps, type DocxEditorContentControlWidgetProps, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImageAltTextPopup, type DocxEditorImageAltTextPopupProps, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorInvalidTextFormFieldDialog, type DocxEditorInvalidTextFormFieldDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotePreview, type DocxEditorNotePreviewProps, DocxEditorNotePropertiesDialog, type DocxEditorNotePropertiesDialogProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorNotesContextMenu, type DocxEditorNotesContextMenuProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorPopup, type DocxEditorPopups, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, DocxEditorTextFormFieldDialog, type DocxEditorTextFormFieldDialogProps, DocxEditorToolbar, type DocxEditorToolbarNamespace, type DocxEditorToolbarProps, DocxEditorVerticalRuler, DocxEditorViewport, type DocxEditorViewportProps, type DocxFontOrigin, type DocxFontsInput, type DocxFontsSource, type DocxSource, type EditorCaret, type EditorCommandState, type EditorMode, type EditorValueCommandState, type FontFamilyItemProps, type FontFamilyNamespace, type FontFamilyPartProps, type FontFamilyProps, type FontsInput, type HeaderFooterState, HorizontalRuler, type HorizontalRulerProps$1 as HorizontalRulerProps, type HyperLinkActionProps, type HyperLinkPartProps, type HyperLinkProps, type HyperlinkPopupAnchor, type HyperlinkPopupMode, type HyperlinkPopupState, ImageAltText, ImageInsertProvider, ImageInsertTrigger, ImagePropertiesTrigger, type ImagePropertiesTriggerProps, ImageWrap, type IndentUpdate, LocaleProvider, type LocaleProviderProps, Logo, type MaybeRefOrGetter, type MenuActionProps, MenuBar, type MenuGroupProps, type MenuId, type MenuItemProps, type MenuPartComponent, type MenuProps, type MenuReportIssueProps, type MenuReviewersProps, type MenuRowProps, type MenuSeparatorProps, type MenuSubmenuProps, type MenuTableGridProps, NAVIGATION_PANE_GAP, NAVIGATION_PANE_INSET, NAVIGATION_PANE_WIDTH, NavigationClose, NavigationFind, NavigationHeader, NavigationHeadings, type NavigationPartProps, type NavigationShiftInput, NavigationTab, type NavigationTabProps, type NavigationTab$1 as NavigationTabValue, NavigationTabs, NavigationTitle, NavigationToggle, type NormalizedImagePayload, type NotePropertiesState, OUTLINE_BUTTON_LEFT_OFFSET, OUTLINE_BUTTON_RESERVED_SPACE, OUTLINE_LEFT_OFFSET, OUTLINE_RESERVED_SPACE, type OutlineHeading$1 as OutlineHeading, type OutlineHeadingItem, PageIndicator, type PageIndicatorProps, PageNumberTranslationContext, type PageSetupDialogFields, type PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ProvideDocxEditorResult, REVIEW_MARKERS_GUTTER, REVIEW_PANE_GUTTER, RULER_WIDTH, type ReviewGutter, type ReviewGutterInput, ReviewRailContext, type ReviewRailRegistry, SEARCH_DEBOUNCE_MS, SEARCH_MATCH_LIMIT, type ScopedChromeAnchor, Slot, type SlotProps, type TableBorderColorNamespace, type TableBorderStyleNamespace, type TableBorderTargetNamespace, type TableBorderWidthNamespace, type TableCellFillNamespace, type TableChromeItemProps, type TableChromePartComponent, type TableChromePartProps, type TextFormFieldDialogFields, TitleBar, TitleBarRight, Toolbar, type ToolbarActionProps, type ToolbarAlignmentComponent, ToolbarButton, type ToolbarButtonProps$1 as ToolbarButtonProps, ToolbarContext, type ToolbarContextValue, ToolbarGroup, ToolbarImageProperties, type ToolbarPartComponent, type ToolbarPartProps, type ToolbarProps, type ToolbarReviewersProps, type ToolbarSeparatorProps, type ToolbarSlotPartComponent, type ToolbarSlotPartProps, type ToolbarTranslate, type UseContentControlResult, type UseContentControlWidgetResult, type UseDialogReturn, type UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHistoryGroupReturn, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupDialogReturn, type UsePageSetupReturn, type UseParagraphDialogReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseTextFormFieldDialogReturn, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, definePopup, editorStateActiveSubscriptionCount, isFieldLink, navigationPaneReservation, navigationShift, normalizeImageBytes, notificationYieldsToTask, useProvidedDocxEditor as provideDocxEditor, reviewGutter, useChromeTranslate, useContentControl, useContentControlInstance, useContentControlWidget, useContextMenuTarget, useDocumentOutline, useDocumentSearch, useDocxEditor, useDocxSource, useEditorCaret, useEditorCommand, useEditorEvent, useEditorSnapshot, useEditorState, useEditorValueCommand, useFontFamily, useFonts, useHeaderFooterState, useHistoryGroup, useHyperlinkPopup, useHyperlinkPopupInstance, useNavigationPane, useNavigationShift, useNotePropertiesState, useNoteScopeState, usePageSetup, usePageSetupDialog, useParagraphDialog, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useTextFormFieldDialog, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };