@docx-editor.dev/react 2.32.0 → 2.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -11,13 +11,14 @@
11
11
  import * as react from 'react';
12
12
  import react__default, { ReactNode, CSSProperties, ReactElement, ComponentType, ButtonHTMLAttributes, ForwardRefExoticComponent, RefAttributes, HTMLAttributes, Ref } from 'react';
13
13
  import { UnsupportedElementRule, UnsupportedElement, RevisionMarkupDialogSession, ResolvedRevisionMarkup, RevisionMarkupOptions, ChromeExportFormat, InvalidTextFormFieldSession, ContentControlWidgetSession, CalendarMonth, ContentControlListNavigation, CalendarDay, TextFormFieldDialogSession, RevisionAuthorStyle, ParagraphDialogFields, ParagraphDialogMixed, BookmarkSortOrder, SplitCellLimits, 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';
14
- 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, UnsupportedElement, UnsupportedElementLayout, UnsupportedElementRule, WORD_DEFAULT_FONT, chromeMenuSlots, commandForSlot, composeFontConfiguration, composeFontOrigins, createDocumentRefresh, createFontSource, defineFontResolver, generateRulerTicks, isFontResolver, loadFonts, rulerPageBox, runToolbarCommand, toolbarCommandState } from '@docx-editor.dev/core/editor';
15
- import { Editor, ViewScope, EditorCommand, WatermarkState, BookmarkSummary, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TextMatch, ExecResult, DocumentOpenFailure, DocumentHandle, EditorExecOptions, EditorScope, EditorSnapshot, Watermark, EditorEvents, HighlightOptions, HighlightResult, HighlightRange, HighlightHit, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
14
+ 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, UnsupportedElement, UnsupportedElementLayout, UnsupportedElementRule, WORD_DEFAULT_FONT, chromeMenuSlots, commandForSlot, composeFontConfiguration, composeFontOrigins, createDocumentRefresh, createFontSource, deferFonts, defineFontResolver, generateRulerTicks, isFontResolver, loadFonts, rulerPageBox, runToolbarCommand, toolbarCommandState } from '@docx-editor.dev/core/editor';
15
+ import { Editor, ViewScope, EditorCommand, WatermarkState, BookmarkSummary, DocumentSource, FontConfiguration, ZoomMode, DocumentChange, EditorFontError, TableInteractionLabelKey, TextMatch, ExecResult, DocumentOpenFailure, DocumentHandle, EditorExecOptions, EditorScope, EditorSnapshot, Watermark, EditorEvents, HighlightOptions, HighlightResult, HighlightRange, HighlightHit, PageSetup, IndentFormatting, ColorValue, Theme } from '@docx-editor.dev/core/contracts/editor';
16
16
  export { AnchorHighlightAnimation, AnchorHighlightOptions, ClearAnchorHighlightOptions, DocumentOpenFailure, DocumentOpenFailureReason, Editor, EditorCommand, EditorFontError, EditorFontErrorCode, EditorQuery, EditorScope, EditorSnapshot, FontConfiguration, FontFaceRequest, FontSource, FontSourceSubstitution, HighlightHit, HighlightOptions, HighlightRange, HighlightRect, HighlightResult, PageSetup, ScrollToAnchorOptions, TextMatch, Watermark, WatermarkState } from '@docx-editor.dev/core/contracts/editor';
17
17
  import { TFunction, Translations, LocaleStrings } from '@docx-editor.dev/i18n';
18
18
  export { TranslationKey } from '@docx-editor.dev/i18n';
19
19
  import { ContentControlType, ContentControlSummary } from '@docx-editor.dev/core';
20
20
  export { DocxDocument } from '@docx-editor.dev/core/contracts/types';
21
+ export { DrawingGraphicKind, DrawingSupport, DrawingSupportIssue } from '@docx-editor.dev/core/store';
21
22
 
22
23
  /** @public */
23
24
  declare const VERSION: string;
@@ -38,8 +39,17 @@ type DocxEditorChildren = ReactNode;
38
39
  /** Props for a registered unsupported-content renderer. @public */
39
40
  interface DocxEditorUnsupportedElementProps extends UnsupportedElementRule {
40
41
  /**
41
- * Render this occurrence. Return `null`, `false`, an empty fragment or array, or whitespace to
42
- * keep the default placeholder.
42
+ * Include partially rendered drawings (`support: 'partial'`). Defaults to `false`.
43
+ * Excludes fully supported drawings, hidden drawings, and drawings without a layout position.
44
+ * Excludes shapes with editable text. Partially rendered shapes without text remain eligible.
45
+ */
46
+ includePartial?: UnsupportedElementRule['includePartial'];
47
+ /**
48
+ * Render this occurrence. Empty content preserves the drawing or placeholder.
49
+ * Empty content includes `null`, `false`, empty fragments or arrays, and whitespace.
50
+ * Child components can return empty content while an image loads.
51
+ * The editor calls this function for each occurrence. Put hooks in a returned child component.
52
+ * Use `drawingPreviewDocx` from `@docx-editor.dev/core/editor` to create a preview DOCX.
43
53
  */
44
54
  children: (props: {
45
55
  element: UnsupportedElement;
@@ -49,12 +59,15 @@ interface DocxEditorUnsupportedElementProps extends UnsupportedElementRule {
49
59
  * Register a renderer under DocxEditor or DocxEditor.Root.
50
60
  * The first mounted matching declaration wins. Prop updates retain its priority.
51
61
  * Omit match for a catch-all. Returning `null`, `false`, an empty fragment or array, or
52
- * whitespace keeps the default placeholder.
53
- * Layout uses points and only sizes content without an existing layout box.
62
+ * whitespace keeps what the editor shows.
63
+ * Layout uses points and only sizes content without an existing layout box. Custom content
64
+ * gets the occurrence's box (`element.bounds`); size it to 100% of the width and height.
65
+ * Clicking a custom preview selects the underlying drawing for moving, resizing, or deletion.
66
+ * Links, buttons, and form fields retain their normal behavior.
54
67
  * Components can remount when pagination or virtualization removes an occurrence.
55
68
  * @public
56
69
  */
57
- declare function DocxEditorUnsupportedElement({ match, layout, children, }: DocxEditorUnsupportedElementProps): react.JSX.Element[];
70
+ declare function DocxEditorUnsupportedElement({ match, layout, includePartial, children, }: DocxEditorUnsupportedElementProps): react.JSX.Element[];
58
71
 
59
72
  /**
60
73
  * Presentation overrides for a dialog part. @public
@@ -1450,7 +1463,7 @@ interface MenuItemBaseProps {
1450
1463
  *
1451
1464
  * @public
1452
1465
  */
1453
- declare function MenuItem(props: MenuItemProps): react.JSX.Element | null;
1466
+ declare function MenuItem(props: MenuItemProps): react.JSX.Element;
1454
1467
  declare namespace MenuItem {
1455
1468
  var docxMenuRow: true;
1456
1469
  }
@@ -1670,6 +1683,10 @@ interface ContextMenuTableRowProps extends ContextMenuCommandProps {
1670
1683
  /** When true, the row uses the destructive treatment. */
1671
1684
  destructive?: boolean;
1672
1685
  }
1686
+ /** Select every cell of the table at the selection. @public */
1687
+ declare const ContextMenuSelectTable: (({ icon, labelKey, className, hidden, destructive }: ContextMenuTableRowProps) => react.JSX.Element | null) & {
1688
+ docxRow: string;
1689
+ };
1673
1690
  /** Insert a row above the current table row. @public */
1674
1691
  declare const ContextMenuInsertRowAbove: (({ icon, labelKey, className, hidden, destructive }: ContextMenuTableRowProps) => react.JSX.Element | null) & {
1675
1692
  docxRow: string;
@@ -1719,6 +1736,10 @@ declare const ContextMenuRefreshToc: (({ icon, labelKey, className, hidden }: Co
1719
1736
  declare const ContextMenuRefreshTocPageNumbers: (({ icon, labelKey, className, hidden }: ContextMenuCommandProps) => react.JSX.Element | null) & {
1720
1737
  docxRow: string;
1721
1738
  };
1739
+ /** Remove the pointed-at table of contents, with its control and heading. @public */
1740
+ declare const ContextMenuRemoveToc: (({ icon, labelKey, className, hidden }: ContextMenuCommandProps) => react.JSX.Element | null) & {
1741
+ docxRow: string;
1742
+ };
1722
1743
  /** Props for `DocxEditor.ContextMenu.Item`: a host-owned row. @public */
1723
1744
  interface ContextMenuItemProps {
1724
1745
  /**
@@ -1791,6 +1812,7 @@ interface DocxEditorContextMenuNamespace {
1791
1812
  readonly PasteWithoutFormatting: typeof ContextMenuPasteWithoutFormatting;
1792
1813
  readonly Delete: typeof ContextMenuDelete;
1793
1814
  readonly SelectAll: typeof ContextMenuSelectAll;
1815
+ readonly SelectTable: typeof ContextMenuSelectTable;
1794
1816
  readonly InsertRowAbove: typeof ContextMenuInsertRowAbove;
1795
1817
  readonly InsertRowBelow: typeof ContextMenuInsertRowBelow;
1796
1818
  readonly InsertColumnLeft: typeof ContextMenuInsertColumnLeft;
@@ -1803,6 +1825,7 @@ interface DocxEditorContextMenuNamespace {
1803
1825
  readonly CellVerticalAlignment: typeof ContextMenuCellVerticalAlignment;
1804
1826
  readonly RefreshToc: typeof ContextMenuRefreshToc;
1805
1827
  readonly RefreshTocPageNumbers: typeof ContextMenuRefreshTocPageNumbers;
1828
+ readonly RemoveToc: typeof ContextMenuRemoveToc;
1806
1829
  /** A host-owned row: no slot, no command, the host's own label and action. */
1807
1830
  readonly Item: typeof ContextMenuItem;
1808
1831
  /** Any chrome slot as a live row (`<ContextMenu.Slot slotId="text.bold" />`). */
@@ -2084,9 +2107,17 @@ interface DocxEditorRootProps {
2084
2107
  * Localized labels for table insertion furniture. When omitted, core falls back to
2085
2108
  * bundled English through {@link defaultTableLabel}.
2086
2109
  */
2087
- tableInteractionLabel?: (key: 'table.insertRowBelow' | 'table.insertColumnRight') => string;
2110
+ tableInteractionLabel?: (key: TableInteractionLabelKey) => string;
2088
2111
  /** Optional decode port for embedded image insertion and paint in tests or custom hosts. */
2089
2112
  imageDecodePort?: ImageDecodePort;
2113
+ /**
2114
+ * Colour theme of the composed chrome, as on `<DocxEditor>`. `'dark'` puts `.dark` beside
2115
+ * `.docx-editor` on every part that scopes itself (toolbar, menu bar, viewport, dialogs),
2116
+ * and `'system'` follows the OS setting as it changes. Defaults to `'light'`. The page
2117
+ * content in the viewport is shown inverted in dark mode, as in `<DocxEditor>`. Changes
2118
+ * apply without a remount.
2119
+ */
2120
+ colorMode?: 'light' | 'dark' | 'system';
2090
2121
  children?: DocxEditorChildren;
2091
2122
  }
2092
2123
  /** @public Vue-only lifecycle listeners; exported for cross-adapter API parity. */
@@ -2254,7 +2285,7 @@ interface DocxEditorToolbarSlotProps {
2254
2285
  */
2255
2286
  hidden?: boolean;
2256
2287
  /**
2257
- * Content for the slot's "⋯" panel row when its group collapses. Without it the panel row
2288
+ * Content for the slot's "⋯" panel row when the slot leaves the bar. Without it the panel row
2258
2289
  * shows the children under the slot's label.
2259
2290
  */
2260
2291
  overflowContent?: () => DocxEditorChildren;
@@ -2707,8 +2738,8 @@ interface DocxEditorToolbarProps {
2707
2738
  */
2708
2739
  preset?: boolean;
2709
2740
  /**
2710
- * `false` lets the bar WRAP to more rows instead of collapsing groups into the "⋯"
2711
- * menu when it runs out of width. Default `true`.
2741
+ * `false` lets the bar WRAP to more rows instead of moving controls into the "⋯" menu,
2742
+ * one at a time, when it runs out of width. Default `true`.
2712
2743
  */
2713
2744
  overflow?: boolean;
2714
2745
  children?: DocxEditorChildren;
@@ -3815,9 +3846,9 @@ interface DocxEditorProps {
3815
3846
  /**
3816
3847
  * Render the packaged hyperlink popover (`false` removes it).
3817
3848
  *
3818
- * The engine's link GESTURES stay wired either way — a click on a link and Ctrl/Cmd+K
3819
- * still reach `useHyperlinkPopup()` — so a host that turns this off to render its own
3820
- * panel loses the packaged UI and nothing else.
3849
+ * A host that turns this off to render its own panel reads `useHyperlinkPopup()`: while
3850
+ * that panel is mounted, a click on a link, Ctrl/Cmd+K, and the Insert link controls open
3851
+ * it. With no link panel at all, the Insert link controls are disabled.
3821
3852
  */
3822
3853
  hyperlinkPopup?: boolean;
3823
3854
  /**
@@ -4096,7 +4127,6 @@ interface UseEditorStateOptions {
4096
4127
  */
4097
4128
  declare function useEditorState<T>(selector: (snapshot: EditorSnapshot) => T, isEqual?: (a: T, b: T) => boolean, options?: UseEditorStateOptions): T;
4098
4129
 
4099
- /** Coalesced deferred notifier for editor state ticks. @internal */
4100
4130
  /** Decide the scheduling lane for one coalesced notification. @internal */
4101
4131
  declare function notificationYieldsToTask(): boolean;
4102
4132
 
@@ -4109,9 +4139,45 @@ declare function notificationYieldsToTask(): boolean;
4109
4139
  * <div className={`${scope}docx-toolbar`} />
4110
4140
  * ```
4111
4141
  *
4142
+ * Under a `Root` whose `colorMode` resolved dark, the class is `'docx-editor dark '`, so a part
4143
+ * you build with the editor's `--doc-*` tokens follows the editor theme.
4144
+ *
4112
4145
  * Returns a trailing space so it concatenates cleanly, and `''` collapses away.
4113
4146
  */
4114
- declare function useScopeClassName(): '' | 'docx-editor ';
4147
+ declare function useScopeClassName(): '' | 'docx-editor ' | 'docx-editor dark ';
4148
+
4149
+ /**
4150
+ * The theme the enclosing editor resolved from `colorMode`, never `'system'`, as {@link useEditorColorMode} reports it.
4151
+ *
4152
+ * @public
4153
+ */
4154
+ type ResolvedColorMode = 'light' | 'dark';
4155
+ /**
4156
+ * What {@link useEditorColorMode} returns.
4157
+ *
4158
+ * @public
4159
+ */
4160
+ interface UseEditorColorModeReturn {
4161
+ /** The resolved theme: `'dark'` or `'light'`. Re-renders when `colorMode` or the OS setting changes. */
4162
+ readonly colorMode: ResolvedColorMode;
4163
+ }
4164
+ /**
4165
+ * The theme the enclosing `DocxEditor.Root` resolved from its `colorMode`, so parts you build
4166
+ * yourself can match the editor chrome. `'system'` resolves to the operating system's current
4167
+ * setting and re-renders when it changes. Outside a `Root`, or without `colorMode`, the answer
4168
+ * is `'light'`.
4169
+ *
4170
+ * @example
4171
+ * ```tsx
4172
+ * function MyPanel() {
4173
+ * const { colorMode } = useEditorColorMode();
4174
+ * return <aside className={colorMode === 'dark' ? 'panel panel--dark' : 'panel'} />;
4175
+ * }
4176
+ * ```
4177
+ *
4178
+ * @public
4179
+ */
4180
+ declare function useEditorColorMode(): UseEditorColorModeReturn;
4115
4181
 
4116
4182
  /** What `useWatermark` returns. @public */
4117
4183
  interface UseWatermarkReturn {
@@ -4229,18 +4295,40 @@ declare function Slot({ children, ...slotProps }: SlotProps): ReactElement<unkno
4229
4295
 
4230
4296
  interface LocaleProviderProps {
4231
4297
  i18n?: Translations;
4298
+ /**
4299
+ * The writing direction of the editor chrome. Defaults to the catalog's `_dir`, then to a
4300
+ * right-to-left `_lang`, then to the direction of an outer provider. With `'rtl'`, the
4301
+ * toolbar, menu bar, dialogs, context menu, panes, and review column mirror without a
4302
+ * wrapper element. `'ltr'` keeps a left-to-right chrome on a right-to-left host page.
4303
+ * Without any of these, as with the shipped left-to-right catalogs, the chrome inherits
4304
+ * the host page direction.
4305
+ */
4306
+ dir?: 'ltr' | 'rtl';
4232
4307
  children: DocxEditorChildren;
4233
4308
  }
4234
- declare function LocaleProvider({ i18n, children }: LocaleProviderProps): react.JSX.Element;
4309
+ declare function LocaleProvider({ i18n, dir, children }: LocaleProviderProps): react.JSX.Element;
4235
4310
  /**
4236
- * The active catalogue's `t()`, the catalogue itself, and its language tag (`_lang`, `en`
4237
- * by default), which formats numbers the way the strings around them read.
4311
+ * The active catalogue's `t()`, the catalogue itself, its language tag (`_lang`, `en` by
4312
+ * default), which formats numbers the way the strings around them read, and the providers'
4313
+ * writing direction (`dir`). `dir` is `'ltr'` when the chrome inherits a right-to-left host
4314
+ * page; `useChromeDir()` returns the direction a provider decided, or `undefined` then.
4238
4315
  */
4239
4316
  declare function useTranslation(): {
4240
4317
  t: TFunction;
4241
4318
  catalogue: LocaleStrings;
4242
4319
  lang: string;
4320
+ dir: 'ltr' | 'rtl';
4243
4321
  };
4322
+ /**
4323
+ * The `dir` attribute a chrome part sets on its root: the direction a provider decided
4324
+ * (its `dir` prop, the catalog's `_dir`, or a right-to-left `_lang`), otherwise nothing, so
4325
+ * the part keeps the host page direction.
4326
+ *
4327
+ * Read it in your own controls to follow the editor chrome: `undefined` means the chrome
4328
+ * inherits the host page direction, so set no `dir` then.
4329
+ * @public
4330
+ */
4331
+ declare function useChromeDir(): 'ltr' | 'rtl' | undefined;
4244
4332
 
4245
4333
  /**
4246
4334
  * A chrome-part label resolver: plain string keys, optional interpolation params.
@@ -4360,10 +4448,11 @@ declare function isFieldLink(link: SurfaceHyperlink): boolean;
4360
4448
  /**
4361
4449
  * The hyperlink popover's behavior.
4362
4450
  *
4363
- * Inside a `DocxEditor.HyperLink` (which the packaged editor mounts by default) this is the
4364
- * SHARED state that compound is driving, so a custom toolbar button and the popover agree.
4365
- * Outside one it is a standalone instance that registers with the engine itself — a host
4366
- * building its own link UI from scratch needs nothing else.
4451
+ * Inside `DocxEditor.Root` this is the SHARED state that `DocxEditor.HyperLink` renders, so
4452
+ * a custom panel and the toolbar agree. Calling it marks the component as a view of that
4453
+ * state: while one is mounted, link clicks, Ctrl/Cmd+K and the Insert link controls open
4454
+ * it. Outside a root it is a standalone instance that registers with the engine itself — a
4455
+ * host building its own link UI from scratch needs nothing else.
4367
4456
  *
4368
4457
  * @public
4369
4458
  */
@@ -5476,7 +5565,8 @@ declare function Toolbar(explicitProps: ToolbarProps): react__default.JSX.Elemen
5476
5565
  */
5477
5566
  type RulerPageSetup = NonNullable<ReturnType<Editor['getPageSetup']>>;
5478
5567
  /**
5479
- * A tab stop the ruler paints. `position` is twips from the left margin edge —
5568
+ * A tab stop the ruler paints. `position` is twips from the paragraph's leading margin
5569
+ * (the right one for a right-to-left paragraph) —
5480
5570
  * the same value the `removeTabMark` command takes as `positionTwips`.
5481
5571
  */
5482
5572
  interface RulerTabStop {
@@ -5739,5 +5829,5 @@ interface UseHistoryGroupReturn {
5739
5829
  /** Bind a control's native gesture lifecycle. Apply values through the existing command hooks. @public */
5740
5830
  declare function useHistoryGroup({ kind }: HistoryGroupBindingOptions): UseHistoryGroupReturn;
5741
5831
 
5742
- export { CONTENT_CONTROL_SLOTS, ContextMenuCellVerticalAlignment, ContextMenuCopy, ContextMenuCopyFormatting, ContextMenuCut, ContextMenuDelete, ContextMenuDeleteTable, ContextMenuDeleteTableColumn, ContextMenuDeleteTableRow, ContextMenuInsertColumnLeft, ContextMenuInsertColumnRight, ContextMenuInsertRowAbove, ContextMenuInsertRowBelow, ContextMenuItem, ContextMenuMergeCells, ContextMenuPaste, ContextMenuPasteFormatting, ContextMenuPasteWithoutFormatting, ContextMenuRefreshToc, ContextMenuRefreshTocPageNumbers, ContextMenuSelectAll, ContextMenuSplitCell, DEFAULT_WATERMARK_PRESETS, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, DocxEditorBookmarkDialog, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, DocxEditorContentControlWidget, DocxEditorContextMenu, DocxEditorDocumentOutline, DocxEditorEquation, DocxEditorExportDialog, DocxEditorFontNotice, DocxEditorHeaderFooterChrome, DocxEditorHorizontalRuler, DocxEditorHyperLink, DocxEditorImageAltTextPopup, DocxEditorImageInsertErrorDialog, DocxEditorImagePropertiesDialog, DocxEditorInvalidTextFormFieldDialog, DocxEditorLoading, DocxEditorLoadingSpinner, DocxEditorMenu, DocxEditorNavigation, DocxEditorNotePreview, DocxEditorNotePropertiesDialog, DocxEditorNotesChrome, DocxEditorNotesContextMenu, DocxEditorOpenFailure, DocxEditorOpenFailureAction, DocxEditorPageNumber, DocxEditorPageSetupDialog, DocxEditorParagraphDialog, DocxEditorPrintDialog, DocxEditorRevisionMarkup, DocxEditorRevisionMarkupDialog, DocxEditorRoot, DocxEditorShell, DocxEditorSplitCellDialog, DocxEditorTextFormFieldDialog, DocxEditorToolbar, DocxEditorUnsupportedElement, DocxEditorVerticalRuler, DocxEditorViewport, DocxEditorWatermarkDialog, DocxEditorWindow, HorizontalRuler, ImageAltText, ImageInsertProvider, ImageInsertTrigger, ImagePropertiesTrigger, ImageWrap, LocaleProvider, Logo, MenuBar, NAVIGATION_PANE_GAP, NAVIGATION_PANE_INSET, NAVIGATION_PANE_MIN_PAGE_ROOM, NAVIGATION_PANE_WIDTH, NavigationClose, NavigationFind, NavigationGoTo, NavigationHeader, NavigationHeadings, NavigationTab, NavigationTabs, NavigationTitle, NavigationToggle, OUTLINE_BUTTON_LEFT_OFFSET, OUTLINE_BUTTON_RESERVED_SPACE, OUTLINE_LEFT_OFFSET, OUTLINE_RESERVED_SPACE, PageIndicator, PageNumberTranslationContext, PaginatedDocxEditor, PaginatedDocxEditorShell, REVIEW_MARKERS_GUTTER, REVIEW_PANE_GUTTER, RULER_WIDTH, ReviewRailContext, Slot, TitleBar, TitleBarRight, Toolbar, ToolbarButton, ToolbarContext, ToolbarGroup, ToolbarImageProperties, VERSION, VerticalRuler, definePopup, editorStateActiveSubscriptionCount, isFieldLink, navigationPaneOverlays, navigationPaneReservation, navigationShift, normalizeImageBytes, notificationYieldsToTask, useProvidedDocxEditor as provideDocxEditor, reviewGutter, useBookmarkDialog, useBookmarks, useChromeTranslate, useCommentDraftRequest, useContentControl, useContentControlInstance, useContentControlWidget, useContextMenuTarget, useDocumentOutline, useDocumentSearch, useDocxEditor, useDocxSource, useEditorCaret, useEditorCommand, useEditorEvent, useEditorHostDocument, useEditorSnapshot, useEditorState, useEditorValueCommand, useFontFamily, useFonts, useGoToBookmark, useHeaderFooterState, useHighlightAt, useHighlights, useHistoryGroup, useHyperlinkPopup, useHyperlinkPopupInstance, useNavigationPane, useNavigationShift, useNotePropertiesState, useNoteScopeState, useOpenFailure, usePageSetup, usePageSetupDialog, useParagraphDialog, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useRevisionMarkupDialog, useScopeClassName, useScopedChromeAnchor, useSplitCellDialog, useTableBorderTargetLabel, useTextFormFieldDialog, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useWatermark, useWatermarkDialog, useZoom };
5743
- export type { BookmarkDialogFields, ChromeTranslate, ContentControlActionProps, ContentControlInspectorState, ContentControlLock, ContentControlPartProps, ContentControlProps, ContentControlSlotId, ContentControlWidgetDayProps, ContentControlWidgetEntry, ContentControlWidgetItemProps, ContentControlWidgetPictureProps, ContextMenuAnchor, ContextMenuCommandProps, ContextMenuContextValue, ContextMenuItemProps, ContextMenuTableRowProps, DialogCustomizationProps, DialogPartProps, DocumentStyleSummary, DocxEditorAuthorStyleProps, DocxEditorBookmarkDialogProps, DocxEditorChildren, DocxEditorContentControlNamespace, DocxEditorContentControlWidgetNamespace, DocxEditorContentControlWidgetPartProps, DocxEditorContentControlWidgetProps, DocxEditorContentProps, DocxEditorContextMenuNamespace, DocxEditorContextMenuProps, DocxEditorDocumentOutlineProps, DocxEditorExportDialogProps, DocxEditorFontNoticeProps, DocxEditorHeaderFooterChromeProps, DocxEditorHyperLinkNamespace, DocxEditorImageAltTextPopupProps, DocxEditorImageInsertErrorDialogProps, DocxEditorImagePropertiesDialogProps, DocxEditorInvalidTextFormFieldDialogProps, DocxEditorLoadingComponent, DocxEditorLoadingProps, DocxEditorLoadingSpinnerProps, DocxEditorMenuNamespace, DocxEditorMenuProps, DocxEditorNamespace, DocxEditorNavigationNamespace, DocxEditorNavigationProps, DocxEditorNotePreviewProps, DocxEditorNotePropertiesDialogProps, DocxEditorNotesChromeProps, DocxEditorNotesContextMenuProps, DocxEditorOpenFailureActionProps, DocxEditorOpenFailureComponent, DocxEditorOpenFailureContext, DocxEditorOpenFailureMessage, DocxEditorOpenFailureProps, DocxEditorPageNumberProps, DocxEditorPageSetupDialogProps, DocxEditorParagraphDialogProps, DocxEditorPopup, DocxEditorPopups, DocxEditorPrintDialogProps, DocxEditorProps, DocxEditorRef, DocxEditorRefCallback, DocxEditorRevisionMarkupDialogProps, DocxEditorRevisionMarkupProps, DocxEditorRootListeners, DocxEditorRootProps, DocxEditorRulerProps, DocxEditorSplitCellDialogProps, DocxEditorTextFormFieldDialogProps, DocxEditorToolbarGroupProps, DocxEditorToolbarNamespace, DocxEditorToolbarProps, DocxEditorToolbarSlotProps, DocxEditorUnsupportedElementProps, DocxEditorViewportProps, DocxEditorWatermarkDialogProps, DocxEditorWindowProps, DocxFontOrigin, DocxFontsInput, DocxFontsSource, DocxSource, EditorCaret, EditorCommandState, EditorMode, EditorValueCommandState, FontFamilyItemProps, FontFamilyNamespace, FontFamilyPartProps, FontFamilyProps, FontOption, FontsInput, FormattingAction, GoToBookmarkProblem, HeaderFooterState, HorizontalRulerProps$1 as HorizontalRulerProps, HyperLinkActionProps, HyperLinkPartProps, HyperLinkProps, HyperlinkPopupAnchor, HyperlinkPopupMode, HyperlinkPopupState, ImagePropertiesTriggerProps, IndentUpdate, ListState, ListType, LocaleProviderProps, MaybeRefOrGetter, MenuActionProps, MenuGroupProps, MenuId, MenuItemBaseProps, MenuItemProps, MenuPartComponent, MenuProps, MenuReportIssueProps, MenuReviewersProps, MenuRowProps, MenuSeparatorProps, MenuSubmenuBaseProps, MenuSubmenuProps, MenuTableGridProps, NavigationPartProps, NavigationShiftInput, NavigationTabProps, NavigationTab$1 as NavigationTabValue, NormalizedImagePayload, NotePropertiesState, OutlineHeading$1 as OutlineHeading, OutlineHeadingItem, PageIndicatorProps, PageSetupDialogFields, PageSetupUpdate, PaginatedDocxEditorExpose, PaginatedDocxEditorHandle, PaginatedDocxEditorProps, PaginatedDocxEditorShellProps, ParagraphAlignment, ParagraphStyleItemProps, ParagraphStyleNamespace, ParagraphStyleOption, ParagraphStylePartProps, ParagraphStyleProps, ProvideDocxEditorResult, ReviewGutter, ReviewGutterInput, ReviewRailRegistry, ScopedChromeAnchor, ScopedChromeAnchorPlacement, SelectionFormatting, SlotProps, SplitCellDialogFields, TableAction, TableBorderColorNamespace, TableBorderStyleNamespace, TableBorderTargetNamespace, TableBorderWidthNamespace, TableCellFillNamespace, TableChromeItemProps, TableChromePartComponent, TableChromePartProps, TextFormFieldDialogFields, ToolbarActionProps, ToolbarAlignmentComponent, ToolbarButtonProps$1 as ToolbarButtonProps, ToolbarContextValue, ToolbarPartComponent, ToolbarPartProps, ToolbarProps, ToolbarReviewersProps, ToolbarSeparatorProps, ToolbarSlotPartComponent, ToolbarSlotPartProps, ToolbarTranslate, UseBookmarkDialogReturn, UseBookmarksReturn, UseContentControlResult, UseContentControlWidgetResult, UseDialogReturn, UseDocumentOutlineResult, UseDocumentSearchOptions, UseDocumentSearchResult, UseDocxSourceOptions, UseDocxSourceResult, UseEditorHostDocumentReturn, UseFontFamilyResult, UseGoToBookmarkOptions, UseGoToBookmarkReturn, UseHistoryGroupReturn, UseHyperlinkPopupResult, UseNavigationPaneOptions, UseNavigationPaneResult, UseOpenFailureOptions, UseOpenFailureReturn, UsePageSetupDialogReturn, UsePageSetupReturn, UseParagraphDialogReturn, UseParagraphFormatReturn, UseParagraphIndentReturn, UseParagraphStyleResult, UseRevisionMarkupDialogReturn, UseSplitCellDialogReturn, UseTextFormFieldDialogReturn, UseWatermarkDialogReturn, UseWatermarkReturn, UseZoomResult, VerticalRulerProps, WatermarkDialogFieldName, WatermarkDialogFields, WatermarkDialogKind, WatermarkDialogLayout };
5832
+ export { CONTENT_CONTROL_SLOTS, ContextMenuCellVerticalAlignment, ContextMenuCopy, ContextMenuCopyFormatting, ContextMenuCut, ContextMenuDelete, ContextMenuDeleteTable, ContextMenuDeleteTableColumn, ContextMenuDeleteTableRow, ContextMenuInsertColumnLeft, ContextMenuInsertColumnRight, ContextMenuInsertRowAbove, ContextMenuInsertRowBelow, ContextMenuItem, ContextMenuMergeCells, ContextMenuPaste, ContextMenuPasteFormatting, ContextMenuPasteWithoutFormatting, ContextMenuRefreshToc, ContextMenuRefreshTocPageNumbers, ContextMenuRemoveToc, ContextMenuSelectAll, ContextMenuSelectTable, ContextMenuSplitCell, DEFAULT_WATERMARK_PRESETS, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, DocxEditorBookmarkDialog, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, DocxEditorContentControlWidget, DocxEditorContextMenu, DocxEditorDocumentOutline, DocxEditorEquation, DocxEditorExportDialog, DocxEditorFontNotice, DocxEditorHeaderFooterChrome, DocxEditorHorizontalRuler, DocxEditorHyperLink, DocxEditorImageAltTextPopup, DocxEditorImageInsertErrorDialog, DocxEditorImagePropertiesDialog, DocxEditorInvalidTextFormFieldDialog, DocxEditorLoading, DocxEditorLoadingSpinner, DocxEditorMenu, DocxEditorNavigation, DocxEditorNotePreview, DocxEditorNotePropertiesDialog, DocxEditorNotesChrome, DocxEditorNotesContextMenu, DocxEditorOpenFailure, DocxEditorOpenFailureAction, DocxEditorPageNumber, DocxEditorPageSetupDialog, DocxEditorParagraphDialog, DocxEditorPrintDialog, DocxEditorRevisionMarkup, DocxEditorRevisionMarkupDialog, DocxEditorRoot, DocxEditorShell, DocxEditorSplitCellDialog, DocxEditorTextFormFieldDialog, DocxEditorToolbar, DocxEditorUnsupportedElement, DocxEditorVerticalRuler, DocxEditorViewport, DocxEditorWatermarkDialog, DocxEditorWindow, HorizontalRuler, ImageAltText, ImageInsertProvider, ImageInsertTrigger, ImagePropertiesTrigger, ImageWrap, LocaleProvider, Logo, MenuBar, NAVIGATION_PANE_GAP, NAVIGATION_PANE_INSET, NAVIGATION_PANE_MIN_PAGE_ROOM, NAVIGATION_PANE_WIDTH, NavigationClose, NavigationFind, NavigationGoTo, NavigationHeader, NavigationHeadings, NavigationTab, NavigationTabs, NavigationTitle, NavigationToggle, OUTLINE_BUTTON_LEFT_OFFSET, OUTLINE_BUTTON_RESERVED_SPACE, OUTLINE_LEFT_OFFSET, OUTLINE_RESERVED_SPACE, PageIndicator, PageNumberTranslationContext, PaginatedDocxEditor, PaginatedDocxEditorShell, REVIEW_MARKERS_GUTTER, REVIEW_PANE_GUTTER, RULER_WIDTH, ReviewRailContext, Slot, TitleBar, TitleBarRight, Toolbar, ToolbarButton, ToolbarContext, ToolbarGroup, ToolbarImageProperties, VERSION, VerticalRuler, definePopup, editorStateActiveSubscriptionCount, isFieldLink, navigationPaneOverlays, navigationPaneReservation, navigationShift, normalizeImageBytes, notificationYieldsToTask, useProvidedDocxEditor as provideDocxEditor, reviewGutter, useBookmarkDialog, useBookmarks, useChromeDir, useChromeTranslate, useCommentDraftRequest, useContentControl, useContentControlInstance, useContentControlWidget, useContextMenuTarget, useDocumentOutline, useDocumentSearch, useDocxEditor, useDocxSource, useEditorCaret, useEditorColorMode, useEditorCommand, useEditorEvent, useEditorHostDocument, useEditorSnapshot, useEditorState, useEditorValueCommand, useFontFamily, useFonts, useGoToBookmark, useHeaderFooterState, useHighlightAt, useHighlights, useHistoryGroup, useHyperlinkPopup, useHyperlinkPopupInstance, useNavigationPane, useNavigationShift, useNotePropertiesState, useNoteScopeState, useOpenFailure, usePageSetup, usePageSetupDialog, useParagraphDialog, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useRevisionMarkupDialog, useScopeClassName, useScopedChromeAnchor, useSplitCellDialog, useTableBorderTargetLabel, useTextFormFieldDialog, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useWatermark, useWatermarkDialog, useZoom };
5833
+ export type { BookmarkDialogFields, ChromeTranslate, ContentControlActionProps, ContentControlInspectorState, ContentControlLock, ContentControlPartProps, ContentControlProps, ContentControlSlotId, ContentControlWidgetDayProps, ContentControlWidgetEntry, ContentControlWidgetItemProps, ContentControlWidgetPictureProps, ContextMenuAnchor, ContextMenuCommandProps, ContextMenuContextValue, ContextMenuItemProps, ContextMenuTableRowProps, DialogCustomizationProps, DialogPartProps, DocumentStyleSummary, DocxEditorAuthorStyleProps, DocxEditorBookmarkDialogProps, DocxEditorChildren, DocxEditorContentControlNamespace, DocxEditorContentControlWidgetNamespace, DocxEditorContentControlWidgetPartProps, DocxEditorContentControlWidgetProps, DocxEditorContentProps, DocxEditorContextMenuNamespace, DocxEditorContextMenuProps, DocxEditorDocumentOutlineProps, DocxEditorExportDialogProps, DocxEditorFontNoticeProps, DocxEditorHeaderFooterChromeProps, DocxEditorHyperLinkNamespace, DocxEditorImageAltTextPopupProps, DocxEditorImageInsertErrorDialogProps, DocxEditorImagePropertiesDialogProps, DocxEditorInvalidTextFormFieldDialogProps, DocxEditorLoadingComponent, DocxEditorLoadingProps, DocxEditorLoadingSpinnerProps, DocxEditorMenuNamespace, DocxEditorMenuProps, DocxEditorNamespace, DocxEditorNavigationNamespace, DocxEditorNavigationProps, DocxEditorNotePreviewProps, DocxEditorNotePropertiesDialogProps, DocxEditorNotesChromeProps, DocxEditorNotesContextMenuProps, DocxEditorOpenFailureActionProps, DocxEditorOpenFailureComponent, DocxEditorOpenFailureContext, DocxEditorOpenFailureMessage, DocxEditorOpenFailureProps, DocxEditorPageNumberProps, DocxEditorPageSetupDialogProps, DocxEditorParagraphDialogProps, DocxEditorPopup, DocxEditorPopups, DocxEditorPrintDialogProps, DocxEditorProps, DocxEditorRef, DocxEditorRefCallback, DocxEditorRevisionMarkupDialogProps, DocxEditorRevisionMarkupProps, DocxEditorRootListeners, DocxEditorRootProps, DocxEditorRulerProps, DocxEditorSplitCellDialogProps, DocxEditorTextFormFieldDialogProps, DocxEditorToolbarGroupProps, DocxEditorToolbarNamespace, DocxEditorToolbarProps, DocxEditorToolbarSlotProps, DocxEditorUnsupportedElementProps, DocxEditorViewportProps, DocxEditorWatermarkDialogProps, DocxEditorWindowProps, DocxFontOrigin, DocxFontsInput, DocxFontsSource, DocxSource, EditorCaret, EditorCommandState, EditorMode, EditorValueCommandState, FontFamilyItemProps, FontFamilyNamespace, FontFamilyPartProps, FontFamilyProps, FontOption, FontsInput, FormattingAction, GoToBookmarkProblem, HeaderFooterState, HorizontalRulerProps$1 as HorizontalRulerProps, HyperLinkActionProps, HyperLinkPartProps, HyperLinkProps, HyperlinkPopupAnchor, HyperlinkPopupMode, HyperlinkPopupState, ImagePropertiesTriggerProps, IndentUpdate, ListState, ListType, LocaleProviderProps, MaybeRefOrGetter, MenuActionProps, MenuGroupProps, MenuId, MenuItemBaseProps, MenuItemProps, MenuPartComponent, MenuProps, MenuReportIssueProps, MenuReviewersProps, MenuRowProps, MenuSeparatorProps, MenuSubmenuBaseProps, MenuSubmenuProps, MenuTableGridProps, NavigationPartProps, NavigationShiftInput, NavigationTabProps, NavigationTab$1 as NavigationTabValue, NormalizedImagePayload, NotePropertiesState, OutlineHeading$1 as OutlineHeading, OutlineHeadingItem, PageIndicatorProps, PageSetupDialogFields, PageSetupUpdate, PaginatedDocxEditorExpose, PaginatedDocxEditorHandle, PaginatedDocxEditorProps, PaginatedDocxEditorShellProps, ParagraphAlignment, ParagraphStyleItemProps, ParagraphStyleNamespace, ParagraphStyleOption, ParagraphStylePartProps, ParagraphStyleProps, ProvideDocxEditorResult, ResolvedColorMode, ReviewGutter, ReviewGutterInput, ReviewRailRegistry, ScopedChromeAnchor, ScopedChromeAnchorPlacement, SelectionFormatting, SlotProps, SplitCellDialogFields, TableAction, TableBorderColorNamespace, TableBorderStyleNamespace, TableBorderTargetNamespace, TableBorderWidthNamespace, TableCellFillNamespace, TableChromeItemProps, TableChromePartComponent, TableChromePartProps, TextFormFieldDialogFields, ToolbarActionProps, ToolbarAlignmentComponent, ToolbarButtonProps$1 as ToolbarButtonProps, ToolbarContextValue, ToolbarPartComponent, ToolbarPartProps, ToolbarProps, ToolbarReviewersProps, ToolbarSeparatorProps, ToolbarSlotPartComponent, ToolbarSlotPartProps, ToolbarTranslate, UseBookmarkDialogReturn, UseBookmarksReturn, UseContentControlResult, UseContentControlWidgetResult, UseDialogReturn, UseDocumentOutlineResult, UseDocumentSearchOptions, UseDocumentSearchResult, UseDocxSourceOptions, UseDocxSourceResult, UseEditorColorModeReturn, UseEditorHostDocumentReturn, UseFontFamilyResult, UseGoToBookmarkOptions, UseGoToBookmarkReturn, UseHistoryGroupReturn, UseHyperlinkPopupResult, UseNavigationPaneOptions, UseNavigationPaneResult, UseOpenFailureOptions, UseOpenFailureReturn, UsePageSetupDialogReturn, UsePageSetupReturn, UseParagraphDialogReturn, UseParagraphFormatReturn, UseParagraphIndentReturn, UseParagraphStyleResult, UseRevisionMarkupDialogReturn, UseSplitCellDialogReturn, UseTextFormFieldDialogReturn, UseWatermarkDialogReturn, UseWatermarkReturn, UseZoomResult, VerticalRulerProps, WatermarkDialogFieldName, WatermarkDialogFields, WatermarkDialogKind, WatermarkDialogLayout };