@univerjs/sheets-ui 0.5.4-nightly.202501171606 → 0.5.4-nightly.202501181605

package/lib/types/controllers/clipboard/utils.d.ts

@@ -48,17 +48,6 @@ export declare function getSetCellValueMutations(pasteTo: ISheetDiscreteRangeLoc
     undos: IMutationInfo<object>[];
     redos: IMutationInfo<object>[];
 };
-/**
- *
- * @param pasteTo
- * @param pasteFrom
- * @param matrix
- * @param accessor
- */
-export declare function getSetCellCustomMutations(pasteTo: ISheetDiscreteRangeLocation, pasteFrom: Nullable<ISheetDiscreteRangeLocation>, matrix: ObjectMatrix<ICellDataWithSpanInfo>, accessor: IAccessor): {
-    undos: IMutationInfo<object>[];
-    redos: IMutationInfo<object>[];
-};
 /**
  *
  * @param pasteTo

package/lib/types/services/auto-fill/tools.d.ts

@@ -106,3 +106,8 @@ export declare function getAutoFillRepeatRange(sourceRange: IRange, targetRange:
  * @returns
  */
 export declare function needsUpdateCellValue(cell: ICellData): boolean;
+/**
+ * Remove cell.custom
+ * @param cell
+ */
+export declare function removeCellCustom(cell: Nullable<ICellData>): void;

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

@@ -56,20 +56,36 @@ export interface ISpecialPasteInfo {
 /**
  * `ClipboardHook` could:
  * 1. Before copy/cut/paste, decide whether to execute the command and prepare caches if necessary.
- * 1. When copying, decide what content could be written into clipboard.
- * 1. When pasting, get access to the clipboard content and append mutations to the paste command.
+ * 2. When copying, decide what content could be written into clipboard.
+ * 3. When pasting, get access to the clipboard content and append mutations to the paste command.
  */
 export interface ISheetClipboardHook {
+    /**
+     * The unique id of the hook.
+     */
     id: string;
+    /**
+     * Whether this hook is the default hook.
+     */
     isDefaultHook?: boolean;
+    /**
+     * Only special paste info should be provided, which will replace the default hook.
+     */
     specialPasteInfo?: ISpecialPasteInfo;
+    /**
+     * The priority of the hook. The higher the priority, the earlier the hook would be called.
+     */
     priority?: number;
     /**
      * The callback would be called after the clipboard service has decided what region need to be copied.
      * Features could use this hook to build copying cache or any other pre-copy jobs.
+     * @param unitId
+     * @param subUnitId
+     * @param range
      */
     onBeforeCopy?(unitId: string, subUnitId: string, range: IRange): void;
     /**
+     * Properties that would be appended to the td element.
      *
      * @param row
      * @param col
@@ -82,16 +98,21 @@ export interface ISheetClipboardHook {
      * @deprecated should be merged with `onCopyCellContent` to `onCopyCell`
      * @param row row of the the copied cell
      * @param col col of the the copied cell
+     * @param rowSpan row span of the the copied cell
+     * @param colSpan col span of the the copied cell
+     * @return content
      */
     onCopyCellStyle?(row: number, col: number, rowSpan?: number, colSpan?: number): IClipboardPropertyItem | null;
     /**
      * Properties that would be appended to the tr element.
      * @param row each row of the the copied range
+     * @return content
      */
     onCopyRow?(row: number): IClipboardPropertyItem | null;
     /**
      * Properties that would be appended to the col element.
      * @param col each col of the copied range
+     * @return content
      */
     onCopyColumn?(col: number): IClipboardPropertyItem | null;
     /**
@@ -103,30 +124,65 @@ export interface ISheetClipboardHook {
      * The callback would be called after the clipboard service has decided what region need to be pasted.
      * Features could use this hook to build copying cache or any other pre-copy jobs.
      *
+     * @param pasteTo
      * @returns if it block copying it should return false
      */
     onBeforePaste?(pasteTo: ISheetDiscreteRangeLocation): boolean;
     /**
+     * Handles pasting cells, it needs to return Undo Mutations & Redo Mutations that handle the cell contents
      *
-     * @param row
-     * @param col
+     * @param pasteFrom
+     * @param pasteTo
+     * @param data
+     * @param payload
+     * @returns undo and redo mutations
      */
     onPasteCells?(pasteFrom: ISheetDiscreteRangeLocation | null, pasteTo: ISheetDiscreteRangeLocation, data: ObjectMatrix<ICellDataWithSpanInfo>, payload: ICopyPastePayload): {
         undos: IMutationInfo[];
         redos: IMutationInfo[];
     };
+    /**
+     * Handle the pasted row properties, it needs to return the Undo Mutations & Redo Mutations that handle the row properties
+     *
+     * @param pasteTo
+     * @param rowProperties
+     * @param payload
+     * @returns undo and redo mutations
+     */
     onPasteRows?(pasteTo: ISheetDiscreteRangeLocation, rowProperties: IClipboardPropertyItem[], payload: ICopyPastePayload): {
         undos: IMutationInfo[];
         redos: IMutationInfo[];
     };
+    /**
+     * Handle the pasted column properties, it needs to return the Undo Mutations & Redo Mutations that handle the column properties
+     *
+     * @param pasteTo
+     * @param colProperties
+     * @param payload
+     * @returns undo and redo mutations
+     */
     onPasteColumns?(pasteTo: ISheetDiscreteRangeLocation, colProperties: IClipboardPropertyItem[], payload: ICopyPastePayload): {
         undos: IMutationInfo[];
         redos: IMutationInfo[];
     };
+    /**
+     * Hanle the pasted plain text, it needs to return the Undo Mutations & Redo Mutations that handle the plain text
+     *
+     * @param pasteTo
+     * @param text
+     * @param payload
+     * @returns undo and redo mutations
+     */
     onPastePlainText?(pasteTo: ISheetDiscreteRangeLocation, text: string, payload: ICopyPastePayload): {
         undos: IMutationInfo[];
         redos: IMutationInfo[];
     };
+    /**
+     * Would be called after paste content has been written into Univer.
+     * Features could do some cleaning up jobs here.
+     *
+     * @param success whether the paste operation is successful
+     */
     onAfterPaste?(success: boolean): void;
     /**
      * The callback would be called before the clipboard service decides what region need to be copied from or pasted to.