Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

feat(facade): move cf command from sheets-conditional-formatting-ui to sheets-conditional-formatting package (#4743)

wpxp123456fdbde5b1ca69
diff --git a/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts b/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts
index 927e957b43..2cf7860684 100644
--- a/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts
+++ b/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts
@@ -19,7 +19,17 @@ import type { FUniver } from '@univerjs/core/facade';
import { ICommandService } from '@univerjs/core/services/command/command.service.js';
import { RemoveOtherFormulaMutation } from '@univerjs/engine-formula';
import { SetSelectionsOperation } from '@univerjs/sheets';
-import { AddConditionalRuleMutation, ConditionalFormattingViewModel, DeleteConditionalRuleMutation, MoveConditionalRuleMutation, SetConditionalRuleMutation } from '@univerjs/sheets-conditional-formatting';
+import {
+ AddCfCommand,
+ AddConditionalRuleMutation,
+ ConditionalFormattingViewModel,
+ DeleteCfCommand,
+ DeleteConditionalRuleMutation,
+ MoveCfCommand,
+ MoveConditionalRuleMutation,
+ SetCfCommand,
+ SetConditionalRuleMutation,
+} from '@univerjs/sheets-conditional-formatting';
import { beforeEach, describe, expect, it } from 'vitest';
import { createFacadeTestBed } from '../../__tests__/create-test-bed';
@@ -39,7 +49,18 @@ describe('Test conditional formatting facade', () => {
univer = testBed.univer;
commandService = get(ICommandService);
- [AddConditionalRuleMutation, DeleteConditionalRuleMutation, MoveConditionalRuleMutation, SetConditionalRuleMutation, SetSelectionsOperation, RemoveOtherFormulaMutation].forEach((m) => {
+ [
+ AddCfCommand,
+ AddConditionalRuleMutation,
+ DeleteCfCommand,
+ DeleteConditionalRuleMutation,
+ MoveCfCommand,
+ MoveConditionalRuleMutation,
+ SetConditionalRuleMutation,
+ SetCfCommand,
+ SetSelectionsOperation,
+ RemoveOtherFormulaMutation,
+ ].forEach((m) => {
commandService.registerCommand(m);
});
});
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/operations/open-conditional-formatting-panel.ts b/packages/sheets-conditional-formatting-ui/src/commands/operations/open-conditional-formatting-panel.ts
index c23ddc695d..cb479eeb9d 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/operations/open-conditional-formatting-panel.ts
+++ b/packages/sheets-conditional-formatting-ui/src/commands/operations/open-conditional-formatting-panel.ts
@@ -15,14 +15,11 @@
*/
import type { IAccessor, ICommand } from '@univerjs/core';
+import type { IClearRangeCfParams, IColorScale, IConditionFormattingRule, IDataBar, IFormulaHighlightCell, IIconSet, IRankHighlightCell } from '@univerjs/sheets-conditional-formatting';
import { CommandType, ICommandService } from '@univerjs/core';
import { SheetsSelectionsService } from '@univerjs/sheets';
-import { CFRuleType, CFSubRuleType, createDefaultRule } from '@univerjs/sheets-conditional-formatting';
-import type { IColorScale, IConditionFormattingRule, IDataBar, IFormulaHighlightCell, IIconSet, IRankHighlightCell } from '@univerjs/sheets-conditional-formatting';
+import { CFRuleType, CFSubRuleType, ClearRangeCfCommand, ClearWorksheetCfCommand, createDefaultRule } from '@univerjs/sheets-conditional-formatting';
import { ConditionalFormattingPanelController } from '../../controllers/cf.panel.controller';
-import type { IClearRangeCfParams } from '../commands/clear-range-cf.command';
-import { ClearRangeCfCommand } from '../commands/clear-range-cf.command';
-import { ClearWorksheetCfCommand } from '../commands/clear-worksheet-cf.command';
interface IOpenConditionalFormattingOperatorParams {
value: number;
diff --git a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-edit/index.tsx b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-edit/index.tsx
index 3cf0b57100..88acb456a5 100644
--- a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-edit/index.tsx
+++ b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-edit/index.tsx
@@ -16,23 +16,16 @@
import type { IRange, Workbook } from '@univerjs/core';
import type { IRemoveSheetMutationParams } from '@univerjs/sheets';
-import type { IConditionFormattingRule } from '@univerjs/sheets-conditional-formatting';
-import type { IAddCfCommandParams } from '../../../commands/commands/add-cf.command';
-import type { ISetCfCommandParams } from '../../../commands/commands/set-cf.command';
-
+import type { IAddCfCommandParams, IConditionFormattingRule, ISetCfCommandParams } from '@univerjs/sheets-conditional-formatting';
import type { IStyleEditorProps } from './type';
import { ICommandService, InterceptorManager, IUniverInstanceService, LocaleService, UniverInstanceType } from '@univerjs/core';
import { Button, Select } from '@univerjs/design';
import { deserializeRangeWithSheet, serializeRange } from '@univerjs/engine-formula';
import { RemoveSheetMutation, setEndForRange, SetWorksheetActiveOperation, SheetsSelectionsService } from '@univerjs/sheets';
-import { CFRuleType, CFSubRuleType, ConditionalFormattingRuleModel } from '@univerjs/sheets-conditional-formatting';
+import { AddCfCommand, CFRuleType, CFSubRuleType, ConditionalFormattingRuleModel, SetCfCommand } from '@univerjs/sheets-conditional-formatting';
import { RangeSelector } from '@univerjs/sheets-formula-ui';
import { useDependency } from '@univerjs/ui';
-
import React, { useEffect, useMemo, useRef, useState } from 'react';
-import { AddCfCommand } from '../../../commands/commands/add-cf.command';
-
-import { SetCfCommand } from '../../../commands/commands/set-cf.command';
import styleBase from '../index.module.less';
import { ColorScaleStyleEditor } from './ColorScale';
import { DataBarStyleEditor } from './DataBar';
diff --git a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx
index 4e3381e773..fae7e29faa 100644
--- a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx
+++ b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx
@@ -15,24 +15,19 @@
*/
import type { IRange, Workbook } from '@univerjs/core';
-import type { IConditionFormattingRule } from '@univerjs/sheets-conditional-formatting';
-import type { IDeleteCfCommandParams } from '../../../commands/commands/delete-cf.command';
-import type { IMoveCfCommand } from '../../../commands/commands/move-cf.command';
+import type { IConditionFormattingRule, IDeleteCfCommandParams, IMoveCfCommandParams } from '@univerjs/sheets-conditional-formatting';
import { ICommandService, Injector, IUniverInstanceService, LocaleService, Rectangle, UniverInstanceType } from '@univerjs/core';
import { Select, Tooltip } from '@univerjs/design';
import { serializeRange } from '@univerjs/engine-formula';
import { DeleteSingle, IncreaseSingle, SequenceSingle } from '@univerjs/icons';
import { checkRangesEditablePermission, SetSelectionsOperation, SetWorksheetActiveOperation, SheetsSelectionsService } from '@univerjs/sheets';
-import { AddConditionalRuleMutation, CFRuleType, CFSubRuleType, ConditionalFormattingRuleModel, DeleteConditionalRuleMutation, MoveConditionalRuleMutation, SetConditionalRuleMutation } from '@univerjs/sheets-conditional-formatting';
+import { AddConditionalRuleMutation, CFRuleType, CFSubRuleType, ClearWorksheetCfCommand, ConditionalFormattingRuleModel, DeleteCfCommand, DeleteConditionalRuleMutation, MoveCfCommand, MoveConditionalRuleMutation, SetConditionalRuleMutation } from '@univerjs/sheets-conditional-formatting';
import { useHighlightRange } from '@univerjs/sheets-ui';
import { useDependency, useObservable } from '@univerjs/ui';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import GridLayout from 'react-grid-layout';
import { debounceTime, Observable } from 'rxjs';
-import { ClearWorksheetCfCommand } from '../../../commands/commands/clear-worksheet-cf.command';
-import { DeleteCfCommand } from '../../../commands/commands/delete-cf.command';
-import { MoveCfCommand } from '../../../commands/commands/move-cf.command';
import { ConditionalFormattingI18nController } from '../../../controllers/cf.i18n.controller';
import { Preview } from '../../preview';
import styles from './index.module.less';
@@ -272,7 +267,7 @@ export const RuleList = (props: IRuleListProps) => {
const cfId = ruleList[getSaveIndex(from.y)].cfId;
const targetCfId = ruleList[getSaveIndex(to.y)].cfId;
if (cfId !== targetCfId) {
- commandService.executeCommand(MoveCfCommand.id, { unitId, subUnitId, start: { id: cfId, type: 'self' }, end: { id: targetCfId, type: to.y > from.y ? 'after' : 'before' } } as IMoveCfCommand);
+ commandService.executeCommand(MoveCfCommand.id, { unitId, subUnitId, start: { id: cfId, type: 'self' }, end: { id: targetCfId, type: to.y > from.y ? 'after' : 'before' } } as IMoveCfCommandParams);
}
};
@@ -347,10 +342,11 @@ export const RuleList = (props: IRuleListProps) => {
</Tooltip>
)
: (
- <div className={`
- ${styles.gap}
- ${styles.disabled}
- `}
+ <div
+ className={`
+ ${styles.gap}
+ ${styles.disabled}
+ `}
>
<DeleteSingle />
</div>
diff --git a/packages/sheets-conditional-formatting-ui/src/controllers/cf.permission.controller.ts b/packages/sheets-conditional-formatting-ui/src/controllers/cf.permission.controller.ts
index b13039da19..8732d796c0 100644
--- a/packages/sheets-conditional-formatting-ui/src/controllers/cf.permission.controller.ts
+++ b/packages/sheets-conditional-formatting-ui/src/controllers/cf.permission.controller.ts
@@ -15,10 +15,10 @@
*/
import type { ICommandInfo } from '@univerjs/core';
-import type { IAddCfCommandParams } from '../commands/commands/add-cf.command';
+import type { IAddCfCommandParams } from '@univerjs/sheets-conditional-formatting';
import { Disposable, ICommandService, Inject, LocaleService } from '@univerjs/core';
import { RangeProtectionPermissionEditPoint, SheetPermissionCheckController, WorkbookEditablePermission, WorksheetEditPermission, WorksheetSetCellStylePermission } from '@univerjs/sheets';
-import { AddCfCommand } from '../commands/commands/add-cf.command';
+import { AddCfCommand } from '@univerjs/sheets-conditional-formatting';
export class ConditionalFormattingPermissionController extends Disposable {
constructor(
diff --git a/packages/sheets-conditional-formatting-ui/src/index.ts b/packages/sheets-conditional-formatting-ui/src/index.ts
index f049cdfc36..5d06bd4d53 100644
--- a/packages/sheets-conditional-formatting-ui/src/index.ts
+++ b/packages/sheets-conditional-formatting-ui/src/index.ts
@@ -23,7 +23,6 @@ export { ConditionalFormattingClearController } from './controllers/cf.clear.con
// #region - all commands
export { AddAverageCfCommand } from './commands/commands/add-average-cf.command';
-export { AddCfCommand, type IAddCfCommandParams } from './commands/commands/add-cf.command';
export { AddColorScaleConditionalRuleCommand } from './commands/commands/add-color-scale-cf.command';
export { AddDataBarConditionalRuleCommand } from './commands/commands/add-data-bar-cf.command';
export { AddDuplicateValuesCfCommand } from './commands/commands/add-duplicate-values-cf.command';
@@ -32,11 +31,6 @@ export { AddRankCfCommand } from './commands/commands/add-rank-cf.command';
export { AddTextCfCommand } from './commands/commands/add-text-cf.command';
export { AddTimePeriodCfCommand } from './commands/commands/add-time-period-cf.command';
export { AddUniqueValuesCfCommand } from './commands/commands/add-unique-values-cf.command';
-export { ClearRangeCfCommand } from './commands/commands/clear-range-cf.command';
-export { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.command';
-export { DeleteCfCommand } from './commands/commands/delete-cf.command';
-export { MoveCfCommand } from './commands/commands/move-cf.command';
-export { SetCfCommand } from './commands/commands/set-cf.command';
export { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';
diff --git a/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts b/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts
index 055bb3a8b8..19f3854e51 100644
--- a/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts
+++ b/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts
@@ -27,7 +27,6 @@ import {
} from '@univerjs/core';
import { SHEET_CONDITIONAL_FORMATTING_PLUGIN, UniverSheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';
import { AddAverageCfCommand } from './commands/commands/add-average-cf.command';
-import { AddCfCommand } from './commands/commands/add-cf.command';
import { AddColorScaleConditionalRuleCommand } from './commands/commands/add-color-scale-cf.command';
import { AddDataBarConditionalRuleCommand } from './commands/commands/add-data-bar-cf.command';
import { AddDuplicateValuesCfCommand } from './commands/commands/add-duplicate-values-cf.command';
@@ -36,11 +35,6 @@ import { AddRankCfCommand } from './commands/commands/add-rank-cf.command';
import { AddTextCfCommand } from './commands/commands/add-text-cf.command';
import { AddTimePeriodCfCommand } from './commands/commands/add-time-period-cf.command';
import { AddUniqueValuesCfCommand } from './commands/commands/add-unique-values-cf.command';
-import { ClearRangeCfCommand } from './commands/commands/clear-range-cf.command';
-import { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.command';
-import { DeleteCfCommand } from './commands/commands/delete-cf.command';
-import { MoveCfCommand } from './commands/commands/move-cf.command';
-import { SetCfCommand } from './commands/commands/set-cf.command';
import { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';
import { ConditionalFormattingCopyPasteController } from './controllers/cf.copy-paste.controller';
@@ -95,12 +89,6 @@ export class UniverSheetsConditionalFormattingMobileUIPlugin extends Plugin {
AddTimePeriodCfCommand,
AddUniqueValuesCfCommand,
OpenConditionalFormattingOperator,
- DeleteCfCommand,
- SetCfCommand,
- MoveCfCommand,
- AddCfCommand,
- ClearRangeCfCommand,
- ClearWorksheetCfCommand,
].forEach((m) => {
this._commandService.registerCommand(m);
});
diff --git a/packages/sheets-conditional-formatting-ui/src/plugin.ts b/packages/sheets-conditional-formatting-ui/src/plugin.ts
index 1765fe3228..da18fe8ef6 100644
--- a/packages/sheets-conditional-formatting-ui/src/plugin.ts
+++ b/packages/sheets-conditional-formatting-ui/src/plugin.ts
@@ -29,7 +29,6 @@ import {
} from '@univerjs/core';
import { SHEET_CONDITIONAL_FORMATTING_PLUGIN, UniverSheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';
import { AddAverageCfCommand } from './commands/commands/add-average-cf.command';
-import { AddCfCommand } from './commands/commands/add-cf.command';
import { AddColorScaleConditionalRuleCommand } from './commands/commands/add-color-scale-cf.command';
import { AddDataBarConditionalRuleCommand } from './commands/commands/add-data-bar-cf.command';
import { AddDuplicateValuesCfCommand } from './commands/commands/add-duplicate-values-cf.command';
@@ -38,11 +37,6 @@ import { AddRankCfCommand } from './commands/commands/add-rank-cf.command';
import { AddTextCfCommand } from './commands/commands/add-text-cf.command';
import { AddTimePeriodCfCommand } from './commands/commands/add-time-period-cf.command';
import { AddUniqueValuesCfCommand } from './commands/commands/add-unique-values-cf.command';
-import { ClearRangeCfCommand } from './commands/commands/clear-range-cf.command';
-import { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.command';
-import { DeleteCfCommand } from './commands/commands/delete-cf.command';
-import { MoveCfCommand } from './commands/commands/move-cf.command';
-import { SetCfCommand } from './commands/commands/set-cf.command';
import { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';
import { ConditionalFormattingAutoFillController } from './controllers/cf.auto-fill.controller';
@@ -140,12 +134,6 @@ export class UniverSheetsConditionalFormattingUIPlugin extends Plugin {
AddTimePeriodCfCommand,
AddUniqueValuesCfCommand,
OpenConditionalFormattingOperator,
- DeleteCfCommand,
- SetCfCommand,
- MoveCfCommand,
- AddCfCommand,
- ClearRangeCfCommand,
- ClearWorksheetCfCommand,
].forEach((m) => {
this._commandService.registerCommand(m);
});
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/add-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/add-cf.command.ts
similarity index 86%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/add-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/add-cf.command.ts
index a639a37055..8caae0779d 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/add-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/add-cf.command.ts
@@ -15,6 +15,9 @@
*/
import type { ICommand } from '@univerjs/core';
+import type { IConditionFormattingRule } from '../../models/type';
+import type { MakePropertyOptional } from '../../utils/type';
+import type { IAddConditionalRuleMutationParams } from '../mutations/add-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -22,8 +25,8 @@ import {
IUniverInstanceService,
} from '@univerjs/core';
import { getSheetCommandTarget } from '@univerjs/sheets';
-import type { IAddConditionalRuleMutationParams, IConditionFormattingRule, MakePropertyOptional } from '@univerjs/sheets-conditional-formatting';
-import { AddConditionalRuleMutation, AddConditionalRuleMutationUndoFactory, ConditionalFormattingRuleModel } from '@univerjs/sheets-conditional-formatting';
+import { ConditionalFormattingRuleModel } from '../../models/conditional-formatting-rule-model';
+import { AddConditionalRuleMutation, AddConditionalRuleMutationUndoFactory } from '../mutations/add-conditional-rule.mutation';
export interface IAddCfCommandParams {
unitId?: string;
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/clear-range-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/clear-range-cf.command.ts
similarity index 85%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/clear-range-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/clear-range-cf.command.ts
index af5b2b0a12..964a8c9965 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/clear-range-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/clear-range-cf.command.ts
@@ -17,6 +17,9 @@
import type { ICommand, IMutationInfo,
IRange,
} from '@univerjs/core';
+import type { IConditionFormattingRule } from '../../models/type';
+import type { IDeleteConditionalRuleMutationParams } from '../mutations/delete-conditional-rule.mutation';
+import type { ISetConditionalRuleMutationParams } from '../mutations/set-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -27,9 +30,9 @@ import {
sequenceExecute,
} from '@univerjs/core';
import { createTopMatrixFromMatrix, findAllRectangle, getSheetCommandTarget, SheetsSelectionsService } from '@univerjs/sheets';
-
-import { ConditionalFormattingRuleModel, DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory, SetConditionalRuleMutation, setConditionalRuleMutationUndoFactory } from '@univerjs/sheets-conditional-formatting';
-import type { IConditionFormattingRule, IDeleteConditionalRuleMutationParams, ISetConditionalRuleMutationParams } from '@univerjs/sheets-conditional-formatting';
+import { ConditionalFormattingRuleModel } from '../../models/conditional-formatting-rule-model';
+import { DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory } from '../mutations/delete-conditional-rule.mutation';
+import { SetConditionalRuleMutation, setConditionalRuleMutationUndoFactory } from '../mutations/set-conditional-rule.mutation';
export interface IClearRangeCfParams {
ranges?: IRange[];
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/clear-worksheet-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/clear-worksheet-cf.command.ts
similarity index 87%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/clear-worksheet-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/clear-worksheet-cf.command.ts
index 83cf34c1cf..bed95c6ead 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/clear-worksheet-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/clear-worksheet-cf.command.ts
@@ -15,6 +15,7 @@
*/
import type { ICommand, IMutationInfo } from '@univerjs/core';
+import type { IDeleteConditionalRuleMutationParams } from '../mutations/delete-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -23,9 +24,8 @@ import {
sequenceExecute,
} from '@univerjs/core';
import { getSheetCommandTarget } from '@univerjs/sheets';
-import { ConditionalFormattingRuleModel, DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory } from '@univerjs/sheets-conditional-formatting';
-
-import type { IDeleteConditionalRuleMutationParams } from '@univerjs/sheets-conditional-formatting';
+import { ConditionalFormattingRuleModel } from '../../models/conditional-formatting-rule-model';
+import { DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory } from '../mutations/delete-conditional-rule.mutation';
export interface IClearWorksheetCfParams {
unitId?: string;
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/delete-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/delete-cf.command.ts
similarity index 92%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/delete-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/delete-cf.command.ts
index e5d4ac8fd4..e3d2fe6396 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/delete-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/delete-cf.command.ts
@@ -15,6 +15,7 @@
*/
import type { ICommand } from '@univerjs/core';
+import type { IDeleteConditionalRuleMutationParams } from '../mutations/delete-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -22,8 +23,7 @@ import {
IUniverInstanceService,
} from '@univerjs/core';
import { getSheetCommandTarget } from '@univerjs/sheets';
-import type { IDeleteConditionalRuleMutationParams } from '@univerjs/sheets-conditional-formatting';
-import { DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory } from '@univerjs/sheets-conditional-formatting';
+import { DeleteConditionalRuleMutation, DeleteConditionalRuleMutationUndoFactory } from '../mutations/delete-conditional-rule.mutation';
export interface IDeleteCfCommandParams {
unitId?: string;
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/move-cf.command.ts
similarity index 81%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/move-cf.command.ts
index 71491205d8..918a79fa98 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/move-cf.command.ts
@@ -15,6 +15,8 @@
*/
import type { ICommand } from '@univerjs/core';
+import type { IAnchor } from '../../utils/anchor';
+import type { IMoveConditionalRuleMutationParams } from '../mutations/move-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -22,16 +24,17 @@ import {
IUniverInstanceService,
} from '@univerjs/core';
import { getSheetCommandTarget } from '@univerjs/sheets';
-import type { IAnchor, IMoveConditionalRuleMutationParams } from '@univerjs/sheets-conditional-formatting';
-import { ConditionalFormattingRuleModel, MoveConditionalRuleMutation, MoveConditionalRuleMutationUndoFactory, transformSupportSymmetryAnchor } from '@univerjs/sheets-conditional-formatting';
+import { ConditionalFormattingRuleModel } from '../../models/conditional-formatting-rule-model';
+import { transformSupportSymmetryAnchor } from '../../utils/anchor';
+import { MoveConditionalRuleMutation, MoveConditionalRuleMutationUndoFactory } from '../mutations/move-conditional-rule.mutation';
-export interface IMoveCfCommand {
+export interface IMoveCfCommandParams {
unitId?: string;
subUnitId?: string;
start: IAnchor;
end: IAnchor;
};
-export const MoveCfCommand: ICommand<IMoveCfCommand> = {
+export const MoveCfCommand: ICommand<IMoveCfCommandParams> = {
type: CommandType.COMMAND,
id: 'sheet.command.move-conditional-rule',
handler(accessor, params) {
diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/set-cf.command.ts b/packages/sheets-conditional-formatting/src/commands/commands/set-cf.command.ts
similarity index 87%
rename from packages/sheets-conditional-formatting-ui/src/commands/commands/set-cf.command.ts
rename to packages/sheets-conditional-formatting/src/commands/commands/set-cf.command.ts
index ade9493a17..0e9aa4a84a 100644
--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/set-cf.command.ts
+++ b/packages/sheets-conditional-formatting/src/commands/commands/set-cf.command.ts
@@ -15,6 +15,8 @@
*/
import type { ICommand } from '@univerjs/core';
+import type { IConditionFormattingRule } from '../../models/type';
+import type { ISetConditionalRuleMutationParams } from '../mutations/set-conditional-rule.mutation';
import {
CommandType,
ICommandService,
@@ -22,12 +24,12 @@ import {
IUniverInstanceService,
} from '@univerjs/core';
import { getSheetCommandTarget } from '@univerjs/sheets';
-import type { IConditionFormattingRule, ISetConditionalRuleMutationParams } from '@univerjs/sheets-conditional-formatting';
-import { SetConditionalRuleMutation, setConditionalRuleMutationUndoFactory } from '@univerjs/sheets-conditional-formatting';
+import { SetConditionalRuleMutation, setConditionalRuleMutationUndoFactory } from '../mutations/set-conditional-rule.mutation';
export interface ISetCfCommandParams {
unitId?: string;
subUnitId?: string;
+ cfId?: string;
rule: IConditionFormattingRule;
};
export const SetCfCommand: ICommand<ISetCfCommandParams> = {
@@ -46,7 +48,7 @@ export const SetCfCommand: ICommand<ISetCfCommandParams> = {
if (!target) return false;
const { unitId, subUnitId } = target;
- const config: ISetConditionalRuleMutationParams = { unitId, subUnitId, rule: params.rule };
+ const config: ISetConditionalRuleMutationParams = { unitId, subUnitId, rule: params.rule, cfId: params.cfId };
const undos = setConditionalRuleMutationUndoFactory(accessor, config);
const result = commandService.syncExecuteCommand(SetConditionalRuleMutation.id, config);
if (result) {
diff --git a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
index b8a21a7c1b..ef8b0f5490 100644
--- a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
+++ b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
@@ -94,7 +94,7 @@ class ConditionalFormatRuleBaseBuilder {
return obj;
}
- build() {
+ build(): IConditionFormattingRule {
if (!this._rule.cfId) {
this._rule.cfId = createCfId();
}
@@ -654,7 +654,18 @@ export class FConditionalFormattingBuilder {
}
- build() {
+ /**
+ * Constructs a conditional format rule from the settings applied to the builder.
+ * @returns {IConditionFormattingRule} The conditional format rule.
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getActiveSheet();
+ * const rule = fWorksheet.newConditionalFormattingRule().build();
+ * fWorksheet.setConditionalFormattingRules([rule]);
+ * ```
+ */
+ build(): IConditionFormattingRule {
return new ConditionalFormatRuleBaseBuilder(this._initConfig).build();
}
diff --git a/packages/sheets-conditional-formatting/src/facade/f-range.ts b/packages/sheets-conditional-formatting/src/facade/f-range.ts
index 57250091a1..113c25ec3e 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-range.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-range.ts
@@ -17,6 +17,7 @@
import type {
IAddConditionalRuleMutationParams,
IAnchor,
+ IClearRangeCfParams,
IConditionFormattingRule,
IDeleteConditionalRuleMutationParams,
IMoveConditionalRuleMutationParams,
@@ -25,6 +26,7 @@ import type {
import { Rectangle } from '@univerjs/core';
import {
AddConditionalRuleMutation,
+ ClearRangeCfCommand,
ConditionalFormattingRuleModel,
DeleteConditionalRuleMutation,
MoveConditionalRuleMutation,
@@ -140,6 +142,13 @@ export interface IFRangeConditionalFormattingMixin {
* ```
*/
setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): FRange;
+
+ /**
+ * Clear the conditional rules for the range.
+ * @returns {FRange} Returns the current range instance for method chaining
+ * @memberof IFRangeConditionalFormattingMixin
+ */
+ clearConditionalFormatRules(): FRange;
}
export class FRangeConditionalFormattingMixin extends FRange implements IFRangeConditionalFormattingMixin {
@@ -191,6 +200,16 @@ export class FRangeConditionalFormattingMixin extends FRange implements IFRangeC
this._commandService.syncExecuteCommand(SetConditionalRuleMutation.id, params);
return this;
}
+
+ override clearConditionalFormatRules(): FRange {
+ const params: IClearRangeCfParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
+ ranges: [this._range],
+ };
+ this._commandService.syncExecuteCommand(ClearRangeCfCommand.id, params);
+ return this;
+ }
}
FRange.extend(FRangeConditionalFormattingMixin);
diff --git a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
index dd71e21a4f..b12c7d6f70 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
@@ -15,19 +15,21 @@
*/
import type {
- IAddConditionalRuleMutationParams,
+ IAddCfCommandParams,
IAnchor,
+ IClearWorksheetCfParams,
IConditionFormattingRule,
- IDeleteConditionalRuleMutationParams,
- IMoveConditionalRuleMutationParams,
- ISetConditionalRuleMutationParams,
+ IDeleteCfCommandParams,
+ IMoveCfCommandParams,
+ ISetCfCommandParams,
} from '@univerjs/sheets-conditional-formatting';
import {
- AddConditionalRuleMutation,
+ AddCfCommand,
+ ClearWorksheetCfCommand,
ConditionalFormattingRuleModel,
- DeleteConditionalRuleMutation,
- MoveConditionalRuleMutation,
- SetConditionalRuleMutation,
+ DeleteCfCommand,
+ MoveCfCommand,
+ SetCfCommand,
} from '@univerjs/sheets-conditional-formatting';
import { FWorksheet } from '@univerjs/sheets/facade';
import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
@@ -175,6 +177,20 @@ export interface IFWorksheetConditionalFormattingMixin {
* ```
*/
setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): FWorksheet;
+
+ /**
+ * Removes all conditional format rules from the sheet.
+ * @returns {FWorksheet} Returns the current worksheet instance for method chaining
+ * @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getActiveSheet();
+ * fWorksheet.clearConditionalFormatRules();
+ * console.log(fWorksheet.getConditionalFormattingRules());
+ * ```
+ */
+ clearConditionalFormatRules(): FWorksheet;
}
export class FWorksheetConditionalFormattingMixin extends FWorksheet implements IFWorksheetConditionalFormattingMixin {
@@ -196,38 +212,53 @@ export class FWorksheetConditionalFormattingMixin extends FWorksheet implements
}
override addConditionalFormattingRule(rule: IConditionFormattingRule): FWorksheet {
- const params: IAddConditionalRuleMutationParams = {
- rule, unitId: this._workbook.getUnitId(), subUnitId: this._worksheet.getSheetId(),
+ const params: IAddCfCommandParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
+ rule,
};
- this._commandService.syncExecuteCommand(AddConditionalRuleMutation.id, params);
+ this._commandService.syncExecuteCommand(AddCfCommand.id, params);
return this;
}
override deleteConditionalFormattingRule(cfId: string): FWorksheet {
- const params: IDeleteConditionalRuleMutationParams = {
- unitId: this._workbook.getUnitId(), subUnitId: this._worksheet.getSheetId(),
+ const params: IDeleteCfCommandParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
cfId,
};
- this._commandService.syncExecuteCommand(DeleteConditionalRuleMutation.id, params);
+ this._commandService.syncExecuteCommand(DeleteCfCommand.id, params);
return this;
}
override moveConditionalFormattingRule(cfId: string, toCfId: string, type: IAnchor['type'] = 'after'): FWorksheet {
- const params: IMoveConditionalRuleMutationParams = {
- unitId: this._workbook.getUnitId(), subUnitId: this._worksheet.getSheetId(),
- start: { id: cfId, type: 'self' }, end: { id: toCfId, type },
+ const params: IMoveCfCommandParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
+ start: { id: cfId, type: 'self' },
+ end: { id: toCfId, type },
};
- this._commandService.syncExecuteCommand(MoveConditionalRuleMutation.id, params);
+ this._commandService.syncExecuteCommand(MoveCfCommand.id, params);
return this;
}
override setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): FWorksheet {
- const params: ISetConditionalRuleMutationParams = {
- unitId: this._workbook.getUnitId(), subUnitId: this._worksheet.getSheetId(),
- rule,
+ const params: ISetCfCommandParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
cfId,
+ rule,
+ };
+ this._commandService.syncExecuteCommand(SetCfCommand.id, params);
+ return this;
+ }
+
+ override clearConditionalFormatRules(): FWorksheet {
+ const params: IClearWorksheetCfParams = {
+ unitId: this._workbook.getUnitId(),
+ subUnitId: this._worksheet.getSheetId(),
};
- this._commandService.syncExecuteCommand(SetConditionalRuleMutation.id, params);
+ this._commandService.syncExecuteCommand(ClearWorksheetCfCommand.id, params);
return this;
}
}
diff --git a/packages/sheets-conditional-formatting/src/index.ts b/packages/sheets-conditional-formatting/src/index.ts
index 7b300afd82..2d62a922d5 100644
--- a/packages/sheets-conditional-formatting/src/index.ts
+++ b/packages/sheets-conditional-formatting/src/index.ts
@@ -34,6 +34,31 @@ export * from './utils/type';
// #region - all commands
+export {
+ AddCfCommand,
+ type IAddCfCommandParams,
+} from './commands/commands/add-cf.command';
+export {
+ ClearRangeCfCommand,
+ type IClearRangeCfParams,
+} from './commands/commands/clear-range-cf.command';
+export {
+ ClearWorksheetCfCommand,
+ type IClearWorksheetCfParams,
+} from './commands/commands/clear-worksheet-cf.command';
+export {
+ DeleteCfCommand,
+ type IDeleteCfCommandParams,
+} from './commands/commands/delete-cf.command';
+export {
+ type IMoveCfCommandParams,
+ MoveCfCommand,
+} from './commands/commands/move-cf.command';
+export {
+ type ISetCfCommandParams,
+ SetCfCommand,
+} from './commands/commands/set-cf.command';
+
export {
AddConditionalRuleMutation,
AddConditionalRuleMutationUndoFactory,
diff --git a/packages/sheets-conditional-formatting/src/plugin.ts b/packages/sheets-conditional-formatting/src/plugin.ts
index 27c3b792f6..b1afb04dac 100644
--- a/packages/sheets-conditional-formatting/src/plugin.ts
+++ b/packages/sheets-conditional-formatting/src/plugin.ts
@@ -18,6 +18,12 @@ import type { Dependency } from '@univerjs/core';
import type { IUniverSheetsConditionalFormattingConfig } from './controllers/config.schema';
import { ICommandService, IConfigService, Inject, Injector, merge, Plugin, touchDependencies, UniverInstanceType } from '@univerjs/core';
import { SHEET_CONDITIONAL_FORMATTING_PLUGIN } from './base/const';
+import { AddCfCommand } from './commands/commands/add-cf.command';
+import { ClearRangeCfCommand } from './commands/commands/clear-range-cf.command';
+import { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.command';
+import { DeleteCfCommand } from './commands/commands/delete-cf.command';
+import { MoveCfCommand } from './commands/commands/move-cf.command';
+import { SetCfCommand } from './commands/commands/set-cf.command';
import { AddConditionalRuleMutation } from './commands/mutations/add-conditional-rule.mutation';
import { DeleteConditionalRuleMutation } from './commands/mutations/delete-conditional-rule.mutation';
import { ConditionalFormattingFormulaMarkDirty } from './commands/mutations/formula-mark-dirty.mutation';
@@ -62,6 +68,12 @@ export class UniverSheetsConditionalFormattingPlugin extends Plugin {
});
[
+ AddCfCommand,
+ ClearRangeCfCommand,
+ ClearWorksheetCfCommand,
+ DeleteCfCommand,
+ MoveCfCommand,
+ SetCfCommand,
AddConditionalRuleMutation,
DeleteConditionalRuleMutation,
SetConditionalRuleMutation,
diff --git a/packages/sheets-ui/src/facade/f-worksheet.ts b/packages/sheets-ui/src/facade/f-worksheet.ts
index 3bc5c1b648..1e20cda230 100644
--- a/packages/sheets-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-ui/src/facade/f-worksheet.ts
@@ -18,9 +18,9 @@ import type { IDisposable, IRange, Nullable } from '@univerjs/core';
import type { IColumnsHeaderCfgParam, IRowsHeaderCfgParam, RenderComponentType, RenderManagerService, SpreadsheetColumnHeader, SpreadsheetRowHeader, SpreadsheetSkeleton } from '@univerjs/engine-render';
import type { IScrollState, IViewportScrollState } from '@univerjs/sheets-ui';
-import { BooleanNumber, ICommandService, toDisposable } from '@univerjs/core';
+import { ICommandService, toDisposable } from '@univerjs/core';
import { IRenderManagerService, SHEET_VIEWPORT_KEY, sheetContentViewportKeys } from '@univerjs/engine-render';
-import { SetWorksheetRowIsAutoHeightMutation } from '@univerjs/sheets';
+import { SetWorksheetRowIsAutoHeightCommand } from '@univerjs/sheets';
import { SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand, SetWorksheetColAutoWidthCommand, SetZoomRatioCommand, SHEET_VIEW_KEY, SheetScrollManagerService, SheetSkeletonManagerService, SheetsScrollRenderController } from '@univerjs/sheets-ui';
import { FWorksheet } from '@univerjs/sheets/facade';
@@ -437,11 +437,10 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
},
];
- this._commandService.syncExecuteCommand(SetWorksheetRowIsAutoHeightMutation.id, {
+ this._commandService.syncExecuteCommand(SetWorksheetRowIsAutoHeightCommand.id, {
unitId,
subUnitId,
ranges,
- autoHeightInfo: BooleanNumber.TRUE,
});
return this;
diff --git a/packages/ui/src/facade/f-univer.ts b/packages/ui/src/facade/f-univer.ts
index 8a9c1f20cc..342e62e88c 100644
--- a/packages/ui/src/facade/f-univer.ts
+++ b/packages/ui/src/facade/f-univer.ts
@@ -74,11 +74,62 @@ export interface IFUniverUIMixin {
/**
* Copy the current selected content of the currently focused unit into your system clipboard.
+ * @returns {Promise<boolean>} whether the copy operation is successful
+ * @example
+ * ```ts
+ * // Prevent failure due to loss of focus when executing copy and paste code in the console,
+ * // this example listens for the cell click event and executes the copy and paste code.
+ * univerAPI.addEvent(univerAPI.Event.CellClicked, async (params) => {
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getActiveSheet();
+ *
+ * // Copy the range A1:B2 to the clipboard
+ * const fRange = fWorksheet.getRange('A1:B2');
+ * fRange.activate().setValues([
+ * [1, 2],
+ * [3, 4]
+ * ]);
+ * await univerAPI.copy();
+ *
+ * // Paste the copied content to the range C1:D2
+ * const fRange2 = fWorksheet.getRange('C1');
+ * fRange2.activate();
+ * await univerAPI.paste();
+ *
+ * // Check the pasted content
+ * console.log(fWorksheet.getRange('C1:D2').getValues()); // [[1, 2], [3, 4]]
+ * });
+ * ```
*/
copy(): Promise<boolean>;
/**
* Paste into the current selected position of the currently focused unit from your system clipboard.
+ * @returns {Promise<boolean>} whether the paste operation is successful
+ * @example
+ * ```ts
+ * // Prevent failure due to loss of focus when executing copy and paste code in the console,
+ * // this example listens for the cell click event and executes the copy and paste code.
+ * univerAPI.addEvent(univerAPI.Event.CellClicked, async (params) => {
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getActiveSheet();
+ *
+ * // Copy the range A1:B2 to the clipboard
+ * const fRange = fWorksheet.getRange('A1:B2');
+ * fRange.activate().setValues([
+ * [1, 2],
+ * [3, 4]
+ * ]);
+ * await univerAPI.copy();
+ *
+ * // Paste the copied content to the range C1:D2
+ * const fRange2 = fWorksheet.getRange('C1');
+ * fRange2.activate();
+ * await univerAPI.paste();
+ *
+ * // Check the pasted content
+ * console.log(fWorksheet.getRange('C1:D2').getValues()); // [[1, 2], [3, 4]]
+ * });
* ```
*/
paste(): Promise<boolean>;
@@ -382,11 +433,11 @@ export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
}
override copy(): Promise<boolean> {
- return this._commandService.syncExecuteCommand(CopyCommand.id);
+ return this._commandService.executeCommand(CopyCommand.id);
}
override paste(): Promise<boolean> {
- return this._commandService.syncExecuteCommand(PasteCommand.id);
+ return this._commandService.executeCommand(PasteCommand.id);
}
override createMenu(menuItem: IFacadeMenuItem): FMenu {