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.

2.5 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 { DependencyOverride } from '@univerjs/core';
import type { MenuConfig } from '@univerjs/ui';

export const DOCS_UI_PLUGIN_CONFIG_KEY = 'docs-ui.config';
export const DOCS_UI_PLUGIN_NAME = 'DOC_UI_PLUGIN';

export const configSymbol = Symbol(DOCS_UI_PLUGIN_CONFIG_KEY);

export type DocFitMode = 'none' | 'fit-width';
export type DocFitTarget = 'viewport' | 'container';
export type DocFitAlign = 'center' | 'start';
export type DocFitPaddingX = number | `${number}%`;

export interface IDocFitToWidthOptions {
    mode?: DocFitMode;
    target?: DocFitTarget;
    paddingX?: DocFitPaddingX;
    minScale?: number;
    maxScale?: number;
    align?: DocFitAlign;
}

export interface IUniverDocsUIConfig {
    menu?: MenuConfig;
    container?: HTMLElement | string;
    /**
     * Show the left-hand document outline for heading navigation.
     * When omitted, enabled for modern documents and disabled for traditional documents.
     * Explicit `true` or `false` overrides the default in either document mode.
     */
    toc?: boolean;
    footer?: boolean;
    wordCount?: boolean;
    placeholder?: boolean;
    fitToWidth?: IDocFitToWidthOptions;
    override?: DependencyOverride;
}

export const DEFAULT_DOC_FIT_TO_WIDTH_OPTIONS: Required<Omit<IDocFitToWidthOptions, 'maxScale'>> & Pick<IDocFitToWidthOptions, 'maxScale'> = {
    mode: 'none',
    target: 'viewport',
    paddingX: 20,
    minScale: 1,
    maxScale: undefined,
    align: 'center',
};

export const defaultPluginConfig: IUniverDocsUIConfig = {
    footer: true,
    wordCount: true,
    placeholder: true,
    fitToWidth: DEFAULT_DOC_FIT_TO_WIDTH_OPTIONS,
};

export const defaultPluginMobileConfig: IUniverDocsUIConfig = {
    ...defaultPluginConfig,
    fitToWidth: {
        ...DEFAULT_DOC_FIT_TO_WIDTH_OPTIONS,
        mode: 'fit-width',
        paddingX: 12,
        minScale: 0,
        maxScale: 1,
    },
};