@univerjs/sheets-sort 0.6.0 → 0.6.1

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

@@ -6,29 +6,32 @@ import { FRange, FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
 export interface IFSheetSortEventMixin {
     /**
      * This event will be emitted when a range on a worksheet is sorted.
-     * Type of the event is {@link ISheetRangeSortedParams}.
+     * @see {@link ISheetRangeSortParams}
      * @example
      * ```typescript
      * const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeSorted, (params) => {
-     *   const { workbook, worksheet, sortColumn } = params;
-     *   sortColumn.forEach((col) => {
-     *    console.log(col.column, col.ascending);
-     *  });
+     *   console.log(params);
+     *   const { workbook, worksheet, range, sortColumn } = params;
      * });
+     *
+     * // Remove the event listener, use `callbackDisposable.dispose()`
      * ```
      */
     SheetRangeSorted: 'SheetRangeSorted';
     /**
      * This event will be emitted before sorting a range on a worksheet.
-     * Type of the event is {@link ISheetRangeSortParams}.
+     * @see {@link ISheetRangeSortParams}
      * @example
      * ```typescript
      * const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeSort, (params) => {
-     *   const { workbook, worksheet, sortColumn } = params;
-     *   sortColumn.forEach((col) => {
-     *    console.log(col.column, col.ascending);
-     *   });
+     *   console.log(params);
+     *   const { workbook, worksheet, range, sortColumn } = params;
+     *
+     *   // Cancel the sorting operation.
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `callbackDisposable.dispose()`
      * ```
      */
     SheetBeforeRangeSort: 'SheetBeforeRangeSort';

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

@@ -5,15 +5,19 @@ import { FWorksheet } from '@univerjs/sheets/facade';
 export interface IFWorksheetSort {
     /**
      * Sort the worksheet by the specified column.
-     * @param {number} colIndex The column index to sort by. which starts from 1.
+     * @param {number} colIndex The column index to sort by.
      * @param {boolean} [asc=true] The sort order. `true` for ascending, `false` for descending.
-     * @returns The worksheet itself for chaining.
+     * @returns {FWorksheet} The worksheet itself for chaining.
      * @example
      * ```typescript
-     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
-     * const activeSheet = activeSpreadsheet.getActiveSheet();
-     * activeSheet.sort(1); // Sorts the worksheet by the first column in ascending order.
-     * activeSheet.sort(1, false); // Sorts the worksheet by the first column in descending order.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Sorts the worksheet by the column A in ascending order.
+     * fWorksheet.sort(0);
+     *
+     * // Sorts the worksheet by the column A in descending order.
+     * fWorksheet.sort(0, false);
      * ```
      */
     sort(colIndex: number, asc?: boolean): FWorksheet;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-sort",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "private": false,
   "description": "A library for sorting data in Univer Sheet",
   "author": "DreamNum <developer@univer.ai>",
@@ -53,15 +53,15 @@
     "lib"
   ],
   "dependencies": {
-    "@univerjs/core": "0.6.0",
-    "@univerjs/engine-formula": "0.6.0",
-    "@univerjs/sheets": "0.6.0"
+    "@univerjs/core": "0.6.1",
+    "@univerjs/sheets": "0.6.1",
+    "@univerjs/engine-formula": "0.6.1"
   },
   "devDependencies": {
     "typescript": "^5.7.3",
-    "vite": "^6.1.0",
-    "vitest": "^3.0.5",
-    "@univerjs-infra/shared": "0.6.0"
+    "vite": "^6.1.1",
+    "vitest": "^3.0.6",
+    "@univerjs-infra/shared": "0.6.1"
   },
   "scripts": {
     "test": "vitest run",