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.

3.4 KB
Raw Blame
/**
 * 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 { ICanvasColorService } from '@univerjs/engine-render';
import { DocumentFlavor } from '@univerjs/core';

const DOC_TRADITIONAL_WORKSPACE_BACKGROUND_COLOR = 'var(--univer-gray-100)';
const DOC_MODERN_WORKSPACE_BACKGROUND_COLOR = 'var(--univer-gray-0)';
const DOC_UNSPECIFIED_WORKSPACE_BACKGROUND_COLOR = 'var(--univer-gray-100)';
const DOC_EDITOR_INTERNAL_BACKGROUND_COLOR = 'transparent';
const DOC_TRADITIONAL_WORKSPACE_BACKGROUND_TOKEN = 'gray.100';
const DOC_MODERN_WORKSPACE_BACKGROUND_TOKEN = 'gray.0';

export interface IResolveDocRenderBackgroundOptions {
    documentFlavor?: DocumentFlavor;
    canvasColorService?: ICanvasColorService;
    editorBackgroundColor?: string;
    isEditor?: boolean;
}

export interface IResolvedDocRenderBackground {
    canvasElementBackgroundColor: string;
    docBackgroundFillColor?: string;
}

export function resolveDocRenderBackground(options: IResolveDocRenderBackgroundOptions): IResolvedDocRenderBackground {
    const { documentFlavor, canvasColorService, editorBackgroundColor, isEditor } = options;
    const backgroundColor = editorBackgroundColor ?? getDefaultDocCanvasBackgroundColor(documentFlavor, isEditor);

    if (isEditor) {
        return {
            canvasElementBackgroundColor: backgroundColor,
            docBackgroundFillColor: DOC_EDITOR_INTERNAL_BACKGROUND_COLOR,
        };
    }

    if (editorBackgroundColor != null) {
        return {
            canvasElementBackgroundColor: canvasColorService?.getRenderColor(editorBackgroundColor) ?? editorBackgroundColor,
            docBackgroundFillColor: undefined,
        };
    }

    if (documentFlavor !== DocumentFlavor.TRADITIONAL && documentFlavor !== DocumentFlavor.MODERN) {
        return {
            canvasElementBackgroundColor: backgroundColor,
            docBackgroundFillColor: undefined,
        };
    }

    const renderBackgroundColor = getDefaultDocCanvasBackgroundToken(documentFlavor);

    return {
        canvasElementBackgroundColor: canvasColorService?.getRenderColor(renderBackgroundColor) ?? backgroundColor,
        docBackgroundFillColor: undefined,
    };
}

export function getDefaultDocCanvasBackgroundColor(documentFlavor?: DocumentFlavor, isEditor?: boolean) {
    if (isEditor) {
        return DOC_EDITOR_INTERNAL_BACKGROUND_COLOR;
    }

    switch (documentFlavor) {
        case DocumentFlavor.MODERN:
            return DOC_MODERN_WORKSPACE_BACKGROUND_COLOR;
        case DocumentFlavor.TRADITIONAL:
            return DOC_TRADITIONAL_WORKSPACE_BACKGROUND_COLOR;
        default:
            return DOC_UNSPECIFIED_WORKSPACE_BACKGROUND_COLOR;
    }
}

function getDefaultDocCanvasBackgroundToken(documentFlavor: DocumentFlavor.TRADITIONAL | DocumentFlavor.MODERN) {
    return documentFlavor === DocumentFlavor.MODERN
        ? DOC_MODERN_WORKSPACE_BACKGROUND_TOKEN
        : DOC_TRADITIONAL_WORKSPACE_BACKGROUND_TOKEN;
}