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: add dark mode on Univer Rendering Engine (#5041)

Wenzhao Hu5afa3ef002e8
diff --git a/e2e/e2e.d.ts b/e2e/e2e.d.ts
index 835e066db7..33ab4e0395 100644
--- a/e2e/e2e.d.ts
+++ b/e2e/e2e.d.ts
@@ -1,5 +1,5 @@
// The type definition is copied from:
-// examples/src/plugins/debugger/controllers/e2e/e2e-memory.controller.ts
+// packages-experimental/debugger/src/controllers/e2e/e2e.controller.ts
export interface IE2EControllerAPI {
loadAndRelease(id: number, loadTimeout?: number, disposeTimeout?: number): Promise<void>;
loadDefaultSheet(loadTimeout?: number): Promise<void>;
@@ -7,6 +7,7 @@ export interface IE2EControllerAPI {
loadDemoSheet(loadTimeout?: number): Promise<void>;
loadMergeCellSheet(loadTimeout?: number): Promise<void>;
loadDefaultStyleSheet(loadTimeout?: number): Promise<void>;
+ setDarkMode(darkMode: boolean): void;
disposeUniver(): Promise<void>;
disposeCurrSheetUnit(disposeTimeout?: number): Promise<void>;
}
diff --git a/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts b/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts
index f95b99b507..4965cad368 100644
--- a/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts
+++ b/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts
@@ -38,9 +38,8 @@ test('sheets no gridlines', async () => {
const filename = generateSnapshotName('sheets-no-gridlines');
const screenshot = await page.screenshot({
mask: [
- page.locator('.univer-headerbar'),
- page.locator('.univer-workbench-container-header'),
- page.locator('.univer-formula-box'),
+ page.locator('[data-u-comp=headerbar]'),
+ page.locator('[data-u-comp=formula-bar]'),
],
fullPage: true,
});
diff --git a/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts-snapshots/sheets-no-gridlines-ci-chromium-linux.png b/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts-snapshots/sheets-no-gridlines-ci-chromium-linux.png
index 94f655b59d..30cceb1094 100644
Binary files a/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts-snapshots/sheets-no-gridlines-ci-chromium-linux.png and b/e2e/visual-comparison/sheets/sheets-gridlines.spec.ts-snapshots/sheets-no-gridlines-ci-chromium-linux.png differ
diff --git a/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts b/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts
index 2e1b8c8528..87305f9b09 100644
--- a/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts
+++ b/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts
@@ -41,8 +41,8 @@ test('ensure switching render unit successful with no errors', async () => {
const filename = generateSnapshotName('switching-render-unit');
const firstScreenshot = await page.screenshot({
mask: [
- page.locator('.univer-headerbar'),
- page.locator('.univer-defined-name'),
+ page.locator('[data-u-comp=headerbar]'),
+ page.locator('[data-u-comp=formula-bar]'),
],
fullPage: true,
});
diff --git a/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts-snapshots/switching-render-unit-ci-chromium-linux.png b/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts-snapshots/switching-render-unit-ci-chromium-linux.png
index ff0cabfa7c..15b33a296e 100644
Binary files a/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts-snapshots/switching-render-unit-ci-chromium-linux.png and b/e2e/visual-comparison/sheets/sheets-switching-render-unit.spec.ts-snapshots/switching-render-unit-ci-chromium-linux.png differ
diff --git a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts
index 4ae3d3d04e..55da8f257a 100644
--- a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts
+++ b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts
@@ -38,8 +38,37 @@ test('diff default sheet toolbar', async () => {
const filename = generateSnapshotName('default-sheet-fullpage');
const screenshot = await page.screenshot({
mask: [
- page.locator('.univer-headerbar'),
- page.locator('.univer-defined-name'),
+ page.locator('[data-u-comp=headerbar]'),
+ page.locator('[data-u-comp=defined-name]'),
+ ],
+ fullPage: true,
+ });
+ expect(screenshot).toMatchSnapshot(filename, { maxDiffPixels: 100 });
+});
+
+test('diff sheet dark mode', async () => {
+ const browser = await chromium.launch({
+ headless: isCI, // Set to false to see the browser window
+ });
+ const context = await browser.newContext({
+ viewport: { width: 1280, height: 720 },
+ deviceScaleFactor: 2, // Set your desired DPR
+ });
+ const page = await context.newPage();
+ await page.goto('http://localhost:3000/sheets/');
+ await page.waitForTimeout(2000);
+
+ await page.evaluate(() => window.E2EControllerAPI.loadDefaultSheet());
+ await page.waitForTimeout(1000);
+
+ await page.evaluate(() => window.E2EControllerAPI.setDarkMode(true));
+ await page.waitForTimeout(1000);
+
+ const filename = generateSnapshotName('dark-mode');
+ const screenshot = await page.screenshot({
+ mask: [
+ page.locator('[data-u-comp=headerbar]'),
+ page.locator('[data-u-comp=defined-name]'),
],
fullPage: true,
});
diff --git a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png
new file mode 100644
index 0000000000..96ee659d06
Binary files /dev/null and b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/dark-mode-ci-chromium-linux.png differ
diff --git a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/default-sheet-fullpage-ci-chromium-linux.png b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/default-sheet-fullpage-ci-chromium-linux.png
index 551acbefc3..a3751bded9 100644
Binary files a/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/default-sheet-fullpage-ci-chromium-linux.png and b/e2e/visual-comparison/sheets/sheets-visual-comparison.spec.ts-snapshots/default-sheet-fullpage-ci-chromium-linux.png differ
diff --git a/examples/src/docs/main.ts b/examples/src/docs/main.ts
index a0b655588e..f4b1521f41 100644
--- a/examples/src/docs/main.ts
+++ b/examples/src/docs/main.ts
@@ -52,7 +52,6 @@ const univer = new Univer({
// core plugins
univer.registerPlugin(UniverRenderEnginePlugin);
univer.registerPlugin(UniverFormulaEnginePlugin);
-univer.registerPlugin(UniverDebuggerPlugin);
univer.registerPlugin(UniverUIPlugin, {
container: 'app',
});
@@ -77,6 +76,8 @@ if (!IS_E2E) {
univer.createUnit(UniverInstanceType.UNIVER_DOC, DEFAULT_DOCUMENT_DATA_SIMPLE);
}
+univer.registerPlugin(UniverDebuggerPlugin);
+
// use for console test
declare global {
// eslint-disable-next-line ts/naming-convention
diff --git a/packages-experimental/debugger/src/commands/operations/theme.operation.ts b/packages-experimental/debugger/src/commands/operations/theme.operation.ts
index 9f6e756e8a..7b72976e8c 100644
--- a/packages-experimental/debugger/src/commands/operations/theme.operation.ts
+++ b/packages-experimental/debugger/src/commands/operations/theme.operation.ts
@@ -14,8 +14,8 @@
* limitations under the License.
*/
-import { CommandType, ThemeService } from '@univerjs/core';
import type { IAccessor, ICommand, IStyleSheet } from '@univerjs/core';
+import { CommandType, ThemeService } from '@univerjs/core';
export interface IThemeCommandParams {
value?: IStyleSheet;
diff --git a/packages-experimental/debugger/src/controllers/dark-mode.controller.ts b/packages-experimental/debugger/src/controllers/dark-mode.controller.ts
index 73068b7db3..4418050b6d 100644
--- a/packages-experimental/debugger/src/controllers/dark-mode.controller.ts
+++ b/packages-experimental/debugger/src/controllers/dark-mode.controller.ts
@@ -25,7 +25,19 @@ export class DarkModeController extends RxDisposable {
this._localStorageService.getItem('local.darkMode').then((darkMode) => {
if (darkMode === 'dark') {
+ document.documentElement.classList.add('univer-dark');
themeService.setDarkMode(true);
+ } else if (darkMode === 'system') {
+ const darkModeMediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
+ darkModeMediaQuery.addEventListener('change', (e) => {
+ if (e.matches) {
+ document.documentElement.classList.add('univer-dark');
+ themeService.setDarkMode(true);
+ } else {
+ document.documentElement.classList.remove('univer-dark');
+ themeService.setDarkMode(false);
+ }
+ });
}
});
}
diff --git a/packages-experimental/debugger/src/controllers/e2e/e2e.controller.ts b/packages-experimental/debugger/src/controllers/e2e/e2e.controller.ts
index d1a7fdd8a0..c908cfc5e4 100644
--- a/packages-experimental/debugger/src/controllers/e2e/e2e.controller.ts
+++ b/packages-experimental/debugger/src/controllers/e2e/e2e.controller.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { awaitTime, Disposable, ICommandService, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
+import { awaitTime, Disposable, ICommandService, Inject, IUniverInstanceService, ThemeService, UniverInstanceType } from '@univerjs/core';
import { DEFAULT_WORKBOOK_DATA_DEMO, DEFAULT_WORKBOOK_DATA_DEMO_DEFAULT_STYLE } from '@univerjs/mockdata';
import { DisposeUniverCommand } from '../../commands/commands/unit.command';
@@ -33,6 +33,7 @@ export interface IE2EControllerAPI {
loadMergeCellSheet(loadTimeout?: number): Promise<void>;
loadDefaultStyleSheet(loadTimeout?: number): Promise<void>;
loadDefaultDoc(loadTimeout?: number,): Promise<void>;
+ setDarkMode(darkMode: boolean): void;
disposeUniver(): Promise<void>;
disposeCurrSheetUnit(disposeTimeout?: number): Promise<void>;
}
@@ -50,7 +51,8 @@ declare global {
export class E2EController extends Disposable {
constructor(
@IUniverInstanceService private readonly _univerInstanceService: IUniverInstanceService,
- @ICommandService private readonly _commandService: ICommandService
+ @ICommandService private readonly _commandService: ICommandService,
+ @Inject(ThemeService) private readonly _themeService: ThemeService
) {
super();
@@ -70,11 +72,16 @@ export class E2EController extends Disposable {
loadMergeCellSheet: () => this._loadMergeCellSheet(2000),
loadDefaultStyleSheet: (loadTimeout) => this._loadDefaultStyleSheet(loadTimeout),
disposeCurrSheetUnit: (disposeTimeout?: number) => this._disposeDefaultSheetUnit(disposeTimeout),
+ setDarkMode: (darkMode) => this._setDarkMode(darkMode),
loadDefaultDoc: (loadTimeout) => this._loadDefaultDoc(loadTimeout),
disposeUniver: () => this._disposeUniver(),
};
}
+ private _setDarkMode(darkMode: boolean): void {
+ this._themeService.setDarkMode(darkMode);
+ }
+
private async _loadAndRelease(releaseId: number, loadingTimeout: number = AWAIT_LOADING_TIMEOUT, disposingTimeout: number = AWAIT_DISPOSING_TIMEOUT): Promise<void> {
const unitId = `e2e${releaseId}`;
const snapshot = getDefaultWorkbookData();
diff --git a/packages-experimental/debugger/src/plugin.ts b/packages-experimental/debugger/src/plugin.ts
index 5b569dda62..904ddfaff0 100644
--- a/packages-experimental/debugger/src/plugin.ts
+++ b/packages-experimental/debugger/src/plugin.ts
@@ -57,13 +57,16 @@ export class UniverDebuggerPlugin extends Plugin {
[E2EController],
[UniverWatermarkMenuController],
];
+
if (this._config.performanceMonitor?.enabled !== false) {
dependencies.push([PerformanceMonitorController]);
}
+
registerDependencies(this._injector, dependencies);
touchDependencies(this._injector, [
[E2EController],
+ [DarkModeController],
]);
}
@@ -76,7 +79,6 @@ export class UniverDebuggerPlugin extends Plugin {
override onRendered(): void {
touchDependencies(this._injector, [
- [DarkModeController],
[PerformanceMonitorController],
[UniverWatermarkMenuController],
]);
diff --git a/packages/core/src/facade/f-univer.ts b/packages/core/src/facade/f-univer.ts
index 7d0fa35894..fd5e523b8a 100644
--- a/packages/core/src/facade/f-univer.ts
+++ b/packages/core/src/facade/f-univer.ts
@@ -490,6 +490,7 @@ export class FUniver extends Disposable {
* ```ts
* const color = univerAPI.newColor();
* ```
+ * @deprecated
*/
newColor(): ColorBuilder {
return new ColorBuilder();
diff --git a/packages/core/src/services/theme/theme.service.ts b/packages/core/src/services/theme/theme.service.ts
index e939eb1964..d19482e134 100644
--- a/packages/core/src/services/theme/theme.service.ts
+++ b/packages/core/src/services/theme/theme.service.ts
@@ -25,9 +25,9 @@ export interface IStyleSheet {
}
export class ThemeService extends Disposable {
- private _darkMode: boolean;
private readonly _darkMode$ = new BehaviorSubject<boolean>(false);
readonly darkMode$: Observable<boolean> = this._darkMode$.asObservable();
+ get darkMode(): boolean { return this._darkMode$.getValue(); }
private _currentTheme: Nullable<IStyleSheet>;
private readonly _currentTheme$ = new BehaviorSubject<IStyleSheet>({});
@@ -56,7 +56,6 @@ export class ThemeService extends Disposable {
}
setDarkMode(darkMode: boolean): void {
- this._darkMode = darkMode;
this._darkMode$.next(darkMode);
}
}
diff --git a/packages/core/src/shared/color/color.ts b/packages/core/src/shared/color/color.ts
index 7b30c6cfe4..8319139b3e 100644
--- a/packages/core/src/shared/color/color.ts
+++ b/packages/core/src/shared/color/color.ts
@@ -14,10 +14,13 @@
* limitations under the License.
*/
+import type { Nullable } from '../types';
import { THEME_COLORS } from '../../types/const/theme-color-map';
import { ColorType, ThemeColors, ThemeColorType } from '../../types/enum';
-import type { Nullable } from '../types';
+/**
+ * @deprecated
+ */
export class ColorBuilder {
private _themeValue: ThemeColorType = ThemeColorType.LIGHT1;
@@ -84,6 +87,9 @@ export class ColorBuilder {
}
}
+/**
+ * @deprecated
+ */
export class Color {
protected _builder: ColorBuilder;
diff --git a/packages/core/src/types/enum/theme-color-type.ts b/packages/core/src/types/enum/theme-color-type.ts
index 97841a8483..9fe141376a 100644
--- a/packages/core/src/types/enum/theme-color-type.ts
+++ b/packages/core/src/types/enum/theme-color-type.ts
@@ -16,6 +16,8 @@
/**
* Theme color type enum
+ *
+ * @deprecated
*/
export enum ThemeColorType {
/**
@@ -44,6 +46,9 @@ export enum ThemeColorType {
// TODO: get color list to color picker
// TODO: 取色
+/**
+ * @deprecated
+ */
export enum ThemeColors {
OFFICE = 'Office',
OFFICE_2007_2010 = 'Office 2007-2010',
diff --git a/packages/design/src/components/button/Button.tsx b/packages/design/src/components/button/Button.tsx
index 437a8e8fbd..46a4039bc5 100644
--- a/packages/design/src/components/button/Button.tsx
+++ b/packages/design/src/components/button/Button.tsx
@@ -36,7 +36,7 @@ export const buttonVariants = cva(
univer-border-gray-200 univer-bg-white univer-text-gray-700
active:univer-bg-gray-200
dark:univer-border-gray-600 dark:univer-bg-gray-700 dark:univer-text-white
- dark:hover:univer-bg-gray-600 dark:active:univer-bg-gray-500
+ dark:hover:univer-bg-gray-600 dark:active:univer-bg-gray-700
hover:univer-bg-gray-100
`,
primary: `
diff --git a/packages/docs-ui/src/facade/__tests__/create-test-bed.ts b/packages/docs-ui/src/facade/__tests__/create-test-bed.ts
index b367b45758..60c3b28dcc 100644
--- a/packages/docs-ui/src/facade/__tests__/create-test-bed.ts
+++ b/packages/docs-ui/src/facade/__tests__/create-test-bed.ts
@@ -31,7 +31,7 @@ import { DocSelectionManagerService, DocSkeletonManagerService, DocStateEmitServ
import { DocIMEInputManagerService, DocsRenderService, DocStateChangeManagerService } from '@univerjs/docs-ui';
import enUS from '@univerjs/docs-ui/locale/en-US';
import zhCN from '@univerjs/docs-ui/locale/zh-CN';
-import { IRenderManagerService, RenderManagerService } from '@univerjs/engine-render';
+import { DumbCanvasColorService, ICanvasColorService, IRenderManagerService, RenderManagerService } from '@univerjs/engine-render';
function getTestDocumentDataDemo(): IDocumentData {
return {
@@ -80,6 +80,7 @@ export function createTestBed(documentConfig?: IDocumentData, dependencies?: Dep
injector.add([DocStateEmitService]);
injector.add([DocStateChangeManagerService]);
injector.add([DocsRenderService]);
+ injector.add([ICanvasColorService, { useClass: DumbCanvasColorService }]);
dependencies?.forEach((d) => injector.add(d));
diff --git a/packages/engine-render/src/canvas.ts b/packages/engine-render/src/canvas.ts
index 3264f7d577..f8fc202d66 100644
--- a/packages/engine-render/src/canvas.ts
+++ b/packages/engine-render/src/canvas.ts
@@ -15,6 +15,7 @@
*/
import type { Nullable } from '@univerjs/core';
+import type { ICanvasColorService } from './services/canvas-color.service';
import { getDevicePixelRatio } from './basics/draw';
import { createCanvasElement } from './basics/tools';
import { UniverPrintingContext, UniverRenderingContext } from './context';
@@ -36,11 +37,12 @@ export enum CanvasRenderMode {
}
interface ICanvasProps {
+ colorService?: ICanvasColorService;
+ id?: string;
width?: number;
height?: number;
pixelRatio?: number;
mode?: CanvasRenderMode;
- id?: string;
}
/**
@@ -62,8 +64,8 @@ export class Canvas {
private _width = 0;
private _height = 0;
- constructor(props?: ICanvasProps) {
- props = props || {};
+ constructor(_props?: ICanvasProps) {
+ const props = _props || {};
this._canvasEle = createCanvasElement();
// set inline styles
@@ -78,13 +80,12 @@ export class Canvas {
this._canvasEle.dataset.uComp = 'render-canvas';
- // support focus
+ // focusable
this._canvasEle.tabIndex = 1;
this._canvasEle.style.touchAction = 'none';
this._canvasEle.style.outline = '0';
const context = this._canvasEle.getContext('2d');
-
if (context == null) {
throw new Error('context is not support');
}
@@ -92,7 +93,9 @@ export class Canvas {
if (props.mode === CanvasRenderMode.Printing) {
this._context = new UniverPrintingContext(context);
} else {
- this._context = new UniverRenderingContext(context);
+ this._context = new UniverRenderingContext(context, {
+ canvasColorService: props.colorService,
+ });
}
this.setSize(props.width, props.height, props.pixelRatio);
diff --git a/packages/engine-render/src/context.ts b/packages/engine-render/src/context.ts
index e6bfcbe4f9..56ab7fbd8b 100644
--- a/packages/engine-render/src/context.ts
+++ b/packages/engine-render/src/context.ts
@@ -15,10 +15,15 @@
*/
import type { Nullable } from '@univerjs/core';
+import type { ICanvasColorService } from './services/canvas-color.service';
import type { IRenderConfig } from './services/render-config';
import { Tools } from '@univerjs/core';
import { fixLineWidthByScale, getColor } from './basics/tools';
+export interface IUniverRenderingContextOptions {
+ canvasColorService?: ICanvasColorService;
+}
+
export class UniverRenderingContext2D implements CanvasRenderingContext2D {
__mode = 'rendering';
@@ -31,9 +36,13 @@ export class UniverRenderingContext2D implements CanvasRenderingContext2D {
renderConfig: Readonly<IRenderConfig> = {};
- constructor(context: CanvasRenderingContext2D) {
+ private _canvasColorService?: ICanvasColorService;
+
+ constructor(context: CanvasRenderingContext2D, options?: IUniverRenderingContextOptions) {
this.canvas = context.canvas;
this._context = context;
+
+ this._canvasColorService = options?.canvasColorService;
}
private _id: string;
@@ -69,13 +78,14 @@ export class UniverRenderingContext2D implements CanvasRenderingContext2D {
this._context.globalCompositeOperation = val;
}
- // fillStyle: string | CanvasGradient | CanvasPattern;
get fillStyle() {
return this._context.fillStyle;
}
set fillStyle(val: string | CanvasGradient | CanvasPattern) {
- this._context.fillStyle = val;
+ this._context.fillStyle = this._canvasColorService && typeof val === 'string'
+ ? this._canvasColorService.getRenderColor(val)
+ : val;
}
// strokeStyle: string | CanvasGradient | CanvasPattern;
@@ -84,7 +94,9 @@ export class UniverRenderingContext2D implements CanvasRenderingContext2D {
}
set strokeStyle(val: string | CanvasGradient | CanvasPattern) {
- this._context.strokeStyle = val;
+ this._context.strokeStyle = this._canvasColorService && typeof val === 'string'
+ ? this._canvasColorService.getRenderColor(val)
+ : val;
}
// filter: string;
diff --git a/packages/engine-render/src/engine.ts b/packages/engine-render/src/engine.ts
index 3a6fc6f289..ca4da4f53b 100644
--- a/packages/engine-render/src/engine.ts
+++ b/packages/engine-render/src/engine.ts
@@ -30,6 +30,7 @@ import { PerformanceMonitor } from './basics/performance-monitor';
import { getPointerPrefix, getSizeForDom, IsSafari, requestNewFrame } from './basics/tools';
import { Canvas, CanvasRenderMode } from './canvas';
import { observeClientRect } from './floating/util';
+import { ICanvasColorService } from './services/canvas-color.service';
export interface IEngineOption {
elementWidth: number;
@@ -43,6 +44,7 @@ export class Engine extends Disposable {
private readonly _beginFrame$ = new Subject<number>();
readonly beginFrame$ = this._beginFrame$.asObservable();
+
private readonly _endFrame$ = new Subject<IBasicFrameInfo>();
readonly endFrame$ = this._endFrame$.asObservable();
@@ -52,9 +54,8 @@ export class Engine extends Disposable {
/**
* Pass event to scene.input-manager
*/
- onInputChanged$ = new EventSubject<IEvent>();
-
- onTransformChange$ = new EventSubject<ITransformChangeState>();
+ readonly onInputChanged$ = new EventSubject<IEvent>();
+ readonly onTransformChange$ = new EventSubject<ITransformChangeState>();
private _scenes: { [sceneKey: string]: Scene } = {};
@@ -83,18 +84,11 @@ export class Engine extends Disposable {
}
private _container: Nullable<HTMLElement>;
-
private _canvas: Nullable<Canvas>;
-
private _renderingQueueLaunched = false;
-
private _renderFrameTasks = new Array<() => void>();
-
private _requestNewFrameHandler: number = -1;
- /**
- * frameCount
- */
private _frameId: number = -1;
private _usingSafari: boolean = IsSafari();
@@ -103,37 +97,23 @@ export class Engine extends Disposable {
// FPS
private _fps = 60;
-
private _deltaTime = 0;
-
private _performanceMonitor: PerformanceMonitor;
private _pointerClickEvent!: (evt: Event) => void;
-
private _pointerDblClickEvent!: (evt: Event) => void;
-
private _pointerMoveEvent!: (evt: Event) => void;
-
private _pointerDownEvent!: (evt: Event) => void;
-
private _pointerUpEvent!: (evt: Event) => void;
-
private _pointerOutEvent!: (evt: Event) => void;
-
private _pointerCancelEvent!: (evt: Event) => void;
-
private _pointerBlurEvent!: (evt: Event) => void;
-
private _pointerWheelEvent!: (evt: Event) => void;
-
private _pointerEnterEvent!: (evt: Event) => void;
-
private _pointerLeaveEvent!: (evt: Event) => void;
private _dragEnterEvent!: (evt: Event) => void;
-
private _dragLeaveEvent!: (evt: Event) => void;
-
private _dragOverEvent!: (evt: Event) => void;
private _dropEvent!: (evt: Event) => void;
@@ -153,55 +133,6 @@ export class Engine extends Disposable {
private _unitId: string = ''; // unitId
- constructor();
- constructor(unitId: string, options?: IEngineOption);
- constructor(elemW: number, elemH: number, dpr?: number, renderMode?: CanvasRenderMode);
- constructor(...args: any[]) {
- super();
- let elemWidth = 1;
- let elemHeight = 1;
- let pixelRatio = 1;
- let renderMode = CanvasRenderMode.Rendering;
-
- if (args[0] && typeof args[0] === 'string') {
- this._unitId = args[0];
- const options = args[1] ?? {
- elemWidth: 1,
- elemHeight: 1,
- pixelRatio: 1,
- renderMode: CanvasRenderMode.Rendering,
- };
- elemWidth = options.elementWidth;
- elemHeight = options.elementHeight;
- pixelRatio = options.pixelRatio ?? 1;
- renderMode = options.renderMode ?? CanvasRenderMode.Rendering;
- } else {
- elemWidth = args[0] ?? 1;
- elemHeight = args[1] ?? 1;
- pixelRatio = args[2] ?? 1;
- renderMode = args[3] ?? CanvasRenderMode.Rendering;
- }
-
- this._canvas = new Canvas({
- mode: renderMode,
- width: elemWidth,
- height: elemHeight,
- pixelRatio,
- });
- this._init();
- this._handleKeyboardAction();
- this._handlePointerAction();
- this._handleDragAction();
-
- if (renderMode !== CanvasRenderMode.Printing) {
- this._matchMediaHandler();
- }
- }
-
- _init() {
- this._performanceMonitor = new PerformanceMonitor();
- }
-
get unitId(): string {
return this._unitId;
}
@@ -226,6 +157,41 @@ export class Engine extends Disposable {
return this._activeScene;
}
+ constructor(
+ unitId?: string,
+ _options?: IEngineOption,
+ @ICanvasColorService readonly canvasColorService?: ICanvasColorService
+ ) {
+ super();
+
+ this._unitId = unitId ?? '';
+
+ const options = Object.assign({}, {
+ elementHeight: 1,
+ elementWidth: 1,
+ renderMode: CanvasRenderMode.Rendering,
+ dpr: 1,
+ }, _options);
+
+ this._canvas = new Canvas({
+ mode: options.renderMode,
+ width: options.elementWidth,
+ height: options.elementHeight,
+ pixelRatio: options.dpr,
+ colorService: this.canvasColorService,
+ });
+
+ this._performanceMonitor = new PerformanceMonitor();
+
+ this._handleKeyboardAction();
+ this._handlePointerAction();
+ this._handleDragAction();
+
+ if (options.renderMode !== CanvasRenderMode.Printing) {
+ this._matchMediaHandler();
+ }
+ }
+
getScenes() {
return this._scenes;
}
diff --git a/packages/engine-render/src/index.ts b/packages/engine-render/src/index.ts
index d77415099e..4156b9bb2d 100644
--- a/packages/engine-render/src/index.ts
+++ b/packages/engine-render/src/index.ts
@@ -19,7 +19,6 @@ export * from './basics';
export { getOffsetRectForDom } from './basics/position';
export * from './canvas';
export * from './components';
-export { UniverRenderConfigService } from './services/render-config.service';
export { DocBackground } from './components/docs/doc-background';
export { Documents } from './components/docs/document';
export type { IPageRenderConfig } from './components/docs/document';
@@ -41,7 +40,14 @@ export * from './engine';
export * from './group';
export * from './layer';
export { IRenderingEngine, UniverRenderEnginePlugin } from './plugin';
-export { getCurrentTypeOfRenderer, IRenderManagerService, type RenderComponentType, RenderManagerService, withCurrentTypeOfRenderer } from './render-manager/render-manager.service';
+export {
+ getCurrentTypeOfRenderer,
+ IRenderManagerService,
+ type RenderComponentType,
+ RenderManagerService,
+ withCurrentTypeOfRenderer,
+} from './render-manager/render-manager.service';
+export { CanvasColorService, DumbCanvasColorService, ICanvasColorService } from './services/canvas-color.service';
export { type IRender, type IRenderContext, type IRenderModule, RenderUnit } from './render-manager/render-unit';
export * from './scene';
export { type IChangeObserverConfig } from './scene.transformer';
diff --git a/packages/engine-render/src/layer.ts b/packages/engine-render/src/layer.ts
index af2f820097..31051905dc 100644
--- a/packages/engine-render/src/layer.ts
+++ b/packages/engine-render/src/layer.ts
@@ -257,14 +257,14 @@ export class Layer extends Disposable {
}
private _initialCacheCanvas() {
- this._cacheCanvas = new Canvas();
-
const engine = this.scene.getEngine();
if (engine) {
this.disposeWithMe(engine.onTransformChange$.subscribeEvent(() => {
this._resizeCacheCanvas();
}));
}
+
+ this._cacheCanvas = new Canvas({ colorService: engine?.canvasColorService });
}
private _draw(mainCtx: UniverRenderingContext, isMaxLayer: boolean) {
diff --git a/packages/engine-render/src/plugin.ts b/packages/engine-render/src/plugin.ts
index e8b662d805..6545d21fbd 100644
--- a/packages/engine-render/src/plugin.ts
+++ b/packages/engine-render/src/plugin.ts
@@ -20,9 +20,13 @@ import { createIdentifier, IConfigService, Inject, Injector, merge, Plugin, regi
import { defaultPluginConfig, ENGINE_RENDER_PLUGIN_CONFIG_KEY } from './controllers/config.schema';
import { Engine } from './engine';
import { IRenderManagerService, RenderManagerService } from './render-manager/render-manager.service';
+import { CanvasColorService, ICanvasColorService } from './services/canvas-color.service';
+import { UniverRenderConfigService } from './services/render-config.service';
/**
* The global rendering engine.
+ *
+ * @deprecated There will be no more default global render engine in the future.
*/
export const IRenderingEngine = createIdentifier<Engine>('univer.render-engine');
@@ -45,9 +49,13 @@ export class UniverRenderEnginePlugin extends Plugin {
this._config
);
this._configService.setConfig(ENGINE_RENDER_PLUGIN_CONFIG_KEY, rest);
+ }
+ override onStarting(): void {
registerDependencies(this._injector, [
- [IRenderingEngine, { useFactory: () => new Engine() }],
+ [UniverRenderConfigService],
+ [ICanvasColorService, { useClass: CanvasColorService }],
+ [IRenderingEngine, { useClass: Engine }],
[IRenderManagerService, { useClass: RenderManagerService }],
]);
}
diff --git a/packages/engine-render/src/render-manager/render-manager.service.ts b/packages/engine-render/src/render-manager/render-manager.service.ts
index 1ac7ce30f9..1a3ba791d9 100644
--- a/packages/engine-render/src/render-manager/render-manager.service.ts
+++ b/packages/engine-render/src/render-manager/render-manager.service.ts
@@ -106,8 +106,8 @@ export class RenderManagerService extends Disposable implements IRenderManagerSe
private readonly _renderDependencies = new Map<UnitType, Dependency[]>();
constructor(
- @Inject(Injector) private readonly _injector: Injector,
- @IUniverInstanceService private readonly _univerInstanceService: IUniverInstanceService
+ @Inject(Injector) protected readonly _injector: Injector,
+ @IUniverInstanceService protected readonly _univerInstanceService: IUniverInstanceService
) {
super();
}
@@ -184,7 +184,7 @@ export class RenderManagerService extends Disposable implements IRenderManagerSe
* @returns renderUnit:IRender
*/
createRender(unitId: string): IRender {
- const renderer = this._createRender(unitId, new Engine(unitId));
+ const renderer = this._createRender(unitId, this._injector.createInstance(Engine, unitId, undefined));
this._renderCreated$.next(renderer);
return renderer;
}
diff --git a/packages/engine-render/src/scene.ts b/packages/engine-render/src/scene.ts
index 7a49ab51c7..e57b1a6755 100644
--- a/packages/engine-render/src/scene.ts
+++ b/packages/engine-render/src/scene.ts
@@ -45,6 +45,7 @@ export interface ISceneInputControlOptions {
enableEnter: boolean;
enableLeave: boolean;
}
+
export class Scene extends Disposable {
private _sceneKey: string = '';
/**
@@ -485,7 +486,10 @@ export class Scene extends Disposable {
return layer;
}
}
- return this._createDefaultLayer(zIndex);
+
+ const defaultLayer = new Layer(this, [], zIndex);
+ this.addLayer(defaultLayer);
+ return defaultLayer;
}
findLayerByZIndex(zIndex: number = 1): Nullable<Layer> {
@@ -1233,12 +1237,6 @@ export class Scene extends Disposable {
return true;
}
- private _createDefaultLayer(zIndex: number = 1) {
- const defaultLayer = new Layer(this, [], zIndex);
- this.addLayer(defaultLayer);
- return defaultLayer;
- }
-
/**
* Triggered when scale, resize of scene.
* origin name: _setTransForm
diff --git a/packages/engine-render/src/services/canvas-color.service.ts b/packages/engine-render/src/services/canvas-color.service.ts
new file mode 100644
index 0000000000..a9d90cafd1
--- /dev/null
+++ b/packages/engine-render/src/services/canvas-color.service.ts
@@ -0,0 +1,128 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+
+import type { RGBColor } from './utils';
+import { createIdentifier, Disposable, Inject, ThemeService } from '@univerjs/core';
+// import { invertColorByHSL } from './invert-hsl';
+import { invertColorByMatrix } from './invert-rgb';
+
+export const ICanvasColorService = createIdentifier<ICanvasColorService>('univer.engine-render.canvas-color.service');
+/**
+ * This service maps a color or a theme-token to a color for rendering. Univer supports themes for rendering
+ * and dark mode. This services is responsible for abstract this complexity for rendering components.
+ */
+export interface ICanvasColorService {
+ getRenderColor(color: string): string;
+}
+
+export class DumbCanvasColorService implements ICanvasColorService {
+ getRenderColor(color: string): string {
+ return color;
+ }
+}
+
+/**
+ * This service inverts a color for dark mode. This service is exposed
+ */
+export class CanvasColorService extends Disposable implements ICanvasColorService {
+ private readonly _cache = new Map<string, string>();
+ private _invertAlgo = invertColorByMatrix;
+
+ constructor(
+ @Inject(ThemeService) private readonly _themeService: ThemeService
+ ) {
+ super();
+ }
+
+ getRenderColor(color: string): string {
+ if (!this._themeService.darkMode) {
+ return color;
+ }
+
+ // TODO: if the color is background color from _themeService: do not invert it.
+ // Or maybe there should be a whitelist.
+
+ if (this._cache.has(color)) {
+ return this._cache.get(color)!;
+ }
+
+ let cachedColor = '';
+ if (color.startsWith('#')) {
+ const invertedColor = this._invertAlgo(hexToRgb(color));
+ cachedColor = rgbToHex(invertedColor);
+
+ // append alpha channel if the original has alpha channel
+ if (color.length === 4) {
+ const alpha = color.charAt(3);
+ cachedColor += alpha + alpha;
+ }
+
+ // For 8-digit hex (e.g., #RRGGBB[AA]), the alpha is the last two characters
+ else if (color.length === 9) {
+ const alpha = color.substring(7, 9);
+ cachedColor += alpha;
+ }
+ } else if (color.startsWith('rgba')) {
+ const stripped = color.slice(5, -1).split(',');
+ const invertedColor = this._invertAlgo(stripped.slice(0, 3).map(Number) as RGBColor);
+ cachedColor = `rgba(${invertedColor[0]},${invertedColor[1]},${invertedColor[2]},${stripped[3]})`;
+ } else if (color.startsWith('rgb')) {
+ const stripped = color.slice(4, -1).split(',');
+ const invertedColor = this._invertAlgo(stripped.map(Number) as RGBColor);
+ cachedColor = `rgb(${invertedColor[0]},${invertedColor[1]},${invertedColor[2]})`;
+ } else {
+ throw new Error(`[CanvasColorService]: illegal color ${color}`);
+ }
+
+ this._cache.set(color, cachedColor);
+ return cachedColor;
+ }
+}
+
+export function hexToRgb(_hex: string): RGBColor {
+ const hex = _hex.replace(/^#/, '');
+
+ let r;
+ let g;
+ let b;
+ if (hex.length === 3 || hex.length === 4) {
+ r = Number.parseInt(hex.charAt(0) + hex.charAt(0), 16);
+ g = Number.parseInt(hex.charAt(1) + hex.charAt(1), 16);
+ b = Number.parseInt(hex.charAt(2) + hex.charAt(2), 16);
+ } else {
+ r = Number.parseInt(hex.substring(0, 2), 16);
+ g = Number.parseInt(hex.substring(2, 4), 16);
+ b = Number.parseInt(hex.substring(4, 6), 16);
+ }
+
+ // Return normalized RGBA values as an array
+ return [r, g, b] as RGBColor;
+}
+
+export function rgbToHex(rgbColor: RGBColor): string {
+ const r = Math.round(rgbColor[0]);
+ const g = Math.round(rgbColor[1]);
+ const b = Math.round(rgbColor[2]);
+
+ // Convert each component to a 2-digit hex string
+ const rHex = r.toString(16).padStart(2, '0');
+ const gHex = g.toString(16).padStart(2, '0');
+ const bHex = b.toString(16).padStart(2, '0');
+
+ // Combine the components
+ const hex = `#${rHex}${gHex}${bHex}`;
+ return hex;
+}
diff --git a/packages/engine-render/src/services/invert-hsl.ts b/packages/engine-render/src/services/invert-hsl.ts
new file mode 100644
index 0000000000..a5f06eb199
--- /dev/null
+++ b/packages/engine-render/src/services/invert-hsl.ts
@@ -0,0 +1,127 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+
+import type { RGBColor } from './utils';
+import { denormalizeRGBColor, normalizeRGBColor } from './utils';
+
+function rgbToHsl([r, g, b]: RGBColor): RGBColor {
+ const max = Math.max(r, g, b);
+ const min = Math.min(r, g, b);
+ const l = (max + min) / 2;
+
+ let h = 0;
+ let s = 0;
+
+ if (max !== min) {
+ const d = max - min;
+ s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
+ switch (max) {
+ case r:
+ h = (g - b) / d + (g < b ? 6 : 0);
+ break;
+ case g:
+ h = (b - r) / d + 2;
+ break;
+ case b:
+ h = (r - g) / d + 4;
+ break;
+ }
+ h /= 6;
+ }
+
+ return [h, s, l];
+}
+
+function getLuminance(r: number, g: number, b: number) {
+ const a = [r, g, b].map((v) => {
+ return v <= 0.03928 ? v / 12.92 : ((v + 0.055) / 1.055) ** 2.4;
+ });
+
+ return 0.2126 * a[0] + 0.7152 * a[1] + 0.0722 * a[2];
+}
+
+function getContrastRatio(luminance1: number, luminance2: number) {
+ return (
+ (Math.max(luminance1, luminance2) + 0.05) /
+ (Math.min(luminance1, luminance2) + 0.05)
+ );
+}
+
+function hslToRgb(h: number, s: number, l: number): RGBColor {
+ let r, g, b;
+
+ if (s === 0) {
+ r = g = b = l; // achromatic
+ } else {
+ const hue2rgb = (p: number, q: number, _t: number) => {
+ let t = _t;
+ if (t < 0) t += 1;
+ if (t > 1) t -= 1;
+ if (t < 1 / 6) return p + (q - p) * 6 * t;
+ if (t < 1 / 2) return q;
+ if (t < 2 / 3) return p + (q - p) * (2 / 3 - t) * 6;
+ return p;
+ };
+
+ const q = l < 0.5 ? l * (1 + s) : l + s - l * s;
+ const p = 2 * l - q;
+
+ r = hue2rgb(p, q, h + 1 / 3);
+ g = hue2rgb(p, q, h);
+ b = hue2rgb(p, q, h - 1 / 3);
+ }
+
+ return [r, g, b];
+}
+
+export function stringToRgb(color: string): RGBColor {
+ return color.split(',').slice(0, 3).map(Number) as RGBColor;
+}
+
+const white = { r: 1, g: 1, b: 1 };
+const black = { r: 0, g: 0, b: 0 };
+
+const whiteLuminance = getLuminance(white.r, white.g, white.b);
+const blackLuminance = getLuminance(black.r, black.g, black.b);
+
+/**
+ * Invert a color by HSL tunning method.
+ * @param color The color to invert. Note that this color is already normalized.
+ * @returns The inverted color.
+ */
+function invertNormalizedColorByHSL(color: RGBColor): RGBColor {
+ const originalLuminance = getLuminance(color[0], color[1], color[2]);
+ const originalContrast = getContrastRatio(
+ whiteLuminance,
+ originalLuminance
+ );
+
+ const hsl = rgbToHsl(color);
+ let l = 1 - hsl[2]; // Invert the lightness
+ let newColor, newLuminance, newContrast;
+ do {
+ newColor = hslToRgb(hsl[0], hsl[1], l);
+ newLuminance = getLuminance(newColor[0], newColor[1], newColor[2]);
+ newContrast = getContrastRatio(newLuminance, blackLuminance);
+ l += 0.01;
+ } while (l <= 1 && l >= 0 && Math.abs(newContrast - originalContrast) < 0.01);
+
+ return newColor;
+}
+
+export function invertColorByHSL(color: RGBColor): RGBColor {
+ return denormalizeRGBColor(invertNormalizedColorByHSL(normalizeRGBColor(color)));
+}
diff --git a/packages/engine-render/src/services/invert-rgb.ts b/packages/engine-render/src/services/invert-rgb.ts
new file mode 100644
index 0000000000..613bc3d8ea
--- /dev/null
+++ b/packages/engine-render/src/services/invert-rgb.ts
@@ -0,0 +1,51 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+
+import type { RGBColor } from './utils';
+import { denormalizeRGBColor, normalizeRGBColor } from './utils';
+
+function invertNormalizedColorByMatrix(color: RGBColor): RGBColor {
+ const matrix = [
+ [0.333, -0.667, -0.667, 0, 1],
+ [-0.667, 0.333, -0.667, 0, 1],
+ [-0.667, -0.667, 0.333, 0, 1],
+ [0, 0, 0, 1, 0],
+ ];
+
+ const r = color[0];
+ const g = color[1];
+ const b = color[2];
+
+ let newColor = [
+ matrix[0][0] * r + matrix[0][1] * g + matrix[0][2] * b + matrix[0][4],
+ matrix[1][0] * r + matrix[1][1] * g + matrix[1][2] * b + matrix[1][4],
+ matrix[2][0] * r + matrix[2][1] * g + matrix[2][2] * b + matrix[2][4],
+ ];
+
+ // Clamp values between 0 and 1, or we can normalize it.
+ // It is better to normalize before rendering.
+ newColor = newColor.map((c) => (c > 1 ? 1 : c < 0 ? 0 : c));
+ return newColor as RGBColor;
+}
+
+/**
+ * Invert a color by RGB matrix method.
+ * @param color The color to invert. Note that this color is already normalized.
+ * @returns The inverted color.
+ */
+export function invertColorByMatrix(color: RGBColor): RGBColor {
+ return denormalizeRGBColor(invertNormalizedColorByMatrix(normalizeRGBColor(color)));
+}
diff --git a/packages/engine-render/src/services/render-config.service.ts b/packages/engine-render/src/services/render-config.service.ts
index 5bacf7ae7c..5a403eb7fa 100644
--- a/packages/engine-render/src/services/render-config.service.ts
+++ b/packages/engine-render/src/services/render-config.service.ts
@@ -22,6 +22,8 @@ import { debounceTime, Subject } from 'rxjs';
/**
* This service carries managers render config that would be passed
* to every widget, so some rendering could be optimized.
+ *
+ * @deprecated Will be replaced by ICanvasColorService.
*/
export class UniverRenderConfigService {
private readonly _renderConfig: IRenderConfig = {
diff --git a/packages/engine-render/src/services/utils.ts b/packages/engine-render/src/services/utils.ts
new file mode 100644
index 0000000000..eacf8d2af0
--- /dev/null
+++ b/packages/engine-render/src/services/utils.ts
@@ -0,0 +1,26 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 type RGBColor = [number, number, number];
+export type HSLColor = RGBColor;
+
+export function normalizeRGBColor(color: RGBColor): RGBColor {
+ return color.map((c) => c / 255) as RGBColor;
+}
+
+export function denormalizeRGBColor(color: RGBColor): RGBColor {
+ return color.map((c) => Math.round(c * 255)) as RGBColor;
+}
diff --git a/packages/engine-render/src/viewport.ts b/packages/engine-render/src/viewport.ts
index eeed4f3657..ca86f853dd 100644
--- a/packages/engine-render/src/viewport.ts
+++ b/packages/engine-render/src/viewport.ts
@@ -239,7 +239,7 @@ export class Viewport {
this._active = Tools.isDefine(props?.active) ? props?.active : true;
this.setViewportSize(props);
- this.initCacheCanvas(props);
+ this.initCacheCanvas(props, scene);
this._isWheelPreventDefaultX = props?.isWheelPreventDefaultX || false;
this._isWheelPreventDefaultY = props?.isWheelPreventDefaultY || false;
@@ -253,10 +253,10 @@ export class Viewport {
this.markForceDirty(true);
}
- initCacheCanvas(props?: IViewProps) {
+ initCacheCanvas(props: IViewProps | undefined, scene: Scene) {
this._allowCache = props?.allowCache || false;
if (this._allowCache) {
- this._cacheCanvas = new UniverCanvas();
+ this._cacheCanvas = new UniverCanvas({ colorService: scene.getEngine()?.canvasColorService });
this.bufferEdgeX = props?.bufferEdgeX || 0;
this.bufferEdgeY = props?.bufferEdgeY || 0;
}
@@ -823,16 +823,6 @@ export class Viewport {
const sceneTrans = this._scene.transform.clone();
- // const m = sceneTrans.getMatrix();
-
- // const scaleFromX = this._isRelativeX ? (m[0] < 1 ? m[0] : 1) : 1;
-
- // const scaleFromY = this._isRelativeY ? (m[3] < 1 ? m[3] : 1) : 1;
-
- // const scaleToX = this._isRelativeX ? 1 : m[0] < 1 ? m[0] : 1;
-
- // const scaleToY = this._isRelativeY ? 1 : m[3] < 1 ? m[3] : 1;
-
let width = this._width;
let height = this._height;
const size = this._calcViewPortSize();
diff --git a/packages/find-replace/src/views/dialog/FindReplaceDialog.tsx b/packages/find-replace/src/views/dialog/FindReplaceDialog.tsx
index 279fd667e8..070c4fc3a1 100644
--- a/packages/find-replace/src/views/dialog/FindReplaceDialog.tsx
+++ b/packages/find-replace/src/views/dialog/FindReplaceDialog.tsx
@@ -38,7 +38,7 @@ function useFindInputFocus(findReplaceService: IFindReplaceService, ref: Forward
}, []);
const selectHasFocus = useCallback(() => {
- const allInputs = document.querySelectorAll('[data-u-comp="find-replace-dialog"] [data-u-comp="search-input"]');
+ const allInputs = document.querySelectorAll('[data-u-comp=find-replace-dialog] [data-u-comp=search-input]');
return Array.from(allInputs).some((input) => input === document.activeElement);
}, []);
diff --git a/packages/sheets-conditional-formatting/src/facade/__tests__/create-test-bed.ts b/packages/sheets-conditional-formatting/src/facade/__tests__/create-test-bed.ts
index d47735314d..5e2ec9a680 100644
--- a/packages/sheets-conditional-formatting/src/facade/__tests__/create-test-bed.ts
+++ b/packages/sheets-conditional-formatting/src/facade/__tests__/create-test-bed.ts
@@ -110,7 +110,7 @@ export interface ITestBed {
class RenderManagerServiceTestBed extends RenderManagerService {
override createRender(unitId: string): IRender {
- const renderer = this._createRender(unitId, new Engine(100, 100));
+ const renderer = this._createRender(unitId, new Engine('', { elementHeight: 100, elementWidth: 100 }));
return renderer;
}
}
diff --git a/packages/sheets-sort-ui/src/views/CustomSortPanel.tsx b/packages/sheets-sort-ui/src/views/CustomSortPanel.tsx
index f6f9561ea2..842af4465e 100644
--- a/packages/sheets-sort-ui/src/views/CustomSortPanel.tsx
+++ b/packages/sheets-sort-ui/src/views/CustomSortPanel.tsx
@@ -156,7 +156,7 @@ function CustomSortPanelImpl({ state }: { state: ICustomSortState }) {
list={dragList}
onListChange={setList}
idKey="id"
- draggableHandle='[data-u-comp="sort-panel-item-handler"]'
+ draggableHandle="[data-u-comp=sort-panel-item-handler]"
itemRender={(item) => (
<SortOptionItem
titles={titles}
diff --git a/packages/sheets-ui/src/services/sheets-render.service.ts b/packages/sheets-ui/src/services/sheets-render.service.ts
index f487708c37..e99083769d 100644
--- a/packages/sheets-ui/src/services/sheets-render.service.ts
+++ b/packages/sheets-ui/src/services/sheets-render.service.ts
@@ -17,8 +17,10 @@
import type { IDisposable, Workbook } from '@univerjs/core';
import {
IContextService,
+ Inject,
IUniverInstanceService,
RxDisposable,
+ ThemeService,
toDisposable,
UniverInstanceType,
} from '@univerjs/core';
@@ -36,7 +38,8 @@ export class SheetsRenderService extends RxDisposable {
constructor(
@IContextService private readonly _contextService: IContextService,
@IUniverInstanceService private readonly _instanceSrv: IUniverInstanceService,
- @IRenderManagerService private readonly _renderManagerService: IRenderManagerService
+ @IRenderManagerService private readonly _renderManagerService: IRenderManagerService,
+ @Inject(ThemeService) private readonly _themeService: ThemeService
) {
super();
@@ -69,6 +72,18 @@ export class SheetsRenderService extends RxDisposable {
private _init() {
this._initWorkbookListener();
this._initContextListener();
+ this._initDarkModeListener();
+ }
+
+ private _initDarkModeListener(): void {
+ this.disposeWithMe(this._themeService.darkMode$.subscribe(() => {
+ this._renderManagerService.getRenderAll().forEach((renderer) => {
+ renderer.components.forEach((component) => {
+ component.makeForceDirty(true);
+ component.makeDirty(true);
+ });
+ });
+ }));
}
private _initWorkbookListener(): void {
diff --git a/packages/sheets-ui/src/views/defined-name/DefinedName.tsx b/packages/sheets-ui/src/views/defined-name/DefinedName.tsx
index 6dcfa6645b..04aae81988 100644
--- a/packages/sheets-ui/src/views/defined-name/DefinedName.tsx
+++ b/packages/sheets-ui/src/views/defined-name/DefinedName.tsx
@@ -43,6 +43,7 @@ export function DefinedName({ disable }: { disable: boolean }) {
return (
<div
+ data-u-comp="defined-name"
className={`
univer-relative univer-box-border univer-flex univer-h-full univer-w-24 univer-border-r-gray-200
univer-py-1.5 univer-transition-all
@@ -51,7 +52,8 @@ export function DefinedName({ disable }: { disable: boolean }) {
<input
className={clsx(`
univer-box-border univer-h-full univer-w-full univer-appearance-none univer-border-0 univer-border-r
- univer-border-r-gray-200 univer-px-1.5
+ univer-border-solid univer-border-r-gray-200 univer-px-1.5 univer-text-black
+ dark:univer-border-r-gray-700 dark:univer-bg-gray-900 dark:univer-text-white
focus:univer-outline-none
`, {
[styles.defineNameInputDisable]: disable,
@@ -73,9 +75,10 @@ export function DefinedName({ disable }: { disable: boolean }) {
className={clsx(`
univer-absolute univer-right-0 univer-top-0 univer-flex univer-h-full univer-cursor-pointer
univer-items-center univer-justify-center univer-px-1 univer-transition-colors univer-duration-200
+ dark:univer-text-white dark:hover:univer-bg-gray-800
hover:univer-bg-gray-100
`, {
- 'univer-cursor-not-allowed univer-text-gray-300 hover:univer-bg-transparent': disable,
+ 'univer-cursor-not-allowed univer-text-gray-300 dark:univer-text-gray-700 hover:univer-bg-transparent': disable,
})}
>
<MoreDownSingle />
diff --git a/packages/sheets-ui/src/views/defined-name/DefinedNameOverlay.tsx b/packages/sheets-ui/src/views/defined-name/DefinedNameOverlay.tsx
index 36e45c8649..245b382eda 100644
--- a/packages/sheets-ui/src/views/defined-name/DefinedNameOverlay.tsx
+++ b/packages/sheets-ui/src/views/defined-name/DefinedNameOverlay.tsx
@@ -150,7 +150,12 @@ export function DefinedNameOverlay(props: IDefinedNameOverlayProps) {
`}
onClick={openSlider}
>
- <div className="univer-mb-2 univer-text-sm univer-font-semibold univer-text-gray-600">
+ <div
+ className={`
+ univer-mb-2 univer-text-sm univer-font-semibold univer-text-gray-600
+ dark:univer-text-gray-200
+ `}
+ >
{localeService.t('definedName.managerTitle')}
</div>
<div className="univer-text-xs univer-text-gray-400">
diff --git a/packages/sheets-ui/src/views/formula-bar/FormulaBar.tsx b/packages/sheets-ui/src/views/formula-bar/FormulaBar.tsx
index 82d6a8c939..2a2a476fb9 100644
--- a/packages/sheets-ui/src/views/formula-bar/FormulaBar.tsx
+++ b/packages/sheets-ui/src/views/formula-bar/FormulaBar.tsx
@@ -32,7 +32,6 @@ import { IEditorBridgeService } from '../../services/editor-bridge.service';
import { IFormulaEditorManagerService } from '../../services/editor/formula-editor-manager.service';
import { DefinedName } from '../defined-name/DefinedName';
import { useKeyEventConfig } from '../editor-container/hooks';
-import styles from './index.module.less';
enum ArrowDirection {
Down,
@@ -46,7 +45,7 @@ interface IProps {
export function FormulaBar(props: IProps) {
const { className, disableDefinedName } = props;
- const [iconStyle, setIconStyle] = useState<string>(styles.formulaGrey);
+ const [iconActivated, setIconActivated] = useState<boolean>(false);
const [arrowDirection, setArrowDirection] = useState<ArrowDirection>(ArrowDirection.Down);
const formulaEditorManagerService = useDependency(IFormulaEditorManagerService);
const editorBridgeService = useDependency(IEditorBridgeService);
@@ -138,7 +137,7 @@ export function FormulaBar(props: IProps) {
useEffect(() => {
const subscription = editorBridgeService.visible$.subscribe((visibleInfo) => {
- setIconStyle(visibleInfo.visible ? styles.formulaActive : styles.formulaGrey);
+ setIconActivated(visibleInfo.visible);
});
return () => subscription.unsubscribe();
@@ -254,42 +253,74 @@ export function FormulaBar(props: IProps) {
return (
<div
- className={clsx(styles.formulaBox, className)}
+ data-u-comp="formula-bar"
+ className={clsx(`
+ univer-box-border univer-flex univer-h-7 univer-border-0 univer-border-b univer-border-solid
+ univer-bg-white univer-border-bg-gray-200 univer-border-b-gray-200 univer-transition-[height]
+ univer-ease-linear
+ dark:univer-border-b-gray-700 dark:univer-bg-gray-900
+ `, className)}
style={{
height: ArrowDirection.Down === arrowDirection ? '28px' : '82px',
pointerEvents: editDisable ? 'none' : 'auto',
}}
>
- <div className={styles.nameRanges}>
+ <div className="univer-relative univer-box-border univer-h-full univer-w-[100px]">
<DefinedName disable={disableDefinedName ?? editDisable} />
</div>
- <div className={styles.formulaBar}>
- <div className={clsx(styles.formulaIcon, { [styles.formulaIconDisable]: disabled })}>
- <div className={styles.formulaIconWrapper}>
+ <div className="univer-flex univer-h-full univer-w-full">
+ <div className={clsx('univer-py-1.5', { 'univer-cursor-not-allowed univer-text-gray-200': disabled })}>
+ <div
+ className={`
+ univer-relative univer-box-border univer-flex univer-h-full univer-w-20 univer-items-center
+ univer-justify-center univer-border-0 univer-border-r univer-border-solid
+ univer-border-r-gray-200 univer-text-xs
+ dark:univer-border-r-gray-700
+ `}
+ >
+ {/* TODO: use buttons to replace these re-implementation of buttons. */}
<span
- className={clsx(styles.iconContainer, styles.iconContainerError, iconStyle)}
+ className={clsx(`
+ univer-flex univer-items-center univer-justify-center univer-rounded univer-p-1
+ univer-text-base
+ dark:univer-text-white
+ `, {
+ 'univer-cursor-pointer univer-text-green-600 dark:univer-text-green-400 dark:hover:univer-bg-gray-700 hover:univer-bg-gray-100': iconActivated,
+ })}
onClick={handleCloseBtnClick}
>
<CloseSingle />
</span>
-
<span
- className={clsx(styles.iconContainer, styles.iconContainerSuccess, iconStyle)}
+ className={clsx(`
+ univer-flex univer-items-center univer-justify-center univer-rounded univer-p-1
+ univer-text-base
+ dark:univer-text-white
+ `, {
+ 'univer-cursor-pointer univer-text-red-600 dark:univer-text-red-400 dark:hover:univer-bg-gray-700 hover:univer-bg-gray-100': iconActivated,
+ })}
onClick={handleConfirmBtnClick}
>
<CheckMarkSingle />
</span>
-
- <span className={clsx(styles.iconContainer, styles.iconContainerFx)} onClick={handlerFxBtnClick}>
+ <span
+ className={clsx(`
+ univer-flex univer-cursor-pointer univer-items-center univer-justify-center univer-rounded
+ univer-p-1 univer-text-base
+ dark:univer-text-white dark:hover:univer-bg-gray-700
+ hover:univer-bg-gray-100
+ `)}
+ onClick={handlerFxBtnClick}
+ >
<FxSingle />
</span>
</div>
</div>
- <div className={styles.formulaContainer}>
+ <div className="univer-flex univer-w-full univer-flex-1 univer-overflow-hidden univer-pl-3">
<div
- className={styles.formulaInput}
+ className="univer-relative univer-flex-1"
onPointerDown={handlePointerDown}
onPointerUp={handlePointerUp}
ref={ref}
@@ -302,7 +333,9 @@ export function FormulaBar(props: IProps) {
initValue=""
onChange={() => { }}
isFocus={isFocusFxBar}
- className={styles.formulaContent}
+ className={`
+ univer-relative univer-h-full univer-w-full univer-break-words univer-outline-none
+ `}
unitId={editState?.unitId}
subUnitId={editState?.sheetId}
isSupportAcrossSheet
@@ -322,9 +355,28 @@ export function FormulaBar(props: IProps) {
disableContextMenu={false}
/>
)}
- {hideEditor ? <div className={styles.formulaInputMask} /> : null}
+ {/* When the editor is hidden, we just cover a div on the editor because re-instantiate
+ the formula editor will be expensive. */}
+ {hideEditor
+ ? (
+ <div
+ className={`
+ univer-pointer-events-none univer-relative univer-left-0 univer-top-0
+ univer-z-[100] univer-h-full univer-w-full univer-cursor-not-allowed
+ univer-bg-white
+ `}
+ />
+ )
+ : null}
</div>
- <div className={clsx(styles.arrowContainer, { [styles.arrowContainerDisable]: editDisable })} onClick={handleArrowClick}>
+ <div
+ className={clsx(`
+ univer-flex univer-h-full univer-w-5 univer-cursor-pointer univer-items-center
+ univer-justify-center univer-text-xs univer-text-gray-700
+ dark:univer-text-gray-200
+ `, { 'univer-cursor-not-allowed univer-text-gray-200 dark:univer-text-gray-700': editDisable })}
+ onClick={handleArrowClick}
+ >
{arrowDirection === ArrowDirection.Down
? (
<DropdownSingle />
diff --git a/packages/sheets-ui/src/views/formula-bar/index.module.less b/packages/sheets-ui/src/views/formula-bar/index.module.less
deleted file mode 100644
index 94e65c5d99..0000000000
--- a/packages/sheets-ui/src/views/formula-bar/index.module.less
+++ /dev/null
@@ -1,145 +0,0 @@
-.formula-box {
- display: flex;
-
- box-sizing: border-box;
- height: 28px;
-
- background: rgb(var(--bg-color-secondary));
- border-bottom: 1px solid rgb(var(--border-color));
-
- transition: height 0.15s;
-
- .name-ranges {
- box-sizing: border-box;
- width: 100px;
- height: 100%;
- position: relative;
- }
-
- .formula-bar {
- display: flex;
- width: 100%;
- height: 100%;
-
- .formula-icon {
- padding: 6px 0;
-
- &-disable {
- color: rgb(var(--grey-200));
- cursor: not-allowed;
- }
-
- &-wrapper {
- position: relative;
-
- display: flex;
- // gap: var(--margin-xs);
- align-items: center;
- justify-content: center;
-
- box-sizing: border-box;
- width: 80px;
- height: 100%;
-
- font-size: var(--font-size-xs);
-
- border-right: 1px solid rgb(var(--border-color));
-
- .icon-container {
- display: flex;
- align-items: center;
- justify-content: center;
-
- padding: var(--padding-xs);
-
- font-size: var(--font-size-lg);
-
- border-radius: var(--border-radius-base);
-
- &-success {
- &.formula-active {
- cursor: pointer;
- color: rgb(var(--success-color));
- &:hover {
- background-color: rgb(var(--grey-50));
- }
- }
- }
-
- &-error {
- &.formula-active {
- cursor: pointer;
- color: rgb(var(--error-color));
- &:hover {
- background-color: rgb(var(--grey-50));
- }
- }
- }
-
- &-fx {
- cursor: pointer;
- &:hover {
- background-color: rgb(var(--grey-50));
- }
- }
- }
- }
- }
-
- .formula-input {
- flex: 1;
- position: relative;
- }
-
- .formula-input-mask {
- position: absolute;
- top: 0;
- left: 0;
- width: 100%;
- height: 100%;
- pointer-events: none;
- z-index: 100;
- background: rgb(var(--color-white));
- cursor: not-allowed;
- }
-
- .formula-container {
- overflow: hidden;
- display: flex;
- flex: 1;
-
- width: 100%;
- padding: 0 0 0 10px;
-
- .formula-content {
- position: relative;
-
- width: 100%;
- height: 100%;
-
- word-wrap: break-word;
-
- outline: none;
- }
-
- .arrow-container {
- cursor: pointer;
-
- display: flex;
- align-items: center;
- justify-content: center;
-
- width: 20px;
- height: 100%;
-
- font-size: var(--font-size-xs);
- color: rgb(var(--text-color-secondary));
-
- &-disable {
- color: rgb(var(--grey-200));
- cursor: not-allowed;
- }
- }
- }
- }
-}
diff --git a/packages/sheets-ui/src/views/status-bar/CopyableStatisticItem.tsx b/packages/sheets-ui/src/views/status-bar/CopyableStatisticItem.tsx
index 6eeacb2b45..cdc08f1bbe 100644
--- a/packages/sheets-ui/src/views/status-bar/CopyableStatisticItem.tsx
+++ b/packages/sheets-ui/src/views/status-bar/CopyableStatisticItem.tsx
@@ -38,7 +38,7 @@ const allowPatternFunctions: IFunctionNames[] = [
FUNCTION_NAMES_STATISTICAL.MAX,
];
-export const functionDisplayNames: FunctionNameMap = {
+export const functionDisplayNames: IFunctionNameMap = {
[FUNCTION_NAMES_MATH.SUM]: 'statusbar.sum',
[FUNCTION_NAMES_STATISTICAL.AVERAGE]: 'statusbar.average',
[FUNCTION_NAMES_STATISTICAL.MIN]: 'statusbar.min',
@@ -47,7 +47,8 @@ export const functionDisplayNames: FunctionNameMap = {
[FUNCTION_NAMES_STATISTICAL.COUNTA]: 'statusbar.countA',
[FUNCTION_NAMES_TEXT.CONCATENATE]: 'concatenate',
};
-interface FunctionNameMap {
+
+interface IFunctionNameMap {
[key: string]: string;
}
diff --git a/packages/sheets/src/facade/__tests__/create-test-bed.ts b/packages/sheets/src/facade/__tests__/create-test-bed.ts
index 98f60f5758..30cdb3d0fb 100644
--- a/packages/sheets/src/facade/__tests__/create-test-bed.ts
+++ b/packages/sheets/src/facade/__tests__/create-test-bed.ts
@@ -106,7 +106,7 @@ export interface ITestBed {
class RenderManagerServiceTestBed extends RenderManagerService {
override createRender(unitId: string): IRender {
- const renderer = this._createRender(unitId, new Engine(100, 100));
+ const renderer = this._createRender(unitId, new Engine('', { elementHeight: 100, elementWidth: 100 }));
return renderer;
}
}
diff --git a/packages/sheets/src/facade/__tests__/create-worksheet-test-bed.ts b/packages/sheets/src/facade/__tests__/create-worksheet-test-bed.ts
index dd65ec938f..2cd772a39a 100644
--- a/packages/sheets/src/facade/__tests__/create-worksheet-test-bed.ts
+++ b/packages/sheets/src/facade/__tests__/create-worksheet-test-bed.ts
@@ -100,7 +100,7 @@ export interface ITestBed {
class RenderManagerServiceTestBed extends RenderManagerService {
override createRender(unitId: string): IRender {
- const renderer = this._createRender(unitId, new Engine(100, 100));
+ const renderer = this._createRender(unitId, new Engine('', { elementHeight: 100, elementWidth: 100 }));
return renderer;
}
}
diff --git a/packages/ui/src/views/components/ribbon/Button/ToolbarButton.tsx b/packages/ui/src/views/components/ribbon/Button/ToolbarButton.tsx
index a2de2fb722..ea600d8c9e 100644
--- a/packages/ui/src/views/components/ribbon/Button/ToolbarButton.tsx
+++ b/packages/ui/src/views/components/ribbon/Button/ToolbarButton.tsx
@@ -96,7 +96,8 @@ export function ToolbarButton(props: IBaseToolbarButtonProps) {
hover:univer-bg-gray-100
`, {
'univer-p-4': noIcon,
- '!univer-bg-gray-200 dark:univer-bg-gray-500': active,
+ 'univer-bg-gray-200 dark:univer-bg-gray-500': active,
+ // '!univer-bg-gray-200 !dark:univer-bg-gray-500': active,
})}
style={style}
disabled={disabled}
diff --git a/packages/ui/src/views/components/ribbon/Ribbon.tsx b/packages/ui/src/views/components/ribbon/Ribbon.tsx
index 36db86ec4a..389185b255 100644
--- a/packages/ui/src/views/components/ribbon/Ribbon.tsx
+++ b/packages/ui/src/views/components/ribbon/Ribbon.tsx
@@ -242,7 +242,7 @@ export function Ribbon(props: IRibbonProps) {
univer-relative univer-box-border univer-flex univer-h-8 univer-select-none univer-items-center
univer-border-0 univer-border-b univer-border-solid univer-border-b-gray-200 univer-bg-white
univer-text-base univer-text-gray-800 univer-transition-opacity
- dark:univer-bg-gray-900
+ dark:univer-border-b-gray-700 dark:univer-bg-gray-900
`}
>
<div
diff --git a/packages/ui/src/views/workbench/Workbench.tsx b/packages/ui/src/views/workbench/Workbench.tsx
index ed90556ca7..bea07539ef 100644
--- a/packages/ui/src/views/workbench/Workbench.tsx
+++ b/packages/ui/src/views/workbench/Workbench.tsx
@@ -152,7 +152,10 @@ export function DesktopWorkbenchContent(props: IUniverWorkbenchProps) {
{/* header */}
{header && toolbar && (
- <header className="univer-relative univer-z-10 univer-w-full">
+ <header
+ data-u-comp="headerbar"
+ className="univer-relative univer-z-10 univer-w-full"
+ >
<ComponentContainer
key="toolbar"
components={toolbarComponents}
@@ -181,6 +184,7 @@ export function DesktopWorkbenchContent(props: IUniverWorkbenchProps) {
univer-relative univer-grid univer-flex-1 univer-grid-rows-[auto_1fr]
univer-overflow-hidden univer-border-0 univer-border-b univer-border-solid
univer-border-b-gray-200 univer-bg-white
+ dark:univer-border-b-gray-700
`}
>
<header>
@@ -188,7 +192,10 @@ export function DesktopWorkbenchContent(props: IUniverWorkbenchProps) {
</header>
<section
- className="univer-relative univer-overflow-hidden"
+ className={`
+ univer-relative univer-overflow-hidden
+ dark:univer-bg-gray-900
+ `}
ref={contentRef}
data-range-selector
onContextMenu={(e) => e.preventDefault()}