@univerjs/docs-ui/lib/types/facade/f-univer.d.ts

Editor UI layer for Univer Docs.

/**
 * 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 { IDocumentData } from '@univerjs/core';
import { FUniver } from '@univerjs/core/facade';
import { FDocument } from './f-document';
/**
 * @ignore
 */
export interface IFUniverDocsUIMixin {
    /**
     * Create a new document and get the API handler of that document.
     *
     * @param {Partial<IDocumentData>} data The snapshot of the document.
     * @returns {FDocument} FDocument API instance.
     */
    createUniverDoc(data: Partial<IDocumentData>): FDocument;
    /**
     * Get the document API handler by the document id.
     *
     * @param {string} id The document id.
     * @returns {FDocument | null} The document API instance.
     */
    getUniverDoc(id: string): FDocument | null;
    /**
     * Get the currently focused Univer document.
     *
     * @returns {FDocument | null} The currently focused Univer document.
     */
    getActiveDocument(): FDocument | null;
}
export declare class FUniverDocsUIMixin extends FUniver implements IFUniverDocsUIMixin {
    createUniverDoc(data: Partial<IDocumentData>): FDocument;
    getActiveDocument(): FDocument | null;
    getUniverDoc(id: string): FDocument | null;
}
declare module '@univerjs/core/facade' {
    interface FUniver extends IFUniverDocsUIMixin {
    }
}