@docx-editor.dev/react 2.13.0 → 2.14.1
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.mts +32 -7
- package/dist/index.d.ts +32 -7
- package/dist/index.js +3 -3
- package/dist/index.mjs +3 -3
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -345,6 +345,19 @@ interface DocxEditorViewportProps {
|
|
|
345
345
|
*/
|
|
346
346
|
declare function DocxEditorViewport({ className, style, children }: DocxEditorViewportProps): react.JSX.Element;
|
|
347
347
|
|
|
348
|
+
/** Props for `DocxEditor.Toolbar.Reviewers`. @public */
|
|
349
|
+
type ToolbarReviewersProps = {
|
|
350
|
+
className?: string;
|
|
351
|
+
hidden?: boolean;
|
|
352
|
+
/** Custom trigger icon. */
|
|
353
|
+
icon?: DocxEditorChildren;
|
|
354
|
+
};
|
|
355
|
+
/** The reviewer visibility menu. It changes view state only. @public */
|
|
356
|
+
declare function ToolbarReviewers({ className, hidden, icon }: ToolbarReviewersProps): react.JSX.Element | null;
|
|
357
|
+
declare namespace ToolbarReviewers {
|
|
358
|
+
var docxSlot: "review.authors";
|
|
359
|
+
}
|
|
360
|
+
|
|
348
361
|
/** Resolves an i18n key to display text. @public */
|
|
349
362
|
type ToolbarTranslate = (key: string) => string;
|
|
350
363
|
interface ToolbarContextValue {
|
|
@@ -906,6 +919,7 @@ interface DocxEditorToolbarNamespace {
|
|
|
906
919
|
readonly Zoom: ToolbarSlotPartComponent;
|
|
907
920
|
readonly StylePicker: typeof ParagraphStyle;
|
|
908
921
|
readonly EditingMode: ToolbarSlotPartComponent;
|
|
922
|
+
readonly Reviewers: typeof ToolbarReviewers;
|
|
909
923
|
readonly Save: ToolbarSlotPartComponent;
|
|
910
924
|
readonly ContentControlShowAll: ToolbarPartComponent;
|
|
911
925
|
readonly ContentControlFormFill: ToolbarPartComponent;
|
|
@@ -921,7 +935,7 @@ interface DocxEditorToolbarNamespace {
|
|
|
921
935
|
declare const DocxEditorToolbar: DocxEditorToolbarNamespace;
|
|
922
936
|
|
|
923
937
|
/**
|
|
924
|
-
* A menu's identity: one of the registry's
|
|
938
|
+
* A menu's identity: one of the registry's five, or a HOST'S OWN.
|
|
925
939
|
*
|
|
926
940
|
* The `(string & {})` arm keeps the registry ids as editor autocomplete while accepting
|
|
927
941
|
* any other string, so a product can add "Review" or "Clauses" without the library having
|
|
@@ -1110,7 +1124,7 @@ declare function MenuSeparator({ className }: MenuSeparatorProps): react.JSX.Ele
|
|
|
1110
1124
|
declare function MenuEntry({ entry }: {
|
|
1111
1125
|
entry: ChromeMenuEntry;
|
|
1112
1126
|
}): react.JSX.Element;
|
|
1113
|
-
/** Props for `DocxEditor.Menu.Menu` and the
|
|
1127
|
+
/** Props for `DocxEditor.Menu.Menu` and the five pinned menu parts. @public */
|
|
1114
1128
|
interface MenuProps {
|
|
1115
1129
|
/** Which menu this is. Only one panel in the bar is open at a time, keyed on this. */
|
|
1116
1130
|
id: MenuId;
|
|
@@ -1195,6 +1209,15 @@ declare const MenuReportIssue: typeof MenuReportIssueImpl & {
|
|
|
1195
1209
|
docxSlot: string;
|
|
1196
1210
|
};
|
|
1197
1211
|
|
|
1212
|
+
type MenuReviewersProps = {
|
|
1213
|
+
className?: string;
|
|
1214
|
+
hidden?: boolean;
|
|
1215
|
+
};
|
|
1216
|
+
/** The document-dependent Reviewers submenu. It changes view state only. @public */
|
|
1217
|
+
declare function MenuReviewers({ className, hidden }: MenuReviewersProps): react.JSX.Element | null;
|
|
1218
|
+
/** The packaged top-level Review menu. @public */
|
|
1219
|
+
declare const MenuReview: MenuPartComponent;
|
|
1220
|
+
|
|
1198
1221
|
/** Props for `DocxEditor.Menu`. @public */
|
|
1199
1222
|
interface DocxEditorMenuProps {
|
|
1200
1223
|
/** Appended after the base `docx-menubar` class. */
|
|
@@ -1245,6 +1268,7 @@ interface DocxEditorMenuNamespace {
|
|
|
1245
1268
|
readonly File: MenuPartComponent;
|
|
1246
1269
|
readonly Format: MenuPartComponent;
|
|
1247
1270
|
readonly Insert: MenuPartComponent;
|
|
1271
|
+
readonly Review: typeof MenuReview;
|
|
1248
1272
|
readonly Help: MenuPartComponent;
|
|
1249
1273
|
/** One chrome slot as a live row. */
|
|
1250
1274
|
readonly Item: typeof MenuItem;
|
|
@@ -1263,11 +1287,13 @@ interface DocxEditorMenuNamespace {
|
|
|
1263
1287
|
readonly PageSetup: typeof MenuPageSetup;
|
|
1264
1288
|
/** Insert › Image, so a host can hide it or place it elsewhere by name. */
|
|
1265
1289
|
readonly ImageInsert: typeof MenuImageInsert;
|
|
1290
|
+
/** Review > Markup Options > Reviewers. */
|
|
1291
|
+
readonly Reviewers: typeof MenuReviewers;
|
|
1266
1292
|
/** Help › Report issue, so a host can drop it or point it elsewhere by name. */
|
|
1267
1293
|
readonly ReportIssue: typeof MenuReportIssue;
|
|
1268
1294
|
}
|
|
1269
1295
|
/**
|
|
1270
|
-
* The compound menu bar: `<DocxEditor.Menu/>` for File · Format · Insert · Help, parts as
|
|
1296
|
+
* The compound menu bar: `<DocxEditor.Menu/>` for File · Format · Insert · Review · Help, parts as
|
|
1271
1297
|
* statics for composition.
|
|
1272
1298
|
*
|
|
1273
1299
|
* Every actionable row is a chrome slot, so a row and its toolbar twin share one label,
|
|
@@ -2938,9 +2964,8 @@ declare function useContentControlInstance(): UseContentControlResult;
|
|
|
2938
2964
|
* change appears, then authors who only commented. One person is one colour across the two.
|
|
2939
2965
|
* Once assigned, a slot stays with that author for the attached document session.
|
|
2940
2966
|
*
|
|
2941
|
-
*
|
|
2942
|
-
*
|
|
2943
|
-
* only if they also commented.
|
|
2967
|
+
* The complete attached-document roster. An author remains here while the current review
|
|
2968
|
+
* view hides their revisions and comments, so reviewer chrome can turn them on again.
|
|
2944
2969
|
*
|
|
2945
2970
|
* The array is reference-stable between changes (the facade caches per layout and colour
|
|
2946
2971
|
* state), so it is safe as a dependency and under `useSyncExternalStore`.
|
|
@@ -4040,4 +4065,4 @@ declare function VerticalRuler({ pageSetup, zoom, editable, onTopMarginChange, o
|
|
|
4040
4065
|
*/
|
|
4041
4066
|
declare function useEditorSnapshot(editor: Editor | null): number;
|
|
4042
4067
|
|
|
4043
|
-
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, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, 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 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 PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphFlagState, type ParagraphFormatRead, type ParagraphFormatUpdate, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ParagraphTabStop, 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, 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 ToolbarSeparatorProps, type ToolbarSlotPartComponent, type ToolbarSlotPartProps, type ToolbarTranslate, type UseContentControlResult, type UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, 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, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };
|
|
4068
|
+
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, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, 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 PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphFlagState, type ParagraphFormatRead, type ParagraphFormatUpdate, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ParagraphTabStop, 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, 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 UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, 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, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };
|
package/dist/index.d.ts
CHANGED
|
@@ -345,6 +345,19 @@ interface DocxEditorViewportProps {
|
|
|
345
345
|
*/
|
|
346
346
|
declare function DocxEditorViewport({ className, style, children }: DocxEditorViewportProps): react.JSX.Element;
|
|
347
347
|
|
|
348
|
+
/** Props for `DocxEditor.Toolbar.Reviewers`. @public */
|
|
349
|
+
type ToolbarReviewersProps = {
|
|
350
|
+
className?: string;
|
|
351
|
+
hidden?: boolean;
|
|
352
|
+
/** Custom trigger icon. */
|
|
353
|
+
icon?: DocxEditorChildren;
|
|
354
|
+
};
|
|
355
|
+
/** The reviewer visibility menu. It changes view state only. @public */
|
|
356
|
+
declare function ToolbarReviewers({ className, hidden, icon }: ToolbarReviewersProps): react.JSX.Element | null;
|
|
357
|
+
declare namespace ToolbarReviewers {
|
|
358
|
+
var docxSlot: "review.authors";
|
|
359
|
+
}
|
|
360
|
+
|
|
348
361
|
/** Resolves an i18n key to display text. @public */
|
|
349
362
|
type ToolbarTranslate = (key: string) => string;
|
|
350
363
|
interface ToolbarContextValue {
|
|
@@ -906,6 +919,7 @@ interface DocxEditorToolbarNamespace {
|
|
|
906
919
|
readonly Zoom: ToolbarSlotPartComponent;
|
|
907
920
|
readonly StylePicker: typeof ParagraphStyle;
|
|
908
921
|
readonly EditingMode: ToolbarSlotPartComponent;
|
|
922
|
+
readonly Reviewers: typeof ToolbarReviewers;
|
|
909
923
|
readonly Save: ToolbarSlotPartComponent;
|
|
910
924
|
readonly ContentControlShowAll: ToolbarPartComponent;
|
|
911
925
|
readonly ContentControlFormFill: ToolbarPartComponent;
|
|
@@ -921,7 +935,7 @@ interface DocxEditorToolbarNamespace {
|
|
|
921
935
|
declare const DocxEditorToolbar: DocxEditorToolbarNamespace;
|
|
922
936
|
|
|
923
937
|
/**
|
|
924
|
-
* A menu's identity: one of the registry's
|
|
938
|
+
* A menu's identity: one of the registry's five, or a HOST'S OWN.
|
|
925
939
|
*
|
|
926
940
|
* The `(string & {})` arm keeps the registry ids as editor autocomplete while accepting
|
|
927
941
|
* any other string, so a product can add "Review" or "Clauses" without the library having
|
|
@@ -1110,7 +1124,7 @@ declare function MenuSeparator({ className }: MenuSeparatorProps): react.JSX.Ele
|
|
|
1110
1124
|
declare function MenuEntry({ entry }: {
|
|
1111
1125
|
entry: ChromeMenuEntry;
|
|
1112
1126
|
}): react.JSX.Element;
|
|
1113
|
-
/** Props for `DocxEditor.Menu.Menu` and the
|
|
1127
|
+
/** Props for `DocxEditor.Menu.Menu` and the five pinned menu parts. @public */
|
|
1114
1128
|
interface MenuProps {
|
|
1115
1129
|
/** Which menu this is. Only one panel in the bar is open at a time, keyed on this. */
|
|
1116
1130
|
id: MenuId;
|
|
@@ -1195,6 +1209,15 @@ declare const MenuReportIssue: typeof MenuReportIssueImpl & {
|
|
|
1195
1209
|
docxSlot: string;
|
|
1196
1210
|
};
|
|
1197
1211
|
|
|
1212
|
+
type MenuReviewersProps = {
|
|
1213
|
+
className?: string;
|
|
1214
|
+
hidden?: boolean;
|
|
1215
|
+
};
|
|
1216
|
+
/** The document-dependent Reviewers submenu. It changes view state only. @public */
|
|
1217
|
+
declare function MenuReviewers({ className, hidden }: MenuReviewersProps): react.JSX.Element | null;
|
|
1218
|
+
/** The packaged top-level Review menu. @public */
|
|
1219
|
+
declare const MenuReview: MenuPartComponent;
|
|
1220
|
+
|
|
1198
1221
|
/** Props for `DocxEditor.Menu`. @public */
|
|
1199
1222
|
interface DocxEditorMenuProps {
|
|
1200
1223
|
/** Appended after the base `docx-menubar` class. */
|
|
@@ -1245,6 +1268,7 @@ interface DocxEditorMenuNamespace {
|
|
|
1245
1268
|
readonly File: MenuPartComponent;
|
|
1246
1269
|
readonly Format: MenuPartComponent;
|
|
1247
1270
|
readonly Insert: MenuPartComponent;
|
|
1271
|
+
readonly Review: typeof MenuReview;
|
|
1248
1272
|
readonly Help: MenuPartComponent;
|
|
1249
1273
|
/** One chrome slot as a live row. */
|
|
1250
1274
|
readonly Item: typeof MenuItem;
|
|
@@ -1263,11 +1287,13 @@ interface DocxEditorMenuNamespace {
|
|
|
1263
1287
|
readonly PageSetup: typeof MenuPageSetup;
|
|
1264
1288
|
/** Insert › Image, so a host can hide it or place it elsewhere by name. */
|
|
1265
1289
|
readonly ImageInsert: typeof MenuImageInsert;
|
|
1290
|
+
/** Review > Markup Options > Reviewers. */
|
|
1291
|
+
readonly Reviewers: typeof MenuReviewers;
|
|
1266
1292
|
/** Help › Report issue, so a host can drop it or point it elsewhere by name. */
|
|
1267
1293
|
readonly ReportIssue: typeof MenuReportIssue;
|
|
1268
1294
|
}
|
|
1269
1295
|
/**
|
|
1270
|
-
* The compound menu bar: `<DocxEditor.Menu/>` for File · Format · Insert · Help, parts as
|
|
1296
|
+
* The compound menu bar: `<DocxEditor.Menu/>` for File · Format · Insert · Review · Help, parts as
|
|
1271
1297
|
* statics for composition.
|
|
1272
1298
|
*
|
|
1273
1299
|
* Every actionable row is a chrome slot, so a row and its toolbar twin share one label,
|
|
@@ -2938,9 +2964,8 @@ declare function useContentControlInstance(): UseContentControlResult;
|
|
|
2938
2964
|
* change appears, then authors who only commented. One person is one colour across the two.
|
|
2939
2965
|
* Once assigned, a slot stays with that author for the attached document session.
|
|
2940
2966
|
*
|
|
2941
|
-
*
|
|
2942
|
-
*
|
|
2943
|
-
* only if they also commented.
|
|
2967
|
+
* The complete attached-document roster. An author remains here while the current review
|
|
2968
|
+
* view hides their revisions and comments, so reviewer chrome can turn them on again.
|
|
2944
2969
|
*
|
|
2945
2970
|
* The array is reference-stable between changes (the facade caches per layout and colour
|
|
2946
2971
|
* state), so it is safe as a dependency and under `useSyncExternalStore`.
|
|
@@ -4040,4 +4065,4 @@ declare function VerticalRuler({ pageSetup, zoom, editable, onTopMarginChange, o
|
|
|
4040
4065
|
*/
|
|
4041
4066
|
declare function useEditorSnapshot(editor: Editor | null): number;
|
|
4042
4067
|
|
|
4043
|
-
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, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, 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 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 PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphFlagState, type ParagraphFormatRead, type ParagraphFormatUpdate, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ParagraphTabStop, 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, 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 ToolbarSeparatorProps, type ToolbarSlotPartComponent, type ToolbarSlotPartProps, type ToolbarTranslate, type UseContentControlResult, type UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, 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, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };
|
|
4068
|
+
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, DocumentName, DocumentOutline, DocxEditor, DocxEditorAuthorStyle, type DocxEditorAuthorStyleProps, type DocxEditorChildren, DocxEditorColorByChangeType, DocxEditorContent, DocxEditorContentControl, type DocxEditorContentControlNamespace, type DocxEditorContentProps, DocxEditorContextMenu, type DocxEditorContextMenuNamespace, type DocxEditorContextMenuProps, DocxEditorDocumentOutline, type DocxEditorDocumentOutlineProps, DocxEditorEquation, DocxEditorFontNotice, type DocxEditorFontNoticeProps, DocxEditorHeaderFooterChrome, type DocxEditorHeaderFooterChromeProps, DocxEditorHorizontalRuler, DocxEditorHyperLink, type DocxEditorHyperLinkNamespace, DocxEditorImagePropertiesDialog, type DocxEditorImagePropertiesDialogProps, DocxEditorLoading, type DocxEditorLoadingComponent, type DocxEditorLoadingProps, DocxEditorLoadingSpinner, type DocxEditorLoadingSpinnerProps, DocxEditorMenu, type DocxEditorMenuNamespace, type DocxEditorMenuProps, type DocxEditorNamespace, DocxEditorNavigation, type DocxEditorNavigationNamespace, type DocxEditorNavigationProps, DocxEditorNotesChrome, type DocxEditorNotesChromeProps, DocxEditorPageNumber, type DocxEditorPageNumberProps, DocxEditorPageSetupDialog, type DocxEditorPageSetupDialogProps, DocxEditorParagraphDialog, type DocxEditorParagraphDialogProps, type DocxEditorProps, type DocxEditorRef, DocxEditorRoot, type DocxEditorRootListeners, type DocxEditorRootProps, type DocxEditorRulerProps, DocxEditorShell, 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 PageSetupUpdate, PaginatedDocxEditor, type PaginatedDocxEditorExpose, type PaginatedDocxEditorHandle, type PaginatedDocxEditorProps, PaginatedDocxEditorShell, type PaginatedDocxEditorShellProps, type ParagraphFlagState, type ParagraphFormatRead, type ParagraphFormatUpdate, type ParagraphStyleItemProps, type ParagraphStyleNamespace, type ParagraphStyleOption, type ParagraphStylePartProps, type ParagraphStyleProps, type ParagraphTabStop, 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, 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 UseDocumentOutlineResult, type UseDocumentSearchResult, type UseDocxSourceOptions, type UseDocxSourceResult, type UseFontFamilyResult, type UseHyperlinkPopupResult, type UseNavigationPaneOptions, type UseNavigationPaneResult, type UsePageSetupReturn, type UseParagraphFormatReturn, type UseParagraphIndentReturn, type UseParagraphStyleResult, type UseZoomResult, VERSION, VerticalRuler, type VerticalRulerProps, 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, useParagraphFormat, useParagraphIndent, useParagraphStyle, useReviewAuthors, useReviewGutter, useScopeClassName, useScopedChromeAnchor, useTableBorderTargetLabel, useToolbarContext, useToolbarLabel, useToolbarLabelFor, useTranslation, useZoom };
|