@univerjs/docs-ui 1.0.0-rc.0 → 1.0.0

package/lib/types/controllers/render-controllers/mobile/doc-pinch-zoom.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ICommandService, IContextService } from '@univerjs/core';
+import type { DocSelectionManagerService } from '@univerjs/docs';
+import type { Engine, Scene, Viewport } from '@univerjs/engine-render';
+import type { DocViewScaleService } from '../../../services/doc-view-scale';
+import { Disposable } from '@univerjs/core';
+export declare function resolveMobileDocPinchZoomRatio(initialZoomRatio: number, initialDistance: number, currentDistance: number): number;
+interface IMobileDocPinchZoomGestureOptions {
+    canvasElement: HTMLCanvasElement;
+    commandService: ICommandService;
+    contextService: IContextService;
+    docViewScaleService: DocViewScaleService;
+    engine: Engine;
+    scene: Scene;
+    textSelectionManagerService: DocSelectionManagerService;
+    unitId: string;
+    viewport: Viewport;
+}
+export declare class MobileDocPinchZoomGesture extends Disposable {
+    private readonly _options;
+    private readonly _zoomIndicator;
+    private _gestureOwned;
+    private _pinchZooming;
+    private _initialDistance;
+    private _initialZoomRatio;
+    private _anchor;
+    constructor(_options: IMobileDocPinchZoomGestureOptions);
+    private readonly _handleTouchStart;
+    private readonly _handleTouchMove;
+    private readonly _handleTouchEnd;
+    private readonly _handleTouchCancel;
+    private _getTouchPoint;
+    private _getPinchCenter;
+    private _getTouchDistance;
+    private _finishPinch;
+}
+export {};

package/lib/types/controllers/render-controllers/mobile/doc-selection-render.controller.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DocumentDataModel } from '@univerjs/core';
+import type { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import type { MobileDocSelectionRenderService } from '../../../services/mobile/doc-selection-render.service';
+import { Disposable, ICommandService, IContextService, IUniverInstanceService } from '@univerjs/core';
+import { DocSelectionManagerService, DocSkeletonManagerService } from '@univerjs/docs';
+import { IContextMenuService } from '@univerjs/ui';
+import { IDocEmbedInteractionBoundaryService, IDocEmbedRuntimeFocusCoordinator } from '../../../services/doc-embed-integration.service';
+import { DocMobileElementMenuService } from '../../../services/doc-mobile-element-menu.service';
+import { IEditorService } from '../../../services/editor/editor-manager.service';
+export declare class MobileDocSelectionRenderController extends Disposable implements IRenderModule {
+    private readonly _context;
+    private readonly _commandService;
+    private readonly _editorService;
+    private readonly _instanceSrv;
+    private readonly _docSelectionRenderService;
+    private readonly _docSkeletonManagerService;
+    private readonly _docSelectionManagerService;
+    private readonly _contextService;
+    private readonly _contextMenuService;
+    private readonly _mobileElementMenuService;
+    private readonly _embedRuntimeFocusCoordinator?;
+    private _loadedMap;
+    private _deferredEditorFocusTimer;
+    private _gestureTimer;
+    private _gestureDisposables;
+    private _lastTap;
+    private _inertiaAnimationId;
+    private _inertiaLastFrameTime;
+    private _inertiaVelocity;
+    private _initialSelectionReady;
+    constructor(_context: IRenderContext<DocumentDataModel>, _commandService: ICommandService, _editorService: IEditorService, _instanceSrv: IUniverInstanceService, _docSelectionRenderService: MobileDocSelectionRenderService, _docSkeletonManagerService: DocSkeletonManagerService, _docSelectionManagerService: DocSelectionManagerService, _contextService: IContextService, _contextMenuService: IContextMenuService, _mobileElementMenuService: DocMobileElementMenuService, _embedInteractionBoundaryService?: IDocEmbedInteractionBoundaryService, _embedRuntimeFocusCoordinator?: IDocEmbedRuntimeFocusCoordinator | undefined);
+    private _initialize;
+    private _init;
+    private _refreshListener;
+    private _syncSelection;
+    private _initialMain;
+    private _initialEditor;
+    dispose(): void;
+    private _syncEditArea;
+    private _startGesture;
+    private _handleTap;
+    private _selectWord;
+    private _scrollDocument;
+    private _startInertia;
+    private _stopInertia;
+    private _enterEditing;
+    private _getDocumentOffset;
+    private _showCaretMenu;
+    private _clearGestureTimer;
+    private _clearGesture;
+    private _getTransformCoordForDocumentOffset;
+    private _isEditorReadOnly;
+    private _setEditorFocus;
+    private _isEmbedInteractionEvent;
+    private _isEmbedChildInteractionActive;
+    private _commandExecutedListener;
+    private _skeletonListener;
+}

package/lib/types/controllers/render-controllers/mobile/doc.render-controller.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DocumentDataModel } from '@univerjs/core';
+import type { DocumentSkeleton, IRenderContext } from '@univerjs/engine-render';
+import type { IDocLayoutScheduleOptions } from '../doc.render-controller';
+import { ICommandService, ILogService, IUniverInstanceService, ThemeService } from '@univerjs/core';
+import { DocLayoutExecutorService, DocSelectionManagerService, DocSkeletonManagerService } from '@univerjs/docs';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { DocLayoutInteractionService } from '../../../services/doc-layout-interaction.service';
+import { DocPageLayoutService } from '../../../services/doc-page-layout.service';
+import { DocViewScaleService } from '../../../services/doc-view-scale';
+import { IEditorService } from '../../../services/editor/editor-manager.service';
+import { DocSelectionRenderService } from '../../../services/selection/doc-selection-render.service';
+import { DocRenderController } from '../doc.render-controller';
+export declare class MobileDocRenderController extends DocRenderController {
+    private _mobileModernPageWidth;
+    constructor(context: IRenderContext<DocumentDataModel>, commandService: ICommandService, docSelectionRenderService: DocSelectionRenderService, docSkeletonManagerService: DocSkeletonManagerService, editorService: IEditorService, renderManagerService: IRenderManagerService, univerInstanceService: IUniverInstanceService, docPageLayoutService: DocPageLayoutService, textSelectionManagerService: DocSelectionManagerService, docViewScaleService: DocViewScaleService, themeService: ThemeService, docLayoutExecutorService: DocLayoutExecutorService, docLayoutInteractionService: DocLayoutInteractionService, logService: ILogService);
+    protected _scheduleLayout(unitId: string, skeleton: DocumentSkeleton, options: IDocLayoutScheduleOptions, refreshMainSelection?: boolean, preserveInactiveViewportAnchor?: boolean): void;
+    protected _shouldEnableHorizontalScrollBar(): boolean;
+    private _getMobileModernLayoutOptions;
+    private _initResponsiveLayout;
+    protected _getHorizontalPageMargin(): number;
+}

package/lib/types/controllers/render-controllers/mobile/zoom.render-controller.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DocumentDataModel } from '@univerjs/core';
+import type { IRenderContext } from '@univerjs/engine-render';
+import { ICommandService, IContextService, IUniverInstanceService } from '@univerjs/core';
+import { DocSelectionManagerService, DocSkeletonManagerService } from '@univerjs/docs';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { IDocEmbedInteractionBoundaryService } from '../../../services/doc-embed-integration.service';
+import { DocPageLayoutService } from '../../../services/doc-page-layout.service';
+import { DocViewScaleService } from '../../../services/doc-view-scale';
+import { IEditorService } from '../../../services/editor/editor-manager.service';
+import { DocZoomRenderController } from '../zoom.render-controller';
+export declare class MobileDocZoomRenderController extends DocZoomRenderController {
+    constructor(context: IRenderContext<DocumentDataModel>, contextService: IContextService, docSkeletonManagerService: DocSkeletonManagerService, univerInstanceService: IUniverInstanceService, commandService: ICommandService, textSelectionManagerService: DocSelectionManagerService, editorService: IEditorService, docPageLayoutService: DocPageLayoutService, renderManagerService: IRenderManagerService, docViewScaleService: DocViewScaleService, embedInteractionBoundaryService?: IDocEmbedInteractionBoundaryService);
+    protected _initCommandExecutedListener(): void;
+    private _initGestureZoom;
+}

package/lib/types/controllers/render-controllers/zoom.render-controller.d.ts

@@ -24,24 +24,26 @@ import { DocViewScaleService } from '../../services/doc-view-scale';
 import { IEditorService } from '../../services/editor/editor-manager.service';
 export declare function shouldHandleDocWheelZoom(event: Pick<IWheelEvent, 'ctrlKey' | 'metaKey'>, focusingDoc: boolean, _documentFlavor?: DocumentFlavor): boolean;
 export declare class DocZoomRenderController extends Disposable implements IRenderModule {
-    private readonly _context;
-    private readonly _contextService;
+    protected readonly _context: IRenderContext<DocumentDataModel>;
+    protected readonly _contextService: IContextService;
     private readonly _docSkeletonManagerService;
     private readonly _univerInstanceService;
-    private readonly _commandService;
-    private readonly _textSelectionManagerService;
+    protected readonly _commandService: ICommandService;
+    protected readonly _textSelectionManagerService: DocSelectionManagerService;
     private readonly _editorService;
     private readonly _docPageLayoutService;
     private readonly _renderManagerService;
-    private readonly _docViewScaleService;
+    protected readonly _docViewScaleService: DocViewScaleService;
     private readonly _embedInteractionBoundaryService?;
     private _isSheetEditor;
     private _initTimer;
     private _updateTimer;
+    private _fitToWidthAvailableWidth;
     constructor(_context: IRenderContext<DocumentDataModel>, _contextService: IContextService, _docSkeletonManagerService: DocSkeletonManagerService, _univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _textSelectionManagerService: DocSelectionManagerService, _editorService: IEditorService, _docPageLayoutService: DocPageLayoutService, _renderManagerService: IRenderManagerService, _docViewScaleService: DocViewScaleService, _embedInteractionBoundaryService?: IDocEmbedInteractionBoundaryService | undefined);
     dispose(): void;
     private _initSkeletonListener;
-    private _initCommandExecutedListener;
+    protected _initCommandExecutedListener(): void;
+    private _initFitToWidthResizeListener;
     updateViewZoom(zoomRatio: number, needRefreshSelection?: boolean): void;
     private _initZoomEventListener;
 }

package/lib/types/facade/f-univer.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentData } from '@univerjs/core';
+import { FUniver } from '@univerjs/core/facade';
+import { FDocument } from './f-document';
+/**
+ * @ignore
+ */
+export interface IFUniverDocsUIMixin {
+    /**
+     * Create a new document and get the API handler of that document.
+     *
+     * @param {Partial<IDocumentData>} data The snapshot of the document.
+     * @returns {FDocument} FDocument API instance.
+     */
+    createUniverDoc(data: Partial<IDocumentData>): FDocument;
+    /**
+     * Get the document API handler by the document id.
+     *
+     * @param {string} id The document id.
+     * @returns {FDocument | null} The document API instance.
+     */
+    getUniverDoc(id: string): FDocument | null;
+    /**
+     * Get the currently focused Univer document.
+     *
+     * @returns {FDocument | null} The currently focused Univer document.
+     */
+    getActiveDocument(): FDocument | null;
+}
+export declare class FUniverDocsUIMixin extends FUniver implements IFUniverDocsUIMixin {
+    createUniverDoc(data: Partial<IDocumentData>): FDocument;
+    getActiveDocument(): FDocument | null;
+    getUniverDoc(id: string): FDocument | null;
+}
+declare module '@univerjs/core/facade' {
+    interface FUniver extends IFUniverDocsUIMixin {
+    }
+}

package/lib/types/index.d.ts

@@ -37,6 +37,7 @@ export type { IDeleteCurrentParagraphCommandParams, IDeleteCustomBlockParams, }
 export { getCursorWhenDelete } from './commands/commands/doc-delete.command';
 export { HorizontalLineCommand } from './commands/commands/doc-horizontal-line.command';
 export { DocSelectAllCommand } from './commands/commands/doc-select-all.command';
+export { captureTextFormat } from './commands/commands/format-painter.command';
 export { IMEInputCommand } from './commands/commands/ime-input.command';
 export type { IIMEInputCommandParams } from './commands/commands/ime-input.command';
 export { getStyleInTextRange, ResetInlineFormatTextBackgroundColorCommand, ResetInlineFormatTextColorCommand, SetInlineFormatBoldCommand, SetInlineFormatCommand, SetInlineFormatFontFamilyCommand, SetInlineFormatFontSizeCommand, SetInlineFormatItalicCommand, SetInlineFormatStrikethroughCommand, SetInlineFormatSubscriptCommand, SetInlineFormatSuperscriptCommand, SetInlineFormatTextBackgroundColorCommand, SetInlineFormatTextColorCommand, SetInlineFormatTextFillCommand, SetInlineFormatUnderlineCommand, } from './commands/commands/inline-format.command';
@@ -80,9 +81,10 @@ export { scrollDocsTableLikeCustomBlockLive } from './embed-docs-custom-block-sc
 export type { IDocsTableLikeCustomBlockScrollOptions } from './embed-docs-custom-block-scroll';
 export { resolveDocsCustomBlockRenderViewport } from './embed-host-anchor';
 export type { IDocsCustomBlockLayoutViewport, IDocsCustomBlockRenderViewportParams } from './embed-host-anchor';
-export { AlignMenuItemFactory, BackgroundColorSelectorMenuItemFactory, BoldMenuItemFactory, disableMenuWhenHeaderFooterEditing, FLOAT_TEXT_STYLE_MENU_ID, FLOAT_TOOLBAR_MENU_POSITION, FloatTextStyleMenuItemFactory, FontFamilySelectorMenuItemFactory, FontSizeSelectorMenuItemFactory, hideMenuWhenSelectionInBlockRange, isTextRangeInAnyBlockRange, ItalicMenuItemFactory, StrikeThroughMenuItemFactory, TextColorSelectorMenuItemFactory, UnderlineMenuItemFactory, } from './menu/menu';
+export { AlignMenuItemFactory, BackgroundColorSelectorMenuItemFactory, BoldMenuItemFactory, disableMenuWhenHeaderFooterEditing, disableMenuWithoutDocumentUnitPermission, FLOAT_TEXT_STYLE_MENU_ID, FLOAT_TOOLBAR_MENU_POSITION, FloatTextStyleMenuItemFactory, FontFamilySelectorMenuItemFactory, FontSizeSelectorMenuItemFactory, hideMenuWhenSelectionInBlockRange, isTextRangeInAnyBlockRange, ItalicMenuItemFactory, StrikeThroughMenuItemFactory, TextColorSelectorMenuItemFactory, UnderlineMenuItemFactory, } from './menu/menu';
 export { DOC_CONTENT_INSERT_MENU_ID, DOC_PARAGRAPH_T_ALIGN_MENU_ID, DOC_PARAGRAPH_T_COLORS_MENU_ID, DOC_PARAGRAPH_T_DIVIDER_MENU_ID, DOC_PARAGRAPH_T_EDIT_MENU_ID, DOC_PARAGRAPH_T_INSERT_BELOW_MENU_ID, DOC_PARAGRAPH_T_INSERT_MENU_ID, DOC_TABLE_BLOCK_MENU_ID, EMPTY_PARAGRAPH_MENU_ID, getDocBlockRangeMenuId, INSERT_BELLOW_MENU_ID, ParagraphMenuInsertBelowSubmenuItemFactory, } from './menu/paragraph-menu';
 export { menuSchema as DocsUIMenuSchema } from './menu/schema';
+export { UniverDocsMobileUIPlugin } from './mobile-plugin';
 export { UniverDocsUIPlugin } from './plugin';
 export * from './services';
 export { convertClipboardHtmlToDocumentData, IDocClipboardService, removeClipboardHtmlImages, } from './services/clipboard/clipboard.service';
@@ -94,6 +96,7 @@ export { convertBodyToHtml } from './services/clipboard/udm-to-html/convertor';
 export { DocHtmlExportService } from './services/clipboard/udm-to-html/doc-html-export.service';
 export type { DocHtmlExportTransformer } from './services/clipboard/udm-to-html/doc-html-export.service';
 export { DocAutoFormatService } from './services/doc-auto-format.service';
+export { DocContextualRibbonService } from './services/doc-contextual-ribbon.service';
 export { DOC_EMBED_INTERACTION_BOUNDARY_OWNER_ATTRIBUTE, IDocEmbedInteractionBoundaryService, IDocEmbedRuntimeFocusCoordinator, } from './services/doc-embed-integration.service';
 export { DocEventManagerService, getListMarkerFallbackBound, getListParagraphContextMenuHit, } from './services/doc-event-manager.service';
 export type { IBulletBound, IMutiPageParagraphBound } from './services/doc-event-manager.service';
@@ -101,8 +104,10 @@ export { DocIMEInputManagerService } from './services/doc-ime-input-manager.serv
 export { DocLayoutInteractionService } from './services/doc-layout-interaction.service';
 export { SetDocInputStyleCommand } from './services/doc-menu-style.service';
 export type { ISetDocInputStyleCommandParams } from './services/doc-menu-style.service';
+export { DocMobileElementMenuService } from './services/doc-mobile-element-menu.service';
 export { DocPageLayoutService } from './services/doc-page-layout.service';
 export { DocParagraphMenuService } from './services/doc-paragraph-menu.service';
+export type { IDocCanvasPopup } from './services/doc-popup-manager.service';
 export { calcDocRangePositions, DocCanvasPopManagerService } from './services/doc-popup-manager.service';
 export type { IDocPrintPreparationContext } from './services/doc-print-interceptor.service';
 export { DocPrintInterceptorService } from './services/doc-print-interceptor.service';
@@ -110,8 +115,10 @@ export type { IDocPrintComponentContext, IDocPrintContext } from './services/doc
 export { DocsRenderService } from './services/docs-render.service';
 export { Editor } from './services/editor/editor';
 export { EditorService, IEditorService } from './services/editor/editor-manager.service';
+export type { IEditorRuntimeConfig } from './services/editor/editor-runtime-config';
 export { DocFloatMenuService } from './services/float-menu.service';
 export { isInSameTableCell, isValidRectRange, NodePositionConvertToRectRange, } from './services/selection/convert-rect-range';
+export { findDocRangeNodePositions } from './services/selection/convert-text-range';
 export { NodePositionConvertToCursor } from './services/selection/convert-text-range';
 export { getOneTextSelectionRange } from './services/selection/convert-text-range';
 export type { IEditorInputConfig } from './services/selection/doc-selection-render.service';
@@ -123,6 +130,8 @@ export { getAnchorBounding, getLineBounding, TEXT_RANGE_LAYER_INDEX, TextRange }
 export { whenDocAndEditorFocused } from './shortcuts/utils';
 export { DOC_VERTICAL_PADDING } from './types/const/padding';
 export { BulletListTypePicker, OrderListTypePicker } from './views/list-type-picker/Picker';
+export { MOBILE_DOC_ELEMENT_MENU, MobileDocElementMenu } from './views/mobile-element-menu/MobileDocElementMenu';
+export { MobileRichTextEditor } from './views/mobile-rich-text-editor/MobileRichTextEditor';
 export { MobileRichTextToolbar } from './views/mobile-rich-text-toolbar/MobileRichTextToolbar';
 export type { IMobileRichTextToolbarProps } from './views/mobile-rich-text-toolbar/MobileRichTextToolbar';
 export { createEditorUndoRedoKeyboardConfig, executeEditorUndoRedoCommand, useEditor, useEditorClickOutside, useIsFocusing, useKeyboardEvent, useLeftAndRightArrow, useOnChange, useResize, } from './views/rich-text-editor/hooks';

package/lib/types/locale/en-US.d.ts

@@ -15,12 +15,38 @@
  */
 declare const locale: {
     'docs-ui': {
+        pasteOptions: {
+            title: string;
+            source: string;
+            destination: string;
+            text: string;
+            useKeyboard: string;
+            useSystemPaste: string;
+            failed: string;
+        };
+        outline: {
+            title: string;
+        };
         objectPermission: {
             paragraphPermission: string;
             title: string;
             paragraph: string;
             section: string;
         };
+        mobile: {
+            insert: string;
+            edit: string;
+            done: string;
+            more: string;
+            back: string;
+            close: string;
+            format: string;
+            layout: string;
+            keyboard: string;
+            hideKeyboard: string;
+            expand: string;
+            collapse: string;
+        };
         layout: {
             progress: string;
             recovering: string;
@@ -106,6 +132,8 @@ declare const locale: {
             selection: string;
             wordCount: string;
             selectedWords: string;
+            currentPage: string;
+            currentPageOfTotal: string;
             pages: string;
             words: string;
             charactersWithoutSpaces: string;
@@ -176,6 +204,8 @@ declare const locale: {
             copy: string;
             cut: string;
             paste: string;
+            select: string;
+            selectAll: string;
             delete: string;
             bulletList: string;
             orderList: string;

package/lib/types/menu/context-menu.d.ts

@@ -20,6 +20,8 @@ export declare function CopyMenuFactory(accessor: IAccessor): IMenuButtonItem<Lo
 export declare function ParagraphSettingMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function CutMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function PasteMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function SelectWordMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function SelectAllMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function DeleteMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare const TABLE_INSERT_MENU_ID = "doc.menu.table-insert";
 export declare function TableInsertMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;
@@ -33,3 +35,4 @@ export declare function TableDeleteMenuItemFactory(accessor: IAccessor): IMenuSe
 export declare function DeleteRowsMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function DeleteColumnsMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function DeleteTableMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function PasteSpecialMenuFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;

package/lib/types/menu/mobile-schema.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { MenuSchemaType } from '@univerjs/ui';
+export declare const mobileMenuSchema: MenuSchemaType;

package/lib/types/mobile-plugin.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IUniverDocsUIConfig } from './config/config';
+import { ICommandService, IConfigService, Injector, Plugin } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+export declare class UniverDocsMobileUIPlugin extends Plugin {
+    private readonly _config;
+    _injector: Injector;
+    private readonly _renderManagerSrv;
+    private _commandService;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDocsUIConfig> | undefined, _injector: Injector, _renderManagerSrv: IRenderManagerService, _commandService: ICommandService, _configService: IConfigService);
+    onReady(): void;
+    onRendered(): void;
+    private _initCommand;
+    private _initDependencies;
+    private _initAutoFocus;
+    private _initRenderBasics;
+    private _initRenderModules;
+}

package/lib/types/services/clipboard/clipboard.service.d.ts

@@ -15,9 +15,12 @@
  */
 import type { IDisposable, IDocumentBody, IDocumentData } from '@univerjs/core';
 import type { IRectRangeWithStyle, ITextRangeWithStyle } from '@univerjs/engine-render';
-import { Disposable, ErrorService, ICommandService, ILogService, ImageSourceType, IPermissionService, IUniverInstanceService, SliceBodyType } from '@univerjs/core';
-import { DocSelectionManagerService } from '@univerjs/docs';
+import type { Observable } from 'rxjs';
+import type { DocPasteMode } from './paste-options';
+import { Disposable, ErrorService, ICommandService, ILogService, ImageSourceType, IPermissionService, IUndoRedoService, IUniverInstanceService, SliceBodyType } from '@univerjs/core';
+import { DocSelectionManagerService, DocStateChangeManagerService } from '@univerjs/docs';
 import { IClipboardInterfaceService } from '@univerjs/ui';
+import { DocMenuStyleService } from '../doc-menu-style.service';
 import { DocHtmlExportService } from './udm-to-html/doc-html-export.service';
 export declare function convertClipboardHtmlToDocumentData(html: string, unitId?: string): Partial<IDocumentData>;
 export declare function removeClipboardHtmlImages(html: string): string;
@@ -36,6 +39,11 @@ export interface IDocClipboardPasteContext {
     targetUnitId: string;
 }
 export interface IDocClipboardHook {
+    /** Supply a rich fragment for selections owned by a plugin rather than native text ranges. */
+    onCopySelection?(unitId: string): {
+        documentData: IDocumentData;
+        plainText: string;
+    } | undefined;
     onCopyDocData?(doc: Partial<IDocumentData>, context: IDocClipboardCopyDocDataContext): Partial<IDocumentData>;
     onCopyProperty?(start: number, end: number): IClipboardPropertyItem;
     onCopyContent?(start: number, end: number, context: IDocClipboardCopyContentContext): string;
@@ -45,17 +53,29 @@ export interface IDocClipboardHook {
         imageSourceType: ImageSourceType;
     } | null>;
 }
+export interface IDocClipboardPayload {
+    html?: string;
+    text?: string;
+    internalJson?: string;
+    files: File[];
+    unitId?: string;
+    mode?: DocPasteMode;
+}
+export interface IDocPasteOptionsState {
+    unitId: string;
+    mode: DocPasteMode;
+    range: ITextRangeWithStyle;
+}
 export interface IDocClipboardService {
     copy(sliceType?: SliceBodyType, ranges?: ITextRangeWithStyle[]): Promise<boolean>;
     cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
-    paste(items?: ClipboardItem[]): Promise<boolean>;
-    legacyPaste(options: {
-        html?: string;
-        text?: string;
-        internalJson?: string;
-        files: File[];
-        unitId?: string;
-    }): Promise<boolean>;
+    paste(items?: ClipboardItem[], mode?: DocPasteMode): Promise<boolean>;
+    pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
+    legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
+    readonly pasteOptions$: Observable<IDocPasteOptionsState | null>;
+    setNextPasteMode(mode: DocPasteMode): void;
+    dismissPasteOptions(): void;
+    changePasteMode(mode: DocPasteMode): Promise<boolean>;
     addClipboardHook(hook: IDocClipboardHook): IDisposable;
 }
 export declare function getTableClipboardBodySlice(body: IDocumentBody, range: IRectRangeWithStyle): IDocumentBody;
@@ -68,21 +88,34 @@ export declare class DocClipboardService extends Disposable implements IDocClipb
     private readonly _clipboardInterfaceService;
     private readonly _errorService;
     private readonly _docSelectionManagerService;
+    private readonly _stateChangeManager;
+    private readonly _menuStyleService;
+    private readonly _undoRedoService;
+    private readonly _pasteOptions$;
+    readonly pasteOptions$: Observable<IDocPasteOptionsState | null>;
+    private _pasteSession;
+    private _applyingPaste;
+    private _pasteGeneration;
+    private _nextPasteMode;
+    private _lastSelectionKey;
     private _clipboardHooks;
     private _memoryClipboardData;
     private _htmlToUDM;
     private readonly _umdToHtml;
-    constructor(_univerInstanceService: IUniverInstanceService, _logService: ILogService, _commandService: ICommandService, _permissionService: IPermissionService, _clipboardInterfaceService: IClipboardInterfaceService, _errorService: ErrorService, docHtmlExportService: DocHtmlExportService, _docSelectionManagerService: DocSelectionManagerService);
+    constructor(_univerInstanceService: IUniverInstanceService, _logService: ILogService, _commandService: ICommandService, _permissionService: IPermissionService, _clipboardInterfaceService: IClipboardInterfaceService, _errorService: ErrorService, docHtmlExportService: DocHtmlExportService, _docSelectionManagerService: DocSelectionManagerService, _stateChangeManager: DocStateChangeManagerService, _menuStyleService: DocMenuStyleService, _undoRedoService: IUndoRedoService);
     copy(sliceType?: SliceBodyType, ranges?: ITextRangeWithStyle[]): Promise<boolean>;
     cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
-    paste(items?: ClipboardItem[]): Promise<boolean>;
-    legacyPaste(options: {
-        html?: string;
-        internalJson?: string;
-        text?: string;
-        files: File[];
-        unitId?: string;
-    }): Promise<boolean>;
+    pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
+    paste(items?: ClipboardItem[], mode?: DocPasteMode): Promise<boolean>;
+    setNextPasteMode(mode: DocPasteMode): void;
+    legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
+    dismissPasteOptions(): void;
+    changePasteMode(mode: DocPasteMode): Promise<boolean>;
+    private _preparePaste;
+    private _pasteWithOptions;
+    private _getPasteStyle;
+    private _getPasteSelectionKey;
+    private _savePasteSession;
     private _getCurrentDocumentUnitId;
     private _canEditTargets;
     private _cut;
@@ -92,7 +125,7 @@ export declare class DocClipboardService extends Disposable implements IDocClipb
     addClipboardHook(hook: IDocClipboardHook): IDisposable;
     private _applyCopyDocDataHooks;
     private _getDocumentBodyInRanges;
-    private _genDocDataFromClipboardItems;
+    private _readClipboardItems;
     private _genDocDataFromHtmlAndText;
     private _uploadBase64ImagesInHtml;
     private _createImagePasteHtml;

package/lib/types/services/clipboard/paste-options.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentData, IParagraphStyle, ITextStyle } from '@univerjs/core';
+export type DocPasteMode = 'source' | 'destination' | 'text';
+export interface IDocPasteStyle {
+    textStyle: ITextStyle;
+    paragraphStyle?: IParagraphStyle;
+}
+export declare const DOC_PASTE_OPTIONS: readonly [{
+    readonly value: "source";
+    readonly label: "docs-ui.pasteOptions.source";
+}, {
+    readonly value: "destination";
+    readonly label: "docs-ui.pasteOptions.destination";
+}, {
+    readonly value: "text";
+    readonly label: "docs-ui.pasteOptions.text";
+}];
+export declare function getClipboardPlainText(doc: Partial<IDocumentData>): string;
+export declare function applyDocPasteMode(source: Partial<IDocumentData>, mode: DocPasteMode, style: IDocPasteStyle, text?: string): Partial<IDocumentData>;