@univerjs/sheets-filter-ui 0.1.8

package/lib/index.css

@@ -0,0 +1 @@
+.univer-sheets-filter-panel{display:flex;width:312px;height:400px;flex-direction:column;background:rgb(var(--bg-color-secondary));border-radius:10px;box-sizing:border-box;box-shadow:var(--box-shadow-lg);padding:16px;overflow:hidden}.univer-sheets-filter-panel-header{flex-grow:0;flex-shrink:0;margin-bottom:4px}.univer-sheets-filter-panel-content{flex-grow:1;flex-shrink:1;overflow:hidden;padding-top:8px}.univer-sheets-filter-panel-select-all{font-size:13px;margin-right:4px}.univer-sheets-filter-panel-select-all-count{font-size:13px;color:rgb(var(--grey-400))}.univer-sheets-filter-panel-values-container{display:flex;height:100%;flex-direction:column}.univer-sheets-filter-panel-values-container>.univer-input-affix-wrapper{flex:0 0 32px}.univer-sheets-filter-panel-values-container .univer-select,.univer-sheets-filter-panel-values-container .univer-input-affix-wrapper,.univer-sheets-filter-panel-values-container .univer-radio-group{width:100%}.univer-sheets-filter-panel-values-find{height:32px;margin-bottom:8px}.univer-sheets-filter-panel-values-list{flex-grow:1;margin-top:8px;border:1px solid rgb(var(--grey-200));box-sizing:border-box;border-radius:6px;overflow:hidden;display:flex;flex-direction:column;padding:6px 0 6px 8px}.univer-sheets-filter-panel-values-list-inner-container{padding-right:8px}.univer-sheets-filter-panel-values-virtual{flex-grow:1}.univer-sheets-filter-panel-values-item{box-sizing:border-box;height:32px;padding:2px 0;width:100%}.univer-sheets-filter-panel-values-item-inner{align-items:center;padding:0 2px 0 24px;line-height:28px;box-sizing:border-box;border-radius:6px;height:28px;display:flex;font-size:13px}.univer-sheets-filter-panel-values-item-inner:hover{background-color:rgb(var(--grey-50))}.univer-sheets-filter-panel-values-item-inner:hover .univer-sheets-filter-panel-values-item-count{margin-right:2px}.univer-sheets-filter-panel-values-item-inner:hover .univer-sheets-filter-panel-values-item-exclude-button{box-sizing:border-box;margin-left:auto;display:inline-block;height:24px;font-size:12px;line-height:12px}.univer-sheets-filter-panel-values-item-inner:hover .univer-sheets-filter-panel-values-item-exclude-button:hover{background-color:rgb(var(--hyacinth-50))}.univer-sheets-filter-panel-values-item-inner:hover .univer-sheets-filter-panel-values-item-exclude-button:active{background-color:rgb(var(--hyacinth-100))}.univer-sheets-filter-panel-values-item-text{display:inline-block;height:100%;margin:0 4px;flex-shrink:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.univer-sheets-filter-panel-values-item-count{color:rgb(var(--grey-400))}.univer-sheets-filter-panel-values-item-exclude-button{display:none}.univer-sheets-filter-panel-conditions-container{display:flex;flex-direction:column;height:100%}.univer-sheets-filter-panel-conditions-container .univer-select,.univer-sheets-filter-panel-conditions-container .univer-input-affix-wrapper,.univer-sheets-filter-panel-conditions-container .univer-radio-group{width:100%;margin-bottom:8px}.univer-sheets-filter-panel-conditions-container-inner{flex-grow:1;border-radius:6px;border:1px solid rgb(var(--grey-200));overflow:hidden;padding:8px}.univer-sheets-filter-panel-conditions-desc{margin-top:-6px;color:rgb(var(--grey-500));font-size:12px;line-height:18px}.univer-sheets-filter-panel-footer{margin-top:16px;flex-grow:0;flex-shrink:0;display:inline-flex;flex-wrap:nowrap;overflow:hidden;justify-content:space-between}.univer-sheets-filter-panel-footer-primary-buttons>.univer-button{margin-left:12px}.univer-sheets-filter-panel .univer-select,.univer-sheets-filter-panel .univer-input{width:100%}.univer-sheets-filter-panel .univer-form-dual-column-layout{margin-bottom:8px}

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

@@ -0,0 +1,22 @@
+import { IWorkbookData } from '@univerjs/core';
+
+export declare function WithCustomFilterModelFactory(): IWorkbookData;
+export declare function WithValuesFilterModelFactory(): IWorkbookData;
+export declare function WithValuesAndEmptyFilterModelFactory(): IWorkbookData;
+export declare function WithMultiEmptyCellsModelFactory(): IWorkbookData;
+export declare function WithTwoFilterColumnsFactory(): IWorkbookData;
+export declare function WithMergedCellFilterFactory(): IWorkbookData;
+export declare const ITEMS: {
+    checked: boolean;
+    count: number;
+    index: number;
+    isEmpty: boolean;
+    value: string;
+}[];
+export declare const E_ITEMS: {
+    checked: boolean;
+    count: number;
+    index: number;
+    isEmpty: boolean;
+    value: string;
+}[];

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};

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

@@ -0,0 +1,25 @@
+import { IAutoFilter, IFilterColumn } from '@univerjs/sheets-filter';
+import { ISheetCommandSharedParams } from '@univerjs/sheets';
+import { ICommand, IMutationInfo, Nullable } from '@univerjs/core';
+
+/**
+ * This command is for toggling filter in the currently active Worksheet.
+ */
+export declare const SmartToggleSheetsFilterCommand: ICommand;
+export interface ISetSheetsFilterCriteriaCommandParams extends ISheetCommandSharedParams {
+    col: number;
+    criteria: Nullable<IFilterColumn>;
+}
+/**
+ * This command is for setting filter criteria to a column in the targeting `FilterModel`.
+ */
+export declare const SetSheetsFilterCriteriaCommand: ICommand<ISetSheetsFilterCriteriaCommandParams>;
+/**
+ * This command is for clearing all filter criteria in the currently active `FilterModel`.
+ */
+export declare const ClearSheetsFilterCriteriaCommand: ICommand;
+/**
+ * This command force the currently active `FilterModel` to re-calculate all filter criteria.
+ */
+export declare const ReCalcSheetsFilterCommand: ICommand;
+export declare function destructFilterCriteria(unitId: string, subUnitId: string, autoFilter: IAutoFilter): IMutationInfo[];

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

@@ -0,0 +1,18 @@
+import { FilterBy } from '../services/sheets-filter-panel.service';
+import { IOperation } from '@univerjs/core';
+
+export declare const FILTER_PANEL_OPENED_KEY = "FILTER_PANEL_OPENED";
+export interface IOpenFilterPanelOperationParams {
+    unitId: string;
+    subUnitId: string;
+    col: number;
+}
+/**
+ * The operation to open the filter panel and prepare for changing the filter conditions on a given column.
+ */
+export declare const OpenFilterPanelOperation: IOperation<IOpenFilterPanelOperationParams>;
+export declare const CloseFilterPanelOperation: IOperation;
+export interface IChangeFilterByOperationParams {
+    filterBy: FilterBy;
+}
+export declare const ChangeFilterByOperation: IOperation<IChangeFilterByOperationParams>;

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};

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

@@ -0,0 +1,28 @@
+import { Injector } from '@wendellhu/redi';
+import { ISelectionRenderService, SheetRenderController, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
+import { SheetsFilterService } from '@univerjs/sheets-filter';
+import { SheetInterceptorService } from '@univerjs/sheets';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { ICommandService, IUniverInstanceService, RxDisposable, ThemeService } from '@univerjs/core';
+
+export declare class SheetsFilterRenderController extends RxDisposable {
+    private readonly _injector;
+    private readonly _sheetSkeletonManagerService;
+    private readonly _sheetsFilterService;
+    private readonly _themeService;
+    private readonly _sheetInterceptorService;
+    private _sheetRenderController;
+    private readonly _commandService;
+    private readonly _univerInstanceService;
+    private readonly _renderManagerService;
+    private readonly _selectionRenderService;
+    private _filterRangeShape;
+    private _buttonRenderDisposable;
+    private _filterButtonShapes;
+    constructor(_injector: Injector, _sheetSkeletonManagerService: SheetSkeletonManagerService, _sheetsFilterService: SheetsFilterService, _themeService: ThemeService, _sheetInterceptorService: SheetInterceptorService, _sheetRenderController: SheetRenderController, _commandService: ICommandService, _univerInstanceService: IUniverInstanceService, _renderManagerService: IRenderManagerService, _selectionRenderService: ISelectionRenderService);
+    private _initRenderer;
+    private _renderRange;
+    private _renderButtons;
+    private _interceptCellContent;
+    private _disposeRendering;
+}

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

@@ -0,0 +1,29 @@
+import { SheetsFilterPanelService } from '../services/sheets-filter-panel.service';
+import { SheetCanvasPopManagerService } from '@univerjs/sheets-ui';
+import { Injector } from '@wendellhu/redi';
+import { ComponentManager, IMenuService, IShortcutService } from '@univerjs/ui';
+import { ICommandService, IContextService, RxDisposable } from '@univerjs/core';
+
+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 RxDisposable {
+    private readonly _injector;
+    private readonly _componentManager;
+    private readonly _sheetsFilterPanelService;
+    private _sheetCanvasPopupService;
+    private readonly _shortcutService;
+    private readonly _commandService;
+    private readonly _menuService;
+    private readonly _contextService;
+    constructor(_injector: Injector, _componentManager: ComponentManager, _sheetsFilterPanelService: SheetsFilterPanelService, _sheetCanvasPopupService: SheetCanvasPopManagerService, _shortcutService: IShortcutService, _commandService: ICommandService, _menuService: IMenuService, _contextService: IContextService);
+    dispose(): void;
+    private _initShortcuts;
+    private _initCommands;
+    private _initMenuItems;
+    private _initUI;
+    private _popupDisposable?;
+    private _openFilterPopup;
+    private _closeFilterPopup;
+}

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

@@ -0,0 +1,6 @@
+import { IAccessor } from '@wendellhu/redi';
+import { IMenuButtonItem, IMenuSelectorItem } from '@univerjs/ui';
+
+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

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

package/lib/types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export { UniverSheetsFilterUIPlugin } from './plugin';
+export { default as enUS } from './locale/en-US';
+export { default as zhCN } from './locale/zh-CN';

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

@@ -0,0 +1,66 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+declare const _default: {
+    'sheets-filter': {
+        toolbar: {
+            'smart-toggle-filter-tooltip': string;
+            'clear-filter-criteria': string;
+            're-calc-filter-conditions': string;
+        };
+        command: {
+            'not-valid-filter-range': string;
+        };
+        shortcut: {
+            'smart-toggle-filter': string;
+        };
+        panel: {
+            'clear-filter': string;
+            cancel: string;
+            confirm: string;
+            'by-values': string;
+            'by-conditions': string;
+            'filter-only': string;
+            'search-placeholder': string;
+            'select-all': string;
+            'input-values-placeholder': string;
+            and: string;
+            or: string;
+            empty: string;
+            '?': string;
+            '*': string;
+        };
+        conditions: {
+            none: string;
+            empty: string;
+            'not-empty': string;
+            'text-contains': string;
+            'does-not-contain': string;
+            'starts-with': string;
+            'ends-with': string;
+            equals: string;
+            'greater-than': string;
+            'greater-than-or-equal': string;
+            'less-than': string;
+            'less-than-or-equal': string;
+            equal: string;
+            'not-equal': string;
+            between: string;
+            'not-between': string;
+            custom: string;
+        };
+    };
+};
+export default _default;

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

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export { default as enUS } from './en-US';
+export { default as zhCN } from './zh-CN';

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

@@ -0,0 +1,4 @@
+import { default as enUS } from './en-US';
+
+declare const zLocale: typeof enUS;
+export default zLocale;

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};

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

@@ -0,0 +1,75 @@
+import { ExtendCustomFilterOperator, OperatorOrder } from './extended-operators';
+import { IFilterColumn, CustomFilterOperator } from '@univerjs/sheets-filter';
+import { Nullable } from '@univerjs/core';
+
+export type FilterOperator = ExtendCustomFilterOperator | CustomFilterOperator;
+export interface IFilterConditionFormParams {
+    and?: true;
+    operator1?: FilterOperator;
+    val1?: string;
+    operator2?: FilterOperator;
+    val2?: string;
+}
+export interface IFilterConditionItem {
+    operator: FilterOperator;
+    numOfParameters: number;
+    order: OperatorOrder;
+    /**
+     * Name of the filter condition. Should be an i18n key.
+     */
+    label: string;
+    and?: true;
+    /**
+     * Get the initial form parameters for this condition item. This should only be called when `numOfParameters` is not `0`.
+     */
+    getDefaultFormParams(): IFilterConditionFormParams;
+    /**
+     * Test if the form params can be mapped to this condition item. This should be called when the
+     * condition form changes and `numOfParameters` is not `0`.
+     * @param params
+     */
+    testMappingParams(params: IFilterConditionFormParams): boolean;
+    /**
+     * When user confirm changing filter condition, this method will be called to map the form params
+     * to the filter column data.
+     * @param mapParams
+     */
+    mapToFilterColumn(mapParams: IFilterConditionFormParams): Nullable<Omit<IFilterColumn, 'colId'>>;
+    /**
+     * Test if the filter column data can be mapped to this condition item.
+     * It should return the mapping parameters if it can be mapped, otherwise `false`.
+     * This should be called when the filter panel opens.
+     *
+     * @param filterColumn
+     * @returns the mapping parameters if it can be mapped, otherwise `false`
+     */
+    testMappingFilterColumn(filterColumn: Omit<IFilterColumn, 'colId'>): IFilterConditionFormParams | false;
+}
+export declare namespace FilterConditionItems {
+    const NONE: IFilterConditionItem;
+    const EMPTY: IFilterConditionItem;
+    const NOT_EMPTY: IFilterConditionItem;
+    const TEXT_CONTAINS: IFilterConditionItem;
+    const DOES_NOT_CONTAIN: IFilterConditionItem;
+    const STARTS_WITH: IFilterConditionItem;
+    const ENDS_WITH: IFilterConditionItem;
+    const EQUALS: IFilterConditionItem;
+    const GREATER_THAN: IFilterConditionItem;
+    const GREATER_THAN_OR_EQUAL: IFilterConditionItem;
+    const LESS_THAN: IFilterConditionItem;
+    const LESS_THAN_OR_EQUAL: IFilterConditionItem;
+    const EQUAL: IFilterConditionItem;
+    const NOT_EQUAL: IFilterConditionItem;
+    const BETWEEN: IFilterConditionItem;
+    const NOT_BETWEEN: IFilterConditionItem;
+    /**
+     * This should be test last. If no other condition item can be mapped, then it should be mapped.
+     */
+    const CUSTOM: IFilterConditionItem;
+    const ALL_CONDITIONS: IFilterConditionItem[];
+    function getItemByOperator(operator: FilterOperator): IFilterConditionItem;
+    function testMappingParams(mapParams: IFilterConditionFormParams, numOfParameters: number): IFilterConditionItem;
+    function getInitialFormParams(operator: FilterOperator): IFilterConditionFormParams;
+    function mapToFilterColumn(condition: IFilterConditionItem, mapParams: IFilterConditionFormParams): Nullable<Omit<IFilterColumn, 'colId'>>;
+    function testMappingFilterColumn(filterColumn: Nullable<Omit<IFilterColumn, 'colId'>>): [IFilterConditionItem, IFilterConditionFormParams];
+}

package/lib/types/models/extended-operators.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export declare enum OperatorOrder {
+    FIRST = 0,
+    SECOND = 1
+}
+/**
+ * Extended custom filter operators.
+ *
+ * These operators are not defined in OOXML,
+ * so when exporting these operators we need to fallback to `CustomFilterOperator` and
+ * other possible filter types.
+ */
+export declare enum ExtendCustomFilterOperator {
+    NONE = "none",
+    /** Fallback to `<customFilter val="123*" />` */
+    STARTS_WITH = "startsWith",
+    /** Fallback to `<customFilter operator="notEqual" val="123*" />` */
+    DOES_NOT_START_WITH = "doesNotStartWith",
+    /** Fallback to `<customFilter val="*123" />` */
+    ENDS_WITH = "endsWith",
+    /** Fallback to `<customFilter operator="notEqual" val="*123" />` */
+    DOES_NOT_END_WITH = "doesNotEndWith",
+    /** Fallback to `<customFilter val="*123*" />` */
+    CONTAINS = "contains",
+    /** Fallback to `<customFilter operator="notEqual" val="*123*" />` */
+    DOES_NOT_CONTAIN = "doesNotContain",
+    /**
+     * Text equals. It is not same as CustomFilterOperator.EQUAL.
+     *
+     * When equals empty, it will be mapped to.
+     *
+     * <autoFilter>
+     *   <filterColumn colId="0">
+     *     <filters blank="1"/>
+     *   </filterColumn>
+     * </autoFilter>
+     */
+    EQUALS = "equals",
+    /** Fallback to `<customFilter operator="notEqual" val="" />` */
+    NOT_EQUALS = "notEquals",
+    /**
+     * Fallback to `<filter blank="1" />`.
+     *
+     * It can also fallback to `<customFilter val="" />`, when with another custom filter.
+     */
+    EMPTY = "empty",
+    /** Fallback to `<customFilter operator="notEqual" val=" " />` */
+    NOT_EMPTY = "notEmpty",
+    /**
+     * Falls back to the following XML:
+     *
+     * ```xml
+     * <customFilters and="1">
+     *     <customFilter operator="greaterThanOrEqual" val="123"/>
+     *     <customFilter operator="lessThanOrEqual" val="456"/>
+     * </customFilters>
+     * ```
+     *
+     * Actually in Microsoft Excel, `NOT_BETWEEN` is still `BETWEEN`, as long as the two operators
+     * are `greaterThanOrEqual` and `lessThanOrEqual`.
+     */
+    BETWEEN = "between",
+    /**
+     * Falls back to the following XML:
+     *
+     * ```xml
+     * <customFilters> <!-- no `and="1"` means `OR` -->
+     *     <customFilter operator="lessThan" val="456"/>
+     *     <customFilter operator="greaterThan" val="123"/>
+     * </customFilters>
+     * ```
+     */
+    NOT_BETWEEN = "notBetween",
+    CUSTOM = "custom"
+}

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

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

package/lib/types/plugin.d.ts

@@ -0,0 +1,11 @@
+import { Injector } from '@wendellhu/redi';
+import { LocaleService, Plugin, UniverInstanceType } from '@univerjs/core';
+
+export declare class UniverSheetsFilterUIPlugin extends Plugin {
+    protected readonly _injector: Injector;
+    private readonly _localeService;
+    static type: UniverInstanceType;
+    static pluginName: string;
+    constructor(_config: unknown, _injector: Injector, _localeService: LocaleService);
+    onStarting(injector: Injector): void;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};