@univerjs/sheets-ui 0.5.3 → 0.5.4-nightly.202501131606

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

@@ -1,36 +1,32 @@
 import { IDisposable, Nullable } from '@univerjs/core';
-import { ICellPosWithEvent, IHoverRichTextInfo, IHoverRichTextPosition, IScrollState } from '@univerjs/sheets-ui';
+import { IMouseEvent, IPointerEvent } from '@univerjs/engine-render';
+import { ICellPosWithEvent, IDragCellPosition, IHoverRichTextInfo, IHoverRichTextPosition, IScrollState } from '@univerjs/sheets-ui';
 import { FWorkbook } from '@univerjs/sheets/facade';
 import { IDialogPartMethodOptions, ISidebarMethodOptions } from '@univerjs/ui';
+import { ICellEventParam, IFSheetsUIEventParamConfig } from './f-event';
 export interface IFWorkbookSheetsUIMixin {
     /**
      * Open a sidebar.
-     *
      * @deprecated
-     *
      * @param params the sidebar options
      * @returns the disposable object
      */
     openSiderbar(params: ISidebarMethodOptions): IDisposable;
     /**
      * Open a dialog.
-     *
      * @deprecated
-     *
      * @param dialog the dialog options
      * @returns the disposable object
      */
     openDialog(dialog: IDialogPartMethodOptions): IDisposable;
     /**
      * Subscribe to cell click events
-     *
      * @param callback - The callback function to be called when a cell is clicked
      * @returns A disposable object that can be used to unsubscribe from the event
      */
     onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable;
     /**
      * Subscribe cell hover events
-     *
      * @param callback - The callback function to be called when a cell is hovered
      * @returns A disposable object that can be used to unsubscribe from the event
      */
@@ -39,82 +35,101 @@ export interface IFWorkbookSheetsUIMixin {
      * Subscribe to pointer move events on workbook. Just like onCellHover, but with event information.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onPointerMove(callback: (cell: Nullable<ICellPosWithEvent>, buttons: number) => void): IDisposable;
+    onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable;
     /**
      * Subscribe to cell pointer down events.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onCellPointerDown(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
+    onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable;
     /**
      * Subscribe to cell pointer up events.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onCellPointerUp(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
+    onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable;
+    onDrop(callback: (cell: IDragCellPosition) => void): IDisposable;
     /**
      * Start the editing process
      * @returns A boolean value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook().startEditing();
+     * ```
      */
     startEditing(): boolean;
     /**
      * Use endEditingAsync as instead
      * @deprecated
+     * End the editing process
+     * @async
+     * @param save - Whether to save the changes
+     * @returns A promise that resolves to a boolean value
+     * @example
+     * ``` ts
+     * univerAPI.getActiveWorkbook().endEditing(true);
+     * ```
      */
     endEditing(save?: boolean): Promise<boolean>;
     /**
      * @async
-     * @param save - Whether to save the changes, default is true
-     * @returns A promise that resolves to a boolean value
-     * @param save
+     * @param {boolean} save - Whether to save the changes, default is true
+     * @returns {Promise<boolean>} A promise that resolves to a boolean value
      */
     endEditingAsync(save?: boolean): Promise<boolean>;
     getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>;
     /**
      * Disable selection. After disabled, there would be no response for selection.
+     * @returns {FWorkbook} FWorkbook instance
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().disableSelection();
      * ```
      */
-    disableSelection(): void;
+    disableSelection(): FWorkbook;
     /**
      * Enable selection. After this you can select range.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().enableSelection();
      * ```
      */
-    enableSelection(): void;
+    enableSelection(): FWorkbook;
     /**
      * Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().transparentSelection();
      * ```
      */
-    transparentSelection(): void;
+    transparentSelection(): FWorkbook;
     /**
      * Set selection visible.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().showSelection();
      * ```
      */
-    showSelection(): void;
+    showSelection(): FWorkbook;
 }
 export declare class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheetsUIMixin {
     openSiderbar(params: ISidebarMethodOptions): IDisposable;
     openDialog(dialog: IDialogPartMethodOptions): IDisposable;
     private _logDeprecation;
+    addUIEvent(event: keyof IFSheetsUIEventParamConfig, _callback: (params: IFSheetsUIEventParamConfig[typeof event]) => void): IDisposable;
+    generateCellParams(cell: IHoverRichTextPosition | ICellPosWithEvent): ICellEventParam;
     onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable;
     onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable;
-    onCellPointerDown(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
-    onCellPointerUp(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
-    onPointerMove(callback: (cell: Nullable<ICellPosWithEvent>, buttons: number) => void): IDisposable;
+    onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable;
+    onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable;
+    onDrop(callback: (cell: IDragCellPosition) => void): IDisposable;
     startEditing(): boolean;
     endEditing(save?: boolean): Promise<boolean>;
     endEditingAsync(save?: boolean): Promise<boolean>;
     /**
      * Get scroll state of specified sheet.
+     * @param {string} sheetId - sheet id
      * @returns {IScrollState} scroll state
      * @example
      * ``` ts
@@ -122,10 +137,10 @@ export declare class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkb
      * ```
      */
     getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>;
-    disableSelection(): void;
-    enableSelection(): void;
-    transparentSelection(): void;
-    showSelection(): void;
+    disableSelection(): FWorkbook;
+    enableSelection(): FWorkbook;
+    transparentSelection(): FWorkbook;
+    showSelection(): FWorkbook;
 }
 declare module '@univerjs/sheets/facade' {
     interface FWorkbook extends IFWorkbookSheetsUIMixin {

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

@@ -5,7 +5,7 @@ export interface IFWorksheetSkeletonMixin {
     /**
      * Refresh the canvas.
      */
-    refreshCanvas(): void;
+    refreshCanvas(): FWorksheet;
     /**
      * Set zoom ratio of the worksheet.
      * @param {number} zoomRatio The zoom ratio to set.It should be in the range of 10 to 400.
@@ -34,15 +34,27 @@ export interface IFWorksheetSkeletonMixin {
     getZoom(): number;
     /**
      * Return visible range, sum view range of 4 viewports.
-     * @returns IRange
+     * @returns {IRange} - visible range
+     * @example
+     * ``` ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const visibleRange = fWorksheet.getVisibleRange();
+     * ```
      */
     getVisibleRange(): IRange;
     /**
-     * Scroll spreadsheet to cell position. Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
-     * @param row
-     * @param column
+     * Scroll spreadsheet(viewMain) to cell position. Make the cell at topleft of current viewport.
+     * Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
+     * @param {number} row - Cell row index
+     * @param {number} column - Cell column index
+     * @returns {FWorksheet} - Current worksheet
+     * @example
+     * ``` ts
+     * univerAPI.getActiveWorkbook().getActiveSheet().scrollToCell(1, 1);
+     * ```
      */
-    scrollToCell(row: number, column: number): void;
+    scrollToCell(row: number, column: number): FWorksheet;
     /**
      * Get scroll state of current sheet.
      * @returns {IScrollState} curr scroll state
@@ -51,10 +63,11 @@ export interface IFWorksheetSkeletonMixin {
      * univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()
      * ```
      */
-    getScrollState(): Nullable<IScrollState>;
+    getScrollState(): IScrollState;
     /**
      * Invoked when scrolling the sheet.
-     * @param {function(params: Nullable<IViewportScrollState>): void} callback The scrolling callback function.
+     * @param {function(Nullable<IViewportScrollState>): void} callback The scrolling callback function.
+     * @returns {IDisposable} The disposable object to remove the event listener.
      * @example
      * ``` ts
      * univerAPI.getActiveWorkbook().getActiveSheet().onScroll((params) => {...})
@@ -63,12 +76,12 @@ export interface IFWorksheetSkeletonMixin {
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
 }
 export declare class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSkeletonMixin {
-    refreshCanvas(): void;
+    refreshCanvas(): FWorksheet;
     zoom(zoomRatio: number): FWorksheet;
     getZoom(): number;
     getVisibleRange(): IRange;
-    scrollToCell(row: number, column: number): void;
-    getScrollState(): Nullable<IScrollState>;
+    scrollToCell(row: number, column: number): FWorksheet;
+    getScrollState(): IScrollState;
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
 }
 declare module '@univerjs/sheets/facade' {

package/lib/types/facade/index.d.ts

@@ -18,8 +18,10 @@ import './f-workbook';
 import './f-worksheet';
 import './f-permission';
 import './f-sheet-hooks';
-export { type IFComponentKey, transformComponentKey } from './f-range';
+import './f-event';
+export type * from './f-event';
 export type * from './f-permission';
+export { type IFComponentKey, transformComponentKey } from './f-range';
 export type * from './f-sheet-hooks';
 export type * from './f-univer';
 export type * from './f-workbook';

package/lib/types/index.d.ts

@@ -15,23 +15,14 @@
  */
 import './global.css';
 export { getEditorObject } from './basics/editor/get-editor-object';
-export { EMBEDDING_FORMULA_EDITOR_COMPONENT_KEY, RANGE_SELECTOR_COMPONENT_KEY, SHEET_VIEW_KEY } from './common/keys';
 export { useActiveWorkbook, useActiveWorksheet, useWorkbooks } from './components/hook';
 export { SHEET_UI_PLUGIN_NAME } from './consts/plugin-name';
 export { SheetsUIPart } from './consts/ui-name';
 export { AutoFillController } from './controllers/auto-fill.controller';
-export { AFFECT_LAYOUT_STYLES, AutoHeightController } from './controllers/auto-height.controller';
-export { AutoWidthController } from './controllers/auto-width.controller';
 export { CellCustomRenderController } from './controllers/cell-custom-render.controller';
-export { type IUniverSheetsUIConfig } from './controllers/config.schema';
-export { DragRenderController } from './controllers/drag-render.controller';
 export { EditingRenderController } from './controllers/editor/editing.render-controller';
-export { FormulaEditorController } from './controllers/editor/formula-editor.controller';
-export { HoverRenderController } from './controllers/hover-render.controller';
 export { PASTE_SPECIAL_MENU_ID, SheetMenuPosition } from './controllers/menu/menu';
 export { deriveStateFromActiveSheet$, getCurrentExclusiveRangeInterest$, getCurrentRangeDisable$, getObservableWithExclusiveRange$ } from './controllers/menu/menu-util';
-export { SheetPermissionInitController } from './controllers/permission/sheet-permission-init.controller';
-export { SheetPermissionInterceptorBaseController } from './controllers/permission/sheet-permission-interceptor-base.controller';
 export { HeaderFreezeRenderController } from './controllers/render-controllers/freeze.render-controller';
 export { HeaderMoveRenderController } from './controllers/render-controllers/header-move.render-controller';
 export { HeaderResizeRenderController } from './controllers/render-controllers/header-resize.render-controller';
@@ -39,10 +30,7 @@ export { SheetsScrollRenderController } from './controllers/render-controllers/s
 export { SheetRenderController } from './controllers/render-controllers/sheet.render-controller';
 export { SheetUIController } from './controllers/sheet-ui.controller';
 export { whenFormulaEditorActivated, whenSheetEditorFocused } from './controllers/shortcuts/utils';
-export { StatusBarController } from './controllers/status-bar.controller';
 export { getCoordByCell, getCoordByOffset, getSheetObject, getTransformCoord, } from './controllers/utils/component-tools';
-export { discreteRangeToRange, rangeToDiscreteRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
-export type { IDiscreteRange } from './controllers/utils/range-tools';
 export { matchedSelectionByRowColIndex as checkInHeaderRanges } from './controllers/utils/selections-tools';
 export { useHighlightRange } from './hooks/useHighlightRange';
 export { UniverSheetsMobileUIPlugin } from './mobile-plugin';
@@ -55,7 +43,7 @@ export { type ICanvasPopup, SheetCanvasPopManagerService } from './services/canv
 export { CellAlertManagerService, CellAlertType, type ICellAlert } from './services/cell-alert-manager.service';
 export { getMatrixPlainText, ISheetClipboardService, PREDEFINED_HOOK_NAME, SheetClipboardService, } from './services/clipboard/clipboard.service';
 export { COPY_TYPE } from './services/clipboard/type';
-export type { ICellDataWithSpanInfo, ICopyPastePayload, ISheetClipboardHook, ISheetDiscreteRangeLocation } from './services/clipboard/type';
+export type { ICellDataWithSpanInfo, ICopyPastePayload, IPasteHookValueType, ISheetClipboardHook, ISheetDiscreteRangeLocation } from './services/clipboard/type';
 export { getRepeatRange, mergeSetRangeValues } from './services/clipboard/utils';
 export { DragManagerService, type IDragCellPosition } from './services/drag-manager.service';
 export { EditorBridgeService, IEditorBridgeService, type IEditorBridgeServiceVisibleParam, } from './services/editor-bridge.service';
@@ -65,6 +53,16 @@ export { IFormulaEditorManagerService } from './services/editor/formula-editor-m
 export { HoverManagerService } from './services/hover-manager.service';
 export type { ICellPosWithEvent, IHoverCellPosition, IHoverRichTextInfo, IHoverRichTextPosition } from './services/hover-manager.service';
 export { IMarkSelectionService, MarkSelectionService } from './services/mark-selection/mark-selection.service';
+export { HoverRenderController } from './controllers/hover-render.controller';
+export { DragRenderController } from './controllers/drag-render.controller';
+export { EMBEDDING_FORMULA_EDITOR_COMPONENT_KEY, RANGE_SELECTOR_COMPONENT_KEY, SHEET_VIEW_KEY } from './common/keys';
+export type { IDiscreteRange } from './controllers/utils/range-tools';
+export { discreteRangeToRange, rangeToDiscreteRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
+export { AFFECT_LAYOUT_STYLES, AutoHeightController } from './controllers/auto-height.controller';
+export { AutoWidthController } from './controllers/auto-width.controller';
+export { FormulaEditorController } from './controllers/editor/formula-editor.controller';
+export { StatusBarController } from './controllers/status-bar.controller';
+export { SheetPermissionCheckUIController } from './controllers/permission/sheet-permission-check-ui.controller';
 export { SheetPermissionUserManagerService } from './services/permission/sheet-permission-user-list.service';
 export { SheetPrintInterceptorService } from './services/print-interceptor.service';
 export { SheetScrollManagerService } from './services/scroll-manager.service';
@@ -82,6 +80,7 @@ export { MobileSheetBar } from './views/mobile/sheet-bar/MobileSheetBar';
 export type { IRangeProtectionRenderCellData } from './views/permission/extensions/range-protection.render';
 export { SheetBar } from './views/sheet-bar/SheetBar';
 export { RenderSheetContent, RenderSheetFooter, RenderSheetHeader } from './views/sheet-container/SheetContainer';
+export { type IUniverSheetsUIConfig } from './controllers/config.schema';
 export { getCellRealRange } from './common/utils';
 export { FONT_FAMILY_COMPONENT, FONT_FAMILY_ITEM_COMPONENT } from './components/font-family/interface';
 export { FONT_SIZE_COMPONENT } from './components/font-size/interface';
@@ -94,7 +93,7 @@ export type { IFormatPainterBeforeApplyHookParams, IFormatPainterHook } from './
 export { SELECTION_SHAPE_DEPTH } from './services/selection/const';
 export { type IBaseSheetBarProps } from './views/sheet-bar/sheet-bar-tabs/SheetBarItem';
 export { AutoClearContentCommand, AutoFillCommand } from './commands/commands/auto-fill.command';
-export { type ISheetPasteParams, SheetCopyCommand, SheetCutCommand, SheetPasteBesidesBorderCommand, SheetPasteColWidthCommand, SheetPasteCommand, SheetPasteFormatCommand, SheetPasteShortKeyCommand, SheetPasteValueCommand, } from './commands/commands/clipboard.command';
+export { type ISheetPasteByShortKeyParams, type ISheetPasteParams, SheetCopyCommand, SheetCutCommand, SheetPasteBesidesBorderCommand, SheetPasteColWidthCommand, SheetPasteCommand, SheetPasteFormatCommand, SheetPasteShortKeyCommand, SheetPasteValueCommand, } from './commands/commands/clipboard.command';
 export { DeleteRangeMoveLeftConfirmCommand } from './commands/commands/delete-range-move-left-confirm.command';
 export { DeleteRangeMoveUpConfirmCommand } from './commands/commands/delete-range-move-up-confirm.command';
 export { HideColConfirmCommand, HideRowConfirmCommand } from './commands/commands/hide-row-col-confirm.command';

package/lib/types/services/canvas-pop-manager.service.d.ts

@@ -1,10 +1,12 @@
 import { DrawingTypeEnum, ICommandInfo, INeedCheckDisposable, Nullable, Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
 import { BaseObject, IBoundRectNoAngle, Viewport, IRenderManagerService } from '@univerjs/engine-render';
-import { ISheetLocationBase, RefRangeService } from '@univerjs/sheets';
+import { ISheetLocationBase, RefRangeService, SheetsSelectionsService } from '@univerjs/sheets';
 import { IPopup, ICanvasPopupService } from '@univerjs/ui';
+import { ISheetSelectionRenderService } from './selection/base-selection-render.service';
 export interface ICanvasPopup extends Omit<IPopup, 'anchorRect' | 'anchorRect$' | 'unitId' | 'subUnitId' | 'canvasElement'> {
     mask?: boolean;
     extraProps?: Record<string, unknown>;
+    showOnSelectionMoving?: boolean;
 }
 interface IPopupMenuItem {
     label: string;
@@ -20,8 +22,12 @@ export declare class SheetCanvasPopManagerService extends Disposable {
     private readonly _univerInstanceService;
     private readonly _refRangeService;
     private readonly _commandService;
+    private readonly _refSelectionsService;
+    private readonly _selectionManagerService;
     private _popupMenuFeatureMap;
-    constructor(_globalPopupManagerService: ICanvasPopupService, _renderManagerService: IRenderManagerService, _univerInstanceService: IUniverInstanceService, _refRangeService: RefRangeService, _commandService: ICommandService);
+    constructor(_globalPopupManagerService: ICanvasPopupService, _renderManagerService: IRenderManagerService, _univerInstanceService: IUniverInstanceService, _refRangeService: RefRangeService, _commandService: ICommandService, _refSelectionsService: ISheetSelectionRenderService, _selectionManagerService: SheetsSelectionsService);
+    private _isSelectionMoving;
+    private _initMoving;
     /**
      * Register a feature menu callback for a specific drawing type.such as image, chart, etc.
      */
@@ -49,7 +55,7 @@ export declare class SheetCanvasPopManagerService extends Disposable {
     attachPopupToAbsolutePosition(bound: IBoundRectNoAngle, popup: ICanvasPopup, _unitId?: string, _subUnitId?: string): {
         dispose: () => void;
         canDispose: () => boolean;
-    } | null;
+    } | null | undefined;
     /**
      *
      * @param row
@@ -58,10 +64,9 @@ export declare class SheetCanvasPopManagerService extends Disposable {
      * @param _unitId
      * @param _subUnitId
      * @param viewport
-     * @param showOnSelectionMoving
      * @returns
      */
-    attachPopupToCell(row: number, col: number, popup: ICanvasPopup, _unitId?: string, _subUnitId?: string, viewport?: Viewport, showOnSelectionMoving?: boolean): Nullable<INeedCheckDisposable>;
+    attachPopupToCell(row: number, col: number, popup: ICanvasPopup, _unitId?: string, _subUnitId?: string, viewport?: Viewport): Nullable<INeedCheckDisposable>;
     private _createCellPositionObserver;
     private _calcCellPositionByCell;
 }

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

@@ -1,19 +1,20 @@
 import { ICellDataWithSpanAndDisplay, IDisposable, IRange, Nullable, Disposable, ErrorService, ICommandService, ILogService, Injector, IUndoRedoService, IUniverInstanceService, LocaleService, ObjectMatrix, ThemeService } from '@univerjs/core';
+import { Observable } from 'rxjs';
 import { IDiscreteRange } from '../../controllers/utils/range-tools';
-import { ISheetClipboardHook, COPY_TYPE } from './type';
+import { IPasteHookKeyType, IPasteOptionCache, ISheetClipboardHook, COPY_TYPE } from './type';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { SheetsSelectionsService } from '@univerjs/sheets';
 import { IClipboardInterfaceService, INotificationService, IPlatformService } from '@univerjs/ui';
 import { IMarkSelectionService } from '../mark-selection/mark-selection.service';
 import { CopyContentCache } from './copy-content-cache';
 export declare const PREDEFINED_HOOK_NAME: {
-    DEFAULT_COPY: string;
-    DEFAULT_PASTE: string;
-    SPECIAL_PASTE_VALUE: string;
-    SPECIAL_PASTE_FORMAT: string;
-    SPECIAL_PASTE_COL_WIDTH: string;
-    SPECIAL_PASTE_BESIDES_BORDER: string;
-    SPECIAL_PASTE_FORMULA: string;
+    readonly DEFAULT_COPY: "default-copy";
+    readonly DEFAULT_PASTE: "default-paste";
+    readonly SPECIAL_PASTE_VALUE: "special-paste-value";
+    readonly SPECIAL_PASTE_FORMAT: "special-paste-format";
+    readonly SPECIAL_PASTE_COL_WIDTH: "special-paste-col-width";
+    readonly SPECIAL_PASTE_BESIDES_BORDER: "special-paste-besides-border";
+    readonly SPECIAL_PASTE_FORMULA: "special-paste-formula";
 };
 interface ICopyContent {
     copyId: string;
@@ -23,10 +24,16 @@ interface ICopyContent {
     discreteRange: IDiscreteRange;
 }
 export interface ISheetClipboardService {
+    showMenu$: Observable<boolean>;
+    setShowMenu: (show: boolean) => void;
+    pasteOptionsCache$: Observable<IPasteOptionCache | null>;
+    updatePasteOptionsCache(cache: IPasteOptionCache | null): void;
     copy(): Promise<boolean>;
     cut(): Promise<boolean>;
     paste(item: ClipboardItem, pasteType?: string): Promise<boolean>;
     legacyPaste(html?: string, text?: string): Promise<boolean>;
+    rePasteWithPasteType(type: IPasteHookKeyType): boolean;
+    disposePasteOptionsCache(): void;
     generateCopyContent(workbookId: string, worksheetId: string, range: IRange): Nullable<ICopyContent>;
     copyContentCache(): CopyContentCache;
     addClipboardHook(hook: ISheetClipboardHook): IDisposable;
@@ -51,18 +58,25 @@ export declare class SheetClipboardService extends Disposable implements ISheetC
     private readonly _injector;
     private _clipboardHooks;
     private readonly _clipboardHooks$;
-    readonly clipboardHooks$: import('rxjs').Observable<ISheetClipboardHook[]>;
+    readonly clipboardHooks$: Observable<ISheetClipboardHook[]>;
     private _htmlToUSM;
     private _usmToHtml;
     private _copyContentCache;
     private _copyMarkId;
+    private _pasteOptionsCache$;
+    readonly pasteOptionsCache$: Observable<IPasteOptionCache | null>;
+    private readonly _showMenu$;
+    readonly showMenu$: Observable<boolean>;
     constructor(_logService: ILogService, _univerInstanceService: IUniverInstanceService, _selectionManagerService: SheetsSelectionsService, _clipboardInterfaceService: IClipboardInterfaceService, _undoRedoService: IUndoRedoService, _commandService: ICommandService, _markSelectionService: IMarkSelectionService, _notificationService: INotificationService, _platformService: IPlatformService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _localeService: LocaleService, _errorService: ErrorService, _injector: Injector);
+    setShowMenu(show: boolean): void;
     copyContentCache(): CopyContentCache;
     generateCopyContent(workbookId: string, worksheetId: string, range: IRange): Nullable<ICopyContent>;
     copy(copyType?: COPY_TYPE): Promise<boolean>;
     cut(): Promise<boolean>;
-    paste(item: ClipboardItem, pasteType?: string): Promise<boolean>;
+    paste(item: ClipboardItem, pasteType?: "default-paste"): Promise<boolean>;
     legacyPaste(html?: string, text?: string): Promise<boolean>;
+    rePasteWithPasteType(type: IPasteHookKeyType): boolean;
+    updatePasteOptionsCache(cache: IPasteOptionCache | null): void;
     addClipboardHook(hook: ISheetClipboardHook): IDisposable;
     getClipboardHooks(): ISheetClipboardHook[];
     private _generateCopyContent;
@@ -127,6 +141,7 @@ export declare class SheetClipboardService extends Disposable implements ISheetC
     private _topLeftCellsMatch;
     removeMarkSelection(): void;
     private _initUnitDisposed;
+    disposePasteOptionsCache(): void;
 }
 export declare function getMatrixPlainText(matrix: ObjectMatrix<ICellDataWithSpanAndDisplay>): string;
 export declare const escapeSpecialCode: (cellStr: string) => string;

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

@@ -1,5 +1,6 @@
 import { ICellData, IDocumentData, IMutationInfo, IRange, ObjectMatrix } from '@univerjs/core';
 import { IDiscreteRange } from '../../controllers/utils/range-tools';
+import { PREDEFINED_HOOK_NAME } from './clipboard.service';
 export declare enum COPY_TYPE {
     COPY = "COPY",
     CUT = "CUT"
@@ -30,7 +31,7 @@ export interface IParsedCellValueByClipboard {
 }
 export interface IUniverSheetCopyDataModel {
     rowProperties?: IClipboardPropertyItem[];
-    colProperties?: IClipboardPropertyItem[] | null;
+    colProperties?: IClipboardPropertyItem[];
     cellMatrix: ObjectMatrix<ICellDataWithSpanInfo>;
 }
 export interface IPasteTarget {
@@ -41,7 +42,7 @@ export interface IPasteTarget {
 export interface ICopyPastePayload {
     copyType?: COPY_TYPE;
     copyId?: string;
-    pasteType: string;
+    pasteType: IPasteHookValueType;
 }
 export interface ISheetDiscreteRangeLocation {
     range: IDiscreteRange;
@@ -133,3 +134,18 @@ export interface ISheetClipboardHook {
      */
     getFilteredOutRows?(range: IRange): number[];
 }
+export interface IPasteOptionCache {
+    target: IPasteTarget;
+    source?: IPasteSource;
+    cellMatrix: ObjectMatrix<ICellDataWithSpanInfo>;
+    rowProperties?: IClipboardPropertyItem[];
+    colProperties?: IClipboardPropertyItem[];
+    pasteType: IPasteHookValueType;
+}
+export type IPasteSource = ISheetDiscreteRangeLocation & {
+    copyId: string;
+    copyType: COPY_TYPE;
+};
+export type IPasteHookKeyType = Exclude<keyof typeof PREDEFINED_HOOK_NAME, 'default-copy'>;
+export type IPasteHookValueTypeWithoutDefaultCopy = typeof PREDEFINED_HOOK_NAME[IPasteHookKeyType];
+export type IPasteHookValueType = Exclude<IPasteHookValueTypeWithoutDefaultCopy, 'default-copy'>;

package/lib/types/services/editor/cell-editor-resize.service.d.ts

@@ -1,4 +1,4 @@
-import { Workbook, Disposable } from '@univerjs/core';
+import { Workbook, Disposable, IUniverInstanceService } from '@univerjs/core';
 import { IRenderContext, IRenderModule, IRenderManagerService } from '@univerjs/engine-render';
 import { ILayoutService } from '@univerjs/ui';
 import { IEditorBridgeService } from '../editor-bridge.service';
@@ -11,7 +11,8 @@ export declare class SheetCellEditorResizeService extends Disposable implements
     private readonly _editorBridgeService;
     private readonly _renderManagerService;
     private readonly _sheetSkeletonManagerService;
-    constructor(_context: IRenderContext<Workbook>, _layoutService: ILayoutService, _cellEditorManagerService: ICellEditorManagerService, _editorBridgeService: IEditorBridgeService, _renderManagerService: IRenderManagerService, _sheetSkeletonManagerService: SheetSkeletonManagerService);
+    private readonly _univerInstanceService;
+    constructor(_context: IRenderContext<Workbook>, _layoutService: ILayoutService, _cellEditorManagerService: ICellEditorManagerService, _editorBridgeService: IEditorBridgeService, _renderManagerService: IRenderManagerService, _sheetSkeletonManagerService: SheetSkeletonManagerService, _univerInstanceService: IUniverInstanceService);
     fitTextSize(callback?: () => void): void;
     /**
      * Mainly used to pre-calculate the width of the editor,

package/lib/types/services/editor-bridge.service.d.ts

@@ -42,6 +42,7 @@ export interface IEditorBridgeService {
     currentEditCellLayout$: Observable<Nullable<ICellEditorLayout>>;
     currentEditCell$: Observable<Nullable<IEditorBridgeServiceParam>>;
     visible$: Observable<IEditorBridgeServiceVisibleParam>;
+    forceKeepVisible$: Observable<boolean>;
     dispose(): void;
     refreshEditCellState(): void;
     refreshEditCellPosition(resetSizeOnly?: boolean): void;
@@ -68,7 +69,6 @@ export declare class EditorBridgeService extends Disposable implements IEditorBr
     private readonly _refSelectionsService;
     private readonly _contextService;
     private _editorUnitId;
-    private _isForceKeepVisible;
     private _editorIsDirty;
     private _isDisabled;
     private _visible;
@@ -99,6 +99,8 @@ export declare class EditorBridgeService extends Disposable implements IEditorBr
     readonly visible$: Observable<IEditorBridgeServiceVisibleParam>;
     private readonly _afterVisible$;
     readonly afterVisible$: Observable<IEditorBridgeServiceVisibleParam>;
+    private readonly _forceKeepVisible$;
+    readonly forceKeepVisible$: Observable<boolean>;
     constructor(_sheetInterceptorService: SheetInterceptorService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _univerInstanceService: IUniverInstanceService, _editorService: IEditorService, _refSelectionsService: SheetsSelectionsService, _contextService: IContextService);
     refreshEditCellState(): void;
     refreshEditCellPosition(resetSizeOnly?: boolean): void;

package/lib/types/services/hover-manager.service.d.ts

@@ -77,6 +77,12 @@ export declare class HoverManagerService extends Disposable {
     triggerPointerDown(unitId: string, event: IPointerEvent | IMouseEvent): void;
     triggerPointerUp(unitId: string, event: IPointerEvent | IMouseEvent): void;
     triggerMouseMove(unitId: string, event: IPointerEvent | IMouseEvent): void;
+    /**
+     * Trigger by pointerup.
+     * @param unitId
+     * @param offsetX
+     * @param offsetY
+     */
     triggerClick(unitId: string, offsetX: number, offsetY: number): void;
     triggerScroll(): void;
 }

package/lib/types/services/scroll-manager.service.d.ts

@@ -12,11 +12,19 @@ export interface IScrollState {
      */
     offsetY: number;
     /**
-     * current start row in viewport visible area
+     * Current start row in viewportMain in canvas, NOT the first row of visible area of current viewport after freeze.
+     * e.g. If no freeze, it's the same as startRow in current viewport.
+     * If freeze, this value is smaller than the first row of visible area.  Just pretend that viewMainTop does not exist.
+     *
+     * e.g. If row 1 ~ 2 is frozen, the first row if viewMain is 3, but sheetViewStartRow still 0.
      */
     sheetViewStartRow: number;
     /**
-     * current start column in viewport visible area
+     * Current start column in viewportMain in canvas, NOT the first column of visible area of current viewport after freeze.
+     * e.g. If no freeze, it's the same as startColumn in current viewport.
+     * If freeze, this value is smaller than the first column of visible area.  Just pretend that viewMainLeft does not exist.
+     *
+     * e.g. If column A ~ C is frozen, the first column of viewMain is D, but sheetViewStartColumn still 0.
      */
     sheetViewStartColumn: number;
 }

package/lib/types/services/selection/base-selection-render.service.d.ts

@@ -57,6 +57,7 @@ export declare class BaseSelectionRenderService extends Disposable implements IS
     readonly controlFillConfig$: Observable<IControlFillConfig | null>;
     protected _selectionControls: SelectionControl[];
     protected _startRangeWhenPointerDown: IRangeWithCoord;
+    protected _activeControlIndex: number;
     /**
      * the posX of viewport when the pointer down
      */
@@ -126,9 +127,9 @@ export declare class BaseSelectionRenderService extends Disposable implements IS
     setSingleSelectionEnabled(enabled?: boolean): void;
     newSelectionControl(scene: Scene, skeleton: SpreadsheetSkeleton, selection: ISelectionWithStyle): SelectionControl;
     /**
-     * Update the corresponding selectionControl based on selectionsData.
-     * selectionData[i] syncs selectionControls[i]
-     * @param selectionsWithCoord
+     * Update the corresponding selectionControl based on selectionsData from WorkbookSelectionModel
+     * selectionData[i] --> selectionControls[i]
+     * @param selectionsWithStyleList {ISelectionWithStyle[]} selectionsData from WorkbookSelectionModel
      */
     resetSelectionsByModelData(selectionsWithStyleList: readonly ISelectionWithStyle[]): void;
     refreshSelectionMoveStart(): void;
@@ -158,6 +159,8 @@ export declare class BaseSelectionRenderService extends Disposable implements IS
      * Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.
      */
     getActiveRange(): Nullable<IRange>;
+    setActiveSelectionIndex(index: number): void;
+    resetActiveSelectionIndex(): void;
     /**
      * get active(actually last) selection control
      * @returns T extends SelectionControl

package/lib/types/services/selection/selection-render.service.d.ts

@@ -33,6 +33,10 @@ export declare class SheetSelectionRenderService extends BaseSelectionRenderServ
     private _initUserActionSyncListener;
     /**
      * Update selectionData to selectionDataModel (WorkBookSelections) by SetSelectionsOperation.
+     *
+     * Unlike baseSelectionRenderService@resetSelectionsByModelData, this method is for update WorkbookSelectionModel.
+     *
+     *
      * @param selectionDataWithStyleList
      * @param type
      */

package/lib/types/views/cell-alert/CellAlertPopup.d.ts

@@ -1,5 +1,10 @@
-import { default as React } from 'react';
 import { ICanvasPopup } from '../../services/canvas-pop-manager.service';
+import { default as React } from 'react';
+/**
+ *
+ * @param root0
+ * @param root0.popup
+ */
 export declare function CellAlert({ popup }: {
     popup: ICanvasPopup;
 }): React.JSX.Element | null;