@univerjs/sheets-filter-ui 0.2.7 → 0.2.9

package/lib/es/index.js

@@ -2,15 +2,15 @@ var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: !0, configurable: !0, writable: !0, value }) : obj[key] = value;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: !0 });
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key != "symbol" ? key + "" : key, value);
-import { CommandType, IUniverInstanceService, ICommandService, IUndoRedoService, UniverInstanceType, Quantity, LocaleService, sequenceExecute, BooleanNumber, createIdentifier, Disposable, Inject, extractPureTextFromCell, ILogService, Injector, IContextService, useDependency, ThemeService, RxDisposable, fromCallback, runOnLifecycle, LifecycleStages, OnLifecycle, Tools, Plugin, DependentOn, Optional } from "@univerjs/core";
-import { SheetsFilterService, RemoveSheetsFilterMutation, SetSheetsFilterRangeMutation, SetSheetsFilterCriteriaMutation, ReCalcSheetsFilterMutation, CustomFilterOperator, FILTER_MUTATIONS, UniverSheetsFilterPlugin } from "@univerjs/sheets-filter";
+import { CommandType, ICommandService, IUndoRedoService, IUniverInstanceService, Quantity, LocaleService, UniverInstanceType, sequenceExecute, BooleanNumber, createIdentifier, Disposable, Inject, extractPureTextFromCell, ILogService, Injector, IContextService, useDependency, ThemeService, RxDisposable, fromCallback, Tools, Plugin, DependentOn, Optional } from "@univerjs/core";
+import { SheetsFilterService, SetSheetsFilterRangeMutation, RemoveSheetsFilterMutation, SetSheetsFilterCriteriaMutation, ReCalcSheetsFilterMutation, CustomFilterOperator, FILTER_MUTATIONS, UniverSheetsFilterPlugin } from "@univerjs/sheets-filter";
 import { toModule, IRPCChannelService, fromModule } from "@univerjs/rpc";
 import { IMessageService, ILayoutService, useObservable, useComponentsOfPart, ComponentContainer, KeyCode, MetaKeys, MenuGroup, MenuItemType, MenuPosition, getMenuHiddenObservable, ComponentManager, IShortcutService, IMenuService } from "@univerjs/ui";
 import { BehaviorSubject, ReplaySubject, of, Subject, merge, combineLatest, throttleTime, startWith, map, shareReplay, switchMap, filter, takeUntil, distinctUntilChanged } from "rxjs";
 import { SetCellEditVisibleOperation, SheetsUIPart, whenSheetEditorFocused, getCurrentRangeDisable$, SelectionShape, getCoordByCell, SheetSkeletonManagerService, SheetsRenderService, ISheetSelectionRenderService, SheetCanvasPopManagerService, SheetPermissionInterceptorBaseController } from "@univerjs/sheets-ui";
 import { Rect, Shape, IRenderManagerService } from "@univerjs/engine-render";
 import { MessageType, Select, RadioGroup, Radio, Input, Checkbox, Tooltip, Button, Segmented } from "@univerjs/design";
-import { SheetsSelectionsService, isSingleCellSelection, expandToContinuousRange, RefRangeService, WorkbookEditablePermission, WorksheetFilterPermission, WorksheetEditPermission, RangeProtectionPermissionEditPoint, INTERCEPTOR_POINT, SheetInterceptorService, RangeProtectionPermissionViewPoint } from "@univerjs/sheets";
+import { getSheetCommandTarget, SheetsSelectionsService, isSingleCellSelection, expandToContinuousRange, RefRangeService, WorkbookEditablePermission, WorksheetFilterPermission, WorksheetEditPermission, RangeProtectionPermissionEditPoint, INTERCEPTOR_POINT, SheetInterceptorService, RangeProtectionPermissionViewPoint } from "@univerjs/sheets";
 import * as React from "react";
 import React__default, { forwardRef, useRef, createElement, useCallback, useMemo as useMemo$1, version, isValidElement, useEffect, useState } from "react";
 import ReactDOM, { flushSync } from "react-dom";
@@ -69,45 +69,64 @@ var element = { tag: "svg", attrs: { fill: "none", viewBox: "0 0 17 16", width:
   }));
 });
 FilterSingle.displayName = "FilterSingle";
-const SmartToggleSheetsFilterCommand = {
-  id: "sheet.command.smart-toggle-filter",
+const SetSheetFilterRangeCommand = {
+  id: "sheet.command.set-filter-range",
   type: CommandType.COMMAND,
-  handler: /* @__PURE__ */ __name(async (accessor) => {
-    const univerInstanceService = accessor.get(IUniverInstanceService), sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), undoRedoService = accessor.get(IUndoRedoService), currentWorkbook = univerInstanceService.getCurrentUnitForType(UniverInstanceType.UNIVER_SHEET), currentWorksheet = currentWorkbook == null ? void 0 : currentWorkbook.getActiveSheet();
-    if (!currentWorksheet || !currentWorkbook) return !1;
-    const unitId = currentWorkbook.getUnitId(), subUnitId = currentWorksheet.getSheetId(), filterModel = sheetsFilterService.getFilterModel(unitId, subUnitId);
-    if (filterModel) {
-      const autoFilter = filterModel == null ? void 0 : filterModel.serialize(), undoMutations = destructFilterModel(unitId, subUnitId, autoFilter), result2 = commandService.syncExecuteCommand(RemoveSheetsFilterMutation.id, { unitId, subUnitId });
-      return result2 && undoRedoService.pushUndoRedo({
-        unitID: unitId,
-        undoMutations,
-        redoMutations: [{ id: RemoveSheetsFilterMutation.id, params: { unitId, subUnitId } }]
-      }), result2;
-    }
-    const lastSelection = accessor.get(SheetsSelectionsService).getCurrentLastSelection();
-    if (!lastSelection) return !1;
-    const startRange = lastSelection.range, targetFilterRange = isSingleCellSelection(lastSelection) ? expandToContinuousRange(startRange, { left: !0, right: !0, up: !0, down: !0 }, currentWorksheet) : startRange;
-    if (targetFilterRange.endRow === targetFilterRange.startRow) {
+  handler: /* @__PURE__ */ __name((accessor, params) => {
+    const sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), undoRedoService = accessor.get(IUndoRedoService), instanceSrv = accessor.get(IUniverInstanceService), { unitId, subUnitId, range } = params;
+    if (!getSheetCommandTarget(instanceSrv, params) || sheetsFilterService.getFilterModel(unitId, subUnitId)) return !1;
+    if (range.endRow === range.startRow) {
       const messageService = accessor.get(IMessageService, Quantity.OPTIONAL), localeService = accessor.get(LocaleService);
       return messageService == null || messageService.show({ type: MessageType.Warning, content: localeService.t("sheets-filter.command.not-valid-filter-range") }), !1;
     }
-    const redoMutation = { id: SetSheetsFilterRangeMutation.id, params: { unitId, subUnitId, range: targetFilterRange } }, result = commandService.syncExecuteCommand(redoMutation.id, redoMutation.params);
+    const redoMutation = { id: SetSheetsFilterRangeMutation.id, params: { unitId, subUnitId, range } }, result = commandService.syncExecuteCommand(redoMutation.id, redoMutation.params);
     return result && undoRedoService.pushUndoRedo({
       unitID: unitId,
       undoMutations: [{ id: RemoveSheetsFilterMutation.id, params: { unitId, subUnitId } }],
       redoMutations: [redoMutation]
     }), result;
   }, "handler")
+}, RemoveSheetFilterCommand = {
+  id: "sheet.command.remove-sheet-filter",
+  type: CommandType.COMMAND,
+  handler: /* @__PURE__ */ __name((accessor, params) => {
+    const univerInstanceService = accessor.get(IUniverInstanceService), sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), undoRedoService = accessor.get(IUndoRedoService), commandTarget = getSheetCommandTarget(univerInstanceService, params);
+    if (!commandTarget) return !1;
+    const { unitId, subUnitId } = commandTarget, filterModel = sheetsFilterService.getFilterModel(unitId, subUnitId);
+    if (!filterModel) return !1;
+    const autoFilter = filterModel == null ? void 0 : filterModel.serialize(), undoMutations = destructFilterModel(unitId, subUnitId, autoFilter), result = commandService.syncExecuteCommand(RemoveSheetsFilterMutation.id, { unitId, subUnitId });
+    return result && undoRedoService.pushUndoRedo({
+      unitID: unitId,
+      undoMutations,
+      redoMutations: [{ id: RemoveSheetsFilterMutation.id, params: { unitId, subUnitId } }]
+    }), result;
+  }, "handler")
+}, SmartToggleSheetsFilterCommand = {
+  id: "sheet.command.smart-toggle-filter",
+  type: CommandType.COMMAND,
+  handler: /* @__PURE__ */ __name(async (accessor) => {
+    const univerInstanceService = accessor.get(IUniverInstanceService), sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), currentWorkbook = univerInstanceService.getCurrentUnitForType(UniverInstanceType.UNIVER_SHEET), currentWorksheet = currentWorkbook == null ? void 0 : currentWorkbook.getActiveSheet();
+    if (!currentWorksheet || !currentWorkbook) return !1;
+    const unitId = currentWorkbook.getUnitId(), subUnitId = currentWorksheet.getSheetId();
+    if (sheetsFilterService.getFilterModel(unitId, subUnitId))
+      return commandService.executeCommand(RemoveSheetFilterCommand.id, { unitId, subUnitId });
+    const lastSelection = accessor.get(SheetsSelectionsService).getCurrentLastSelection();
+    if (!lastSelection) return !1;
+    const startRange = lastSelection.range, targetFilterRange = isSingleCellSelection(lastSelection) ? expandToContinuousRange(startRange, { left: !0, right: !0, up: !0, down: !0 }, currentWorksheet) : startRange;
+    return commandService.executeCommand(SetSheetFilterRangeCommand.id, {
+      unitId,
+      subUnitId,
+      range: targetFilterRange
+    });
+  }, "handler")
 }, SetSheetsFilterCriteriaCommand = {
   id: "sheet.command.set-filter-criteria",
   type: CommandType.COMMAND,
   handler: /* @__PURE__ */ __name(async (accessor, params) => {
     const sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), undoRedoService = accessor.get(IUndoRedoService), { unitId, subUnitId, col, criteria } = params, filterModel = sheetsFilterService.getFilterModel(unitId, subUnitId);
-    if (!filterModel)
-      return !1;
+    if (!filterModel) return !1;
     const range = filterModel.getRange();
-    if (!range || col < range.startColumn || col > range.endColumn)
-      return !1;
+    if (!range || col < range.startColumn || col > range.endColumn) return !1;
     const filterColumn = filterModel.getFilterColumn(col), undoMutation = destructFilterColumn(unitId, subUnitId, col, filterColumn), redoMutation = {
       id: SetSheetsFilterCriteriaMutation.id,
       params: {
@@ -126,26 +145,26 @@ const SmartToggleSheetsFilterCommand = {
 }, ClearSheetsFilterCriteriaCommand = {
   id: "sheet.command.clear-filter-criteria",
   type: CommandType.COMMAND,
-  handler: /* @__PURE__ */ __name((accessor) => {
-    const sheetsFilterService = accessor.get(SheetsFilterService), undoRedoService = accessor.get(IUndoRedoService), commandService = accessor.get(ICommandService), currentFilterModel = sheetsFilterService.activeFilterModel;
-    if (!currentFilterModel)
-      return !1;
-    const { unitId, subUnitId } = currentFilterModel, autoFilter = currentFilterModel.serialize(), undoMutations = destructFilterCriteria(unitId, subUnitId, autoFilter), redoMutations = generateRemoveCriteriaMutations(unitId, subUnitId, autoFilter);
-    return sequenceExecute(redoMutations, commandService) && undoRedoService.pushUndoRedo({
+  handler: /* @__PURE__ */ __name((accessor, params) => {
+    const sheetsFilterService = accessor.get(SheetsFilterService), undoRedoService = accessor.get(IUndoRedoService), commandService = accessor.get(ICommandService), instanceSrv = accessor.get(IUniverInstanceService), commandTarget = getSheetCommandTarget(instanceSrv, params);
+    if (!commandTarget) return !1;
+    const { unitId, subUnitId } = commandTarget, filterModel = sheetsFilterService.getFilterModel(commandTarget.unitId, commandTarget.subUnitId);
+    if (!filterModel) return !1;
+    const autoFilter = filterModel.serialize(), undoMutations = destructFilterCriteria(unitId, subUnitId, autoFilter), redoMutations = generateRemoveCriteriaMutations(unitId, subUnitId, autoFilter);
+    return sequenceExecute(redoMutations, commandService).result ? (undoRedoService.pushUndoRedo({
       unitID: unitId,
       undoMutations,
       redoMutations
-    }), !0;
+    }), !0) : !1;
   }, "handler")
 }, ReCalcSheetsFilterCommand = {
   id: "sheet.command.re-calc-filter",
   type: CommandType.COMMAND,
-  handler: /* @__PURE__ */ __name((accessor) => {
-    const sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), currentFilterModel = sheetsFilterService.activeFilterModel;
-    if (!currentFilterModel)
-      return !1;
-    const { unitId, subUnitId } = currentFilterModel;
-    return commandService.executeCommand(ReCalcSheetsFilterMutation.id, { unitId, subUnitId });
+  handler: /* @__PURE__ */ __name((accessor, params) => {
+    const sheetsFilterService = accessor.get(SheetsFilterService), commandService = accessor.get(ICommandService), instanceSrv = accessor.get(IUniverInstanceService), commandTarget = getSheetCommandTarget(instanceSrv, params);
+    if (!commandTarget) return !1;
+    const { unitId, subUnitId } = commandTarget;
+    return sheetsFilterService.getFilterModel(commandTarget.unitId, commandTarget.subUnitId) ? commandService.executeCommand(ReCalcSheetsFilterMutation.id, { unitId, subUnitId }) : !1;
   }, "handler")
 };
 function destructFilterModel(unitId, subUnitId, autoFilter) {
@@ -3136,18 +3155,17 @@ var __defProp$5 = Object.defineProperty, __getOwnPropDesc$5 = Object.getOwnPrope
     (decorator = decorators[i]) && (result = (kind ? decorator(target, key, result) : decorator(result)) || result);
   return kind && result && __defProp$5(target, key, result), result;
 }, "__decorateClass$5"), __decorateParam$5 = /* @__PURE__ */ __name((index2, decorator) => (target, key) => decorator(target, key, index2), "__decorateParam$5"), _a7;
-let SheetsFilterMobileUIController = (_a7 = class extends RxDisposable {
+let SheetsFilterUIMobileController = (_a7 = class extends RxDisposable {
   constructor(_renderManagerService) {
     super(), this._renderManagerService = _renderManagerService, this._initRenderControllers();
   }
   _initRenderControllers() {
     this.disposeWithMe(this._renderManagerService.registerRenderModule(UniverInstanceType.UNIVER_SHEET, [SheetsFilterRenderController]));
   }
-}, __name(_a7, "SheetsFilterMobileUIController"), _a7);
-SheetsFilterMobileUIController = __decorateClass$5([
+}, __name(_a7, "SheetsFilterUIMobileController"), _a7);
+SheetsFilterUIMobileController = __decorateClass$5([
   __decorateParam$5(0, IRenderManagerService)
-], SheetsFilterMobileUIController);
-runOnLifecycle(LifecycleStages.Rendered, SheetsFilterMobileUIController);
+], SheetsFilterUIMobileController);
 var __defProp$4 = Object.defineProperty, __getOwnPropDesc$4 = Object.getOwnPropertyDescriptor, __decorateClass$4 = /* @__PURE__ */ __name((decorators, target, key, kind) => {
   for (var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc$4(target, key) : target, i = decorators.length - 1, decorator; i >= 0; i--)
     (decorator = decorators[i]) && (result = (kind ? decorator(target, key, result) : decorator(result)) || result);
@@ -3155,7 +3173,7 @@ var __defProp$4 = Object.defineProperty, __getOwnPropDesc$4 = Object.getOwnPrope
 }, "__decorateClass$4"), __decorateParam$4 = /* @__PURE__ */ __name((index2, decorator) => (target, key) => decorator(target, key, index2), "__decorateParam$4");
 const DefaultSheetFilterUiConfig = {}, FILTER_PANEL_POPUP_KEY = "FILTER_PANEL_POPUP";
 var _a8;
-let SheetsFilterUIController = (_a8 = class extends SheetsFilterMobileUIController {
+let SheetsFilterUIDesktopController = (_a8 = class extends SheetsFilterUIMobileController {
   constructor(_config, _injector, _componentManager, _sheetsFilterPanelService, _sheetCanvasPopupService, _sheetsFilterService, _localeService, _shortcutService, _commandService, _menuService, _contextService, _messageService, _renderManagerService) {
     super(_renderManagerService);
     __publicField(this, "_popupDisposable");
@@ -3174,6 +3192,8 @@ let SheetsFilterUIController = (_a8 = class extends SheetsFilterMobileUIControll
   _initCommands() {
     [
       SmartToggleSheetsFilterCommand,
+      RemoveSheetFilterCommand,
+      SetSheetFilterRangeCommand,
       SetSheetsFilterCriteriaCommand,
       ClearSheetsFilterCriteriaCommand,
       ReCalcSheetsFilterCommand,
@@ -3221,9 +3241,8 @@ let SheetsFilterUIController = (_a8 = class extends SheetsFilterMobileUIControll
     var _a13;
     (_a13 = this._popupDisposable) == null || _a13.dispose(), this._popupDisposable = null;
   }
-}, __name(_a8, "SheetsFilterUIController"), _a8);
-SheetsFilterUIController = __decorateClass$4([
-  OnLifecycle(LifecycleStages.Rendered, SheetsFilterUIController),
+}, __name(_a8, "SheetsFilterUIDesktopController"), _a8);
+SheetsFilterUIDesktopController = __decorateClass$4([
   __decorateParam$4(1, Inject(Injector)),
   __decorateParam$4(2, Inject(ComponentManager)),
   __decorateParam$4(3, Inject(SheetsFilterPanelService)),
@@ -3236,7 +3255,7 @@ SheetsFilterUIController = __decorateClass$4([
   __decorateParam$4(10, IContextService),
   __decorateParam$4(11, IMessageService),
   __decorateParam$4(12, IRenderManagerService)
-], SheetsFilterUIController);
+], SheetsFilterUIDesktopController);
 var __defProp$3 = Object.defineProperty, __getOwnPropDesc$3 = Object.getOwnPropertyDescriptor, __decorateClass$3 = /* @__PURE__ */ __name((decorators, target, key, kind) => {
   for (var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc$3(target, key) : target, i = decorators.length - 1, decorator; i >= 0; i--)
     (decorator = decorators[i]) && (result = (kind ? decorator(target, key, result) : decorator(result)) || result);
@@ -3267,7 +3286,6 @@ let SheetsFilterPermissionController = (_a9 = class extends Disposable {
   }
 }, __name(_a9, "SheetsFilterPermissionController"), _a9);
 SheetsFilterPermissionController = __decorateClass$3([
-  OnLifecycle(LifecycleStages.Ready, SheetsFilterPermissionController),
   __decorateParam$3(0, Inject(SheetsFilterService)),
   __decorateParam$3(1, Inject(LocaleService)),
   __decorateParam$3(2, ICommandService),
@@ -3288,20 +3306,20 @@ let UniverSheetsFilterUIPlugin = (_a10 = class extends Plugin {
     [
       [SheetsFilterPanelService],
       [SheetsFilterPermissionController],
-      [
-        SheetsFilterUIController,
-        {
-          useFactory: /* @__PURE__ */ __name(() => this._injector.createInstance(SheetsFilterUIController, this._config), "useFactory")
-        }
-      ]
-    ].forEach((d2) => this._injector.add(d2)), this._config.useRemoteFilterValuesGenerator && this._rpcChannelService && this._injector.add([
-      ISheetsGenerateFilterValuesService,
-      {
-        useFactory: /* @__PURE__ */ __name(() => toModule(
-          this._rpcChannelService.requestChannel(SHEETS_GENERATE_FILTER_VALUES_SERVICE_NAME)
-        ), "useFactory")
-      }
-    ]);
+      [SheetsFilterUIDesktopController, {
+        useFactory: /* @__PURE__ */ __name(() => this._injector.createInstance(SheetsFilterUIDesktopController, this._config), "useFactory")
+      }]
+    ].forEach((d2) => this._injector.add(d2)), this._config.useRemoteFilterValuesGenerator && this._rpcChannelService && this._injector.add([ISheetsGenerateFilterValuesService, {
+      useFactory: /* @__PURE__ */ __name(() => toModule(
+        this._rpcChannelService.requestChannel(SHEETS_GENERATE_FILTER_VALUES_SERVICE_NAME)
+      ), "useFactory")
+    }]);
+  }
+  onReady() {
+    this._injector.get(SheetsFilterPermissionController);
+  }
+  onRendered() {
+    this._injector.get(SheetsFilterUIDesktopController);
   }
 }, __name(_a10, "UniverSheetsFilterUIPlugin"), _a10);
 __publicField$1(UniverSheetsFilterUIPlugin, "type", UniverInstanceType.UNIVER_SHEET);
@@ -3325,9 +3343,15 @@ let UniverSheetsFilterMobileUIPlugin = (_a11 = class extends Plugin {
   onStarting() {
     [
       [SheetsFilterPermissionController],
-      [SheetsFilterMobileUIController]
+      [SheetsFilterUIMobileController]
     ].forEach((d2) => this._injector.add(d2));
   }
+  onReady() {
+    this._injector.get(SheetsFilterPermissionController);
+  }
+  onRendered() {
+    this._injector.get(SheetsFilterUIMobileController);
+  }
 }, __name(_a11, "UniverSheetsFilterMobileUIPlugin"), _a11);
 __publicField2(UniverSheetsFilterMobileUIPlugin, "type", UniverInstanceType.UNIVER_SHEET);
 __publicField2(UniverSheetsFilterMobileUIPlugin, "pluginName", NAME);
@@ -3344,7 +3368,7 @@ let UniverSheetsFilterUIWorkerPlugin = (_a12 = class extends Plugin {
   constructor(_config, _injector, _rpcChannelService) {
     super(), this._config = _config, this._injector = _injector, this._rpcChannelService = _rpcChannelService;
   }
-  onStarting(_injector) {
+  onStarting() {
     [
       [ISheetsGenerateFilterValuesService, { useClass: SheetsGenerateFilterValuesService }]
     ].forEach((d2) => this._injector.add(d2));
@@ -3366,6 +3390,8 @@ export {
   CloseFilterPanelOperation,
   OpenFilterPanelOperation,
   ReCalcSheetsFilterCommand,
+  RemoveSheetFilterCommand,
+  SetSheetFilterRangeCommand,
   SetSheetsFilterCriteriaCommand,
   SmartToggleSheetsFilterCommand,
   UniverSheetsFilterMobileUIPlugin,

package/lib/types/__testing__/data.d.ts

@@ -1,5 +1,4 @@
 import { IWorkbookData } from '@univerjs/core';
-
 export declare function WithCustomFilterModelFactory(): IWorkbookData;
 export declare function WithValuesFilterModelFactory(): IWorkbookData;
 export declare function WithValuesAndEmptyFilterModelFactory(): IWorkbookData;

package/lib/types/commands/commands/sheets-filter.command.d.ts

@@ -1,25 +1,57 @@
-import { ICommand, IMutationInfo, Nullable } from '@univerjs/core';
+import { ICommand, IMutationInfo, IRange, Nullable } from '@univerjs/core';
 import { ISheetCommandSharedParams } from '@univerjs/sheets';
-import { IAutoFilter, IFilterColumn } from '@univerjs/sheets-filter';
-
+import { IAutoFilter, IFilterColumn, ISetSheetsFilterCriteriaMutationParams } from '@univerjs/sheets-filter';
 /**
- * This command is for toggling filter in the currently active Worksheet.
+ * Parameters of command {@link SetSheetFilterRangeCommand}.
+ * @property {IRange} range - the range to be set as filter range.
+ */
+export interface ISetSheetFilterRangeCommandParams extends ISheetCommandSharedParams {
+    range: IRange;
+}
+/**
+ * A {@link CommandType.COMMAND} to set filter range in a Worksheet. Its params {@link ISetSheetFilterRangeCommandParams}
+ * is required. If the {@link FilterModel} does not exist, it will be created.
+ */
+export declare const SetSheetFilterRangeCommand: ICommand<ISetSheetFilterRangeCommandParams>;
+/**
+ * A {@link CommandType.COMMAND} to remove filter in a Worksheet. Its params {@link ISheetCommandSharedParams} is
+ * required. If the {@link FilterModel} does not exist, it will fail to execute.
+ */
+export declare const RemoveSheetFilterCommand: ICommand<ISheetCommandSharedParams>;
+/**
+ * A {@link CommandType.COMMAND} to toggle filter in the current {@link Worksheet}.
  */
 export declare const SmartToggleSheetsFilterCommand: ICommand;
+/**
+ * Parameters of command {@link SetSheetsFilterCriteriaCommand}.
+ * @property {number} col - the column index of the filter criteria
+ * @property {Nullable<IFilterColumn>} criteria - the filter criteria to be set
+ */
 export interface ISetSheetsFilterCriteriaCommandParams extends ISheetCommandSharedParams {
     col: number;
     criteria: Nullable<IFilterColumn>;
 }
 /**
- * This command is for setting filter criteria to a column in the targeting `FilterModel`.
+ * A {@link CommandType.COMMAND} to set filter criteria to a column in the targeting {@link FilterModel}. Its params
+ * {@link ISetSheetsFilterCriteriaCommandParams} is required.
  */
 export declare const SetSheetsFilterCriteriaCommand: ICommand<ISetSheetsFilterCriteriaCommandParams>;
 /**
- * This command is for clearing all filter criteria in the currently active `FilterModel`.
+ * A {@link CommandType.COMMAND} to clear all filter criteria in the targeting {@link FilterModel}. Its params
+ * {@link ISheetCommandSharedParams} is required.
+ */
+export declare const ClearSheetsFilterCriteriaCommand: ICommand<ISheetCommandSharedParams>;
+/**
+ * A {@link CommandType.COMMAND} forcing the currently active {@link FilterModel} to re-calculate all filter criteria.
+ * Its params {@link ISheetCommandSharedParams} is required.
  */
-export declare const ClearSheetsFilterCriteriaCommand: ICommand;
+export declare const ReCalcSheetsFilterCommand: ICommand<ISheetCommandSharedParams>;
 /**
- * This command force the currently active `FilterModel` to re-calculate all filter criteria.
+ * Transform a {@link FilterModel} to a list of mutations to set the filter criteria.
+ * @param unitId - the unit id of the {@link Workbook}
+ * @param subUnitId - the sub unit id of the {@link Worksheet}
+ * @param autoFilter - the to be destructed {@link FilterModel}
+ * @returns {IMutationInfo<ISetSheetsFilterCriteriaMutationParams>} a list of mutations those can be used to
+ * reconstruct the {@link FilterModel}
  */
-export declare const ReCalcSheetsFilterCommand: ICommand;
-export declare function destructFilterCriteria(unitId: string, subUnitId: string, autoFilter: IAutoFilter): IMutationInfo[];
+export declare function destructFilterCriteria(unitId: string, subUnitId: string, autoFilter: IAutoFilter): IMutationInfo<ISetSheetsFilterCriteriaMutationParams>[];

package/lib/types/commands/operations/sheets-filter.operation.d.ts

@@ -1,6 +1,5 @@
 import { IOperation } from '@univerjs/core';
 import { FilterBy } from '../../services/sheets-filter-panel.service';
-
 export declare const FILTER_PANEL_OPENED_KEY = "FILTER_PANEL_OPENED";
 export interface IOpenFilterPanelOperationParams {
     unitId: string;

package/lib/types/controllers/sheets-filter-permission.controller.d.ts

@@ -2,7 +2,6 @@ import { Disposable, ICommandService, LocaleService } from '@univerjs/core';
 import { MenuConfig } from '@univerjs/ui';
 import { SheetPermissionInterceptorBaseController } from '@univerjs/sheets-ui';
 import { SheetsFilterService } from '@univerjs/sheets-filter';
-
 export interface IUniverSheetsFilterUIConfig {
     menu: MenuConfig;
 }

package/lib/types/controllers/{sheets-filter-ui.controller.d.ts → sheets-filter-ui-desktop.controller.d.ts}

@@ -4,8 +4,7 @@ import { SheetCanvasPopManagerService } from '@univerjs/sheets-ui';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { SheetsFilterService } from '@univerjs/sheets-filter';
 import { SheetsFilterPanelService } from '../services/sheets-filter-panel.service';
-import { SheetsFilterMobileUIController } from './sheets-filter-mobile-ui.controller';
-
+import { SheetsFilterUIMobileController } from './sheets-filter-ui-mobile.controller';
 export interface IUniverSheetsFilterUIConfig {
     menu: MenuConfig;
     useRemoteFilterValuesGenerator?: boolean;
@@ -15,7 +14,7 @@ export declare const FILTER_PANEL_POPUP_KEY = "FILTER_PANEL_POPUP";
 /**
  * This controller controls the UI of "filter" features. Menus, commands and filter panel etc. Except for the rendering.
  */
-export declare class SheetsFilterUIController extends SheetsFilterMobileUIController {
+export declare class SheetsFilterUIDesktopController extends SheetsFilterUIMobileController {
     private readonly _config;
     private readonly _injector;
     private readonly _componentManager;

package/lib/types/controllers/{sheets-filter-mobile-ui.controller.d.ts → sheets-filter-ui-mobile.controller.d.ts}

@@ -1,7 +1,6 @@
 import { RxDisposable } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
-
-export declare class SheetsFilterMobileUIController extends RxDisposable {
+export declare class SheetsFilterUIMobileController extends RxDisposable {
     private readonly _renderManagerService;
     constructor(_renderManagerService: IRenderManagerService);
     private _initRenderControllers;

package/lib/types/controllers/sheets-filter.menu.d.ts

@@ -1,6 +1,5 @@
 import { IMenuButtonItem, IMenuSelectorItem } from '@univerjs/ui';
 import { IAccessor } from '@univerjs/core';
-
 export declare function SmartToggleFilterMenuItemFactory(accessor: IAccessor): IMenuSelectorItem;
 export declare function ClearFilterCriteriaMenuItemFactory(accessor: IAccessor): IMenuButtonItem;
 export declare function ReCalcFilterMenuItemFactory(accessor: IAccessor): IMenuButtonItem;

package/lib/types/controllers/sheets-filter.shortcut.d.ts

@@ -1,3 +1,2 @@
 import { IShortcutItem } from '@univerjs/ui';
-
 export declare const SmartToggleFilterShortcut: IShortcutItem;

package/lib/types/{plugin.d.ts → filter-ui-desktop.plugin.d.ts}

@@ -1,7 +1,9 @@
 import { Injector, Plugin, UniverInstanceType } from '@univerjs/core';
 import { IRPCChannelService } from '@univerjs/rpc';
-import { IUniverSheetsFilterUIConfig } from './controllers/sheets-filter-ui.controller';
-
+import { IUniverSheetsFilterUIConfig } from './controllers/sheets-filter-ui-desktop.controller';
+/**
+ * The plugin for the desktop version of the sheets filter UI. Its type is {@link UniverInstanceType.UNIVER_SHEET}.
+ */
 export declare class UniverSheetsFilterUIPlugin extends Plugin {
     private readonly _config;
     protected readonly _injector: Injector;
@@ -10,4 +12,6 @@ export declare class UniverSheetsFilterUIPlugin extends Plugin {
     static pluginName: string;
     constructor(_config: Partial<IUniverSheetsFilterUIConfig>, _injector: Injector, _rpcChannelService?: IRPCChannelService | undefined);
     onStarting(): void;
+    onReady(): void;
+    onRendered(): void;
 }

package/lib/types/{mobile-plugin.d.ts → filter-ui-mobile.plugin.d.ts}

@@ -1,6 +1,5 @@
 import { Injector, Plugin, UniverInstanceType } from '@univerjs/core';
-import { IUniverSheetsFilterUIConfig } from './controllers/sheets-filter-ui.controller';
-
+import { IUniverSheetsFilterUIConfig } from './controllers/sheets-filter-ui-desktop.controller';
 export declare class UniverSheetsFilterMobileUIPlugin extends Plugin {
     private readonly _config;
     protected readonly _injector: Injector;
@@ -8,4 +7,6 @@ export declare class UniverSheetsFilterMobileUIPlugin extends Plugin {
     static pluginName: string;
     constructor(_config: Partial<IUniverSheetsFilterUIConfig>, _injector: Injector);
     onStarting(): void;
+    onReady(): void;
+    onRendered(): void;
 }

package/lib/types/index.d.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { UniverSheetsFilterUIPlugin } from './plugin';
-export { UniverSheetsFilterMobileUIPlugin } from './mobile-plugin';
+export { UniverSheetsFilterUIPlugin } from './filter-ui-desktop.plugin';
+export { UniverSheetsFilterMobileUIPlugin } from './filter-ui-mobile.plugin';
 export { UniverSheetsFilterUIWorkerPlugin } from './worker/plugin';
-export { SmartToggleSheetsFilterCommand, SetSheetsFilterCriteriaCommand, ClearSheetsFilterCriteriaCommand, ReCalcSheetsFilterCommand, } from './commands/commands/sheets-filter.command';
+export { SmartToggleSheetsFilterCommand, SetSheetsFilterCriteriaCommand, ClearSheetsFilterCriteriaCommand, SetSheetFilterRangeCommand, RemoveSheetFilterCommand, type ISetSheetFilterRangeCommandParams, ReCalcSheetsFilterCommand, type ISetSheetsFilterCriteriaCommandParams, } from './commands/commands/sheets-filter.command';
 export { OpenFilterPanelOperation, CloseFilterPanelOperation, ChangeFilterByOperation, type IOpenFilterPanelOperationParams, } from './commands/operations/sheets-filter.operation';

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

@@ -1,4 +1,3 @@
 import { default as zhCN } from './zh-CN';
-
 declare const locale: typeof zhCN;
 export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -1,4 +1,3 @@
 import { default as zhCN } from './zh-CN';
-
 declare const locale: typeof zhCN;
 export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -1,4 +1,3 @@
 import { default as zhCN } from './zh-CN';
-
 declare const locale: typeof zhCN;
 export default locale;

package/lib/types/locale/zh-TW.d.ts

@@ -1,4 +1,3 @@
 import { default as zhCN } from './zh-CN';
-
 declare const locale: typeof zhCN;
 export default locale;

package/lib/types/models/conditions.d.ts

@@ -1,7 +1,6 @@
 import { Nullable } from '@univerjs/core';
 import { IFilterColumn, CustomFilterOperator } from '@univerjs/sheets-filter';
 import { ExtendCustomFilterOperator, OperatorOrder } from './extended-operators';
-
 export type FilterOperator = ExtendCustomFilterOperator | CustomFilterOperator;
 export interface IFilterConditionFormParams {
     and?: true;

package/lib/types/models/utils.d.ts

@@ -1,5 +1,4 @@
 import { IFilterByValueItem } from '../services/sheets-filter-panel.service';
-
 export declare function statisticFilterByValueItems(items: IFilterByValueItem[]): {
     checked: number;
     unchecked: number;

package/lib/types/services/sheets-filter-panel.service.d.ts

@@ -3,7 +3,6 @@ import { FilterColumn, FilterModel } from '@univerjs/sheets-filter';
 import { Observable } from 'rxjs';
 import { RefRangeService } from '@univerjs/sheets';
 import { FilterOperator, IFilterConditionFormParams, IFilterConditionItem } from '../models/conditions';
-
 export declare enum FilterBy {
     VALUES = 0,
     CONDITIONS = 1

package/lib/types/views/components/SheetsFilterByConditionsPanel.d.ts

@@ -1,6 +1,5 @@
 import { default as React } from 'react';
 import { ByConditionsModel } from '../../services/sheets-filter-panel.service';
-
 /**
  * Filter by conditions.
  */

package/lib/types/views/components/SheetsFilterByValuesPanel.d.ts

@@ -1,6 +1,5 @@
 import { default as React } from 'react';
 import { ByValuesModel } from '../../services/sheets-filter-panel.service';
-
 /**
  * Filter by values.
  */

package/lib/types/views/components/SheetsFilterPanel.d.ts

@@ -1,5 +1,4 @@
 import { default as React } from 'react';
-
 /**
  * This Filter Panel component is used to filter the data in the sheet.
  *

package/lib/types/views/components/SheetsFilterPanel.stories.d.ts

@@ -1,7 +1,6 @@
 import { default as React } from 'react';
 import { Meta } from '@storybook/react';
 import { FilterPanel } from './SheetsFilterPanel';
-
 declare const meta: Meta<typeof FilterPanel>;
 export default meta;
 export declare const FilterWithConditions: {

package/lib/types/views/widgets/drawings.d.ts

@@ -1,5 +1,4 @@
 import { UniverRenderingContext2D } from '@univerjs/engine-render';
-
 export declare const FILTER_BUTTON_EMPTY: Path2D;
 export declare class FilterButton {
     static drawNoCriteria(ctx: UniverRenderingContext2D, size: number, fgColor: string, bgColor: string): void;

package/lib/types/views/widgets/filter-button.shape.d.ts

@@ -1,6 +1,5 @@
 import { ICommandService, IContextService, ThemeService } from '@univerjs/core';
 import { IMouseEvent, IPointerEvent, IShapeProps, Shape, UniverRenderingContext2D } from '@univerjs/engine-render';
-
 export declare const FILTER_ICON_SIZE = 16;
 export declare const FILTER_ICON_PADDING = 1;
 export interface ISheetsFilterButtonShapeProps extends IShapeProps {

package/lib/types/{controllers/sheets-filter-render.controller.d.ts → views/widgets/render-modules/sheets-filter.render-controller.d.ts}

@@ -3,7 +3,6 @@ import { IRenderContext, IRenderModule, IRenderManagerService } from '@univerjs/
 import { SheetInterceptorService } from '@univerjs/sheets';
 import { SheetsFilterService } from '@univerjs/sheets-filter';
 import { ISheetSelectionRenderService, SheetSkeletonManagerService, SheetsRenderService } from '@univerjs/sheets-ui';
-
 export declare class SheetsFilterRenderController extends RxDisposable implements IRenderModule {
     private readonly _context;
     private readonly _injector;

package/lib/types/worker/generate-filter-values.service.d.ts

@@ -1,6 +1,5 @@
 import { IRange, Worksheet, Disposable, ILogService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IFilterByValueItem } from '../services/sheets-filter-panel.service';
-
 export interface ISheetsGenerateFilterValuesService {
     getFilterValues(params: {
         unitId: string;

package/lib/types/worker/plugin.d.ts

@@ -1,6 +1,5 @@
 import { Injector, Plugin, UniverInstanceType } from '@univerjs/core';
 import { IRPCChannelService } from '@univerjs/rpc';
-
 export declare class UniverSheetsFilterUIWorkerPlugin extends Plugin {
     private readonly _config;
     protected readonly _injector: Injector;
@@ -8,6 +7,6 @@ export declare class UniverSheetsFilterUIWorkerPlugin extends Plugin {
     static type: UniverInstanceType;
     static pluginName: string;
     constructor(_config: unknown, _injector: Injector, _rpcChannelService: IRPCChannelService);
-    onStarting(_injector?: Injector): void;
+    onStarting(): void;
     onReady(): void;
 }