@univerjs/sheets-ui 1.0.0 → 1.0.2

package/lib/types/facade/f-sheet-hooks.d.ts

@@ -1,125 +0,0 @@
-/**
- * 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 { ICellCustomRender, IDisposable, Nullable } from '@univerjs/core';
-import type { IDragCellPosition, IEditorBridgeServiceVisibleParam, IHoverCellPosition } from '@univerjs/sheets-ui';
-import { InterceptorEffectEnum } from '@univerjs/core';
-import { FSheetHooks } from '@univerjs/sheets/facade';
-/**
- * @ignore
- */
-export interface IFSheetHooksUIMixin {
-    /**
-     * The onCellPointerMove event is fired when a pointer changes coordinates.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => {})` instead
-     * @param {function(Nullable<IHoverCellPosition>): void} callback - function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onCellPointerMove((cellPos) => { console.log(cellPos)});
-     * ```
-     */
-    onCellPointerMove(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
-    /**
-     * The onCellPointerOver event is fired when a pointer is moved into a cell's hit test boundaries.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CellHover, (params) => {})` instead
-     * @param {function(Nullable<IHoverCellPosition>): void} callback - function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onCellPointerOver((cellPos) => { console.log(cellPos)});
-     * ```
-     */
-    onCellPointerOver(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
-    /**
-     * The onCellDragOver event is fired when an element or text selection is being dragged into a cell's hit test boundaries.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.DragOver, (params) => {})` instead
-     * @param {function (Nullable<IDragCellPosition>): void} callback Callback function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onCellDragOver((cellPos) => { console.log(cellPos)});
-     * ```
-     */
-    onCellDragOver(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
-    /**
-     * The onCellDrop event is fired when an element or text selection is being dropped on the cell.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Drop, (params) => {})` instead
-     * @param {function(Nullable<IDragCellPosition>): void} callback Callback function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onCellDrop((cellPos) => { console.log(cellPos)});
-     * ```
-     */
-    onCellDrop(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
-    /**
-     * The onCellRender event is fired when a cell is rendered.
-     * @param {Nullable<ICellCustomRender[]>} customRender Custom render function
-     * @param {InterceptorEffectEnum} [effect] The effect of the interceptor
-     * @param {number} priority The priority of the interceptor
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-        univerAPI.getSheetHooks().onCellRender([{
-            drawWith: (ctx, info) => {
-                const { row, col } = info;
-                // Update to any cell location you want
-                if (row === 1 && col === 2) {
-                    const { primaryWithCoord } = info;
-                    const { startX, startY } = primaryWithCoord;
-                    ctx.fillText('Univer', startX, startY + 10);
-                }
-            },
-        }])
-     * ```
-     */
-    onCellRender(customRender: Nullable<ICellCustomRender[]>, effect?: InterceptorEffectEnum, priority?: number): IDisposable;
-    /**
-     * The onBeforeCellEdit event is fired before a cell is edited.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeSheetEditStart, (params) => {})` instead
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onBeforeCellEdit((params) => {console.log(params)})
-     * ```
-     */
-    onBeforeCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
-    /**
-     * The onAfterCellEdit event is fired after a cell is edited.
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetEditEnded, (params) => {})` instead
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
-     * @example
-     * ```ts
-     * univerAPI.getSheetHooks().onAfterCellEdit((params) => {console.log(params)})
-     * ```
-     */
-    onAfterCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
-}
-export declare class FSheetHooksUIMixin extends FSheetHooks implements IFSheetHooksUIMixin {
-    onCellPointerMove(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
-    onCellPointerOver(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
-    onCellDragOver(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
-    onCellDrop(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
-    onCellRender(customRender: Nullable<ICellCustomRender[]>, effect?: InterceptorEffectEnum, priority?: number): IDisposable;
-    onBeforeCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
-    onAfterCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
-}
-declare module '@univerjs/sheets/facade' {
-    interface FSheetHooks extends IFSheetHooksUIMixin {
-    }
-}

package/lib/types/facade/f-workbook-permission.d.ts

@@ -1,39 +0,0 @@
-/**
- * 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 { FWorkbookPermission } from '@univerjs/sheets/facade';
-/**
- * @ignore
- */
-export interface IFWorkbookPermissionSheetsUIMixin {
-    /**
-     * Set visibility of unauthorized pop-up window
-     * @param {boolean} visible - visibility of unauthorized pop-up window
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const permission = fWorkbook.getWorkbookPermission();
-     * permission.setPermissionDialogVisible(false);
-     * ```
-     */
-    setPermissionDialogVisible(visible: boolean): void;
-}
-export declare class FWorkbookPermissionSheetsUIMixin extends FWorkbookPermission implements IFWorkbookPermissionSheetsUIMixin {
-    setPermissionDialogVisible(visible: boolean): void;
-}
-declare module '@univerjs/sheets/facade' {
-    interface FWorkbookPermission extends IFWorkbookPermissionSheetsUIMixin {
-    }
-}

package/lib/types/menu/mobile-menu.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 { menuSchema } from './schema';

package/lib/types/services/sheet-loading-render.service.d.ts

@@ -1,65 +0,0 @@
-/**
- * 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 { ICellData, IObjectMatrixPrimitiveType, IWorkbookData } from '@univerjs/core';
-import { Disposable, Injector, Workbook } from '@univerjs/core';
-import { IRenderManagerService } from '@univerjs/engine-render';
-import { SheetInterceptorService } from '@univerjs/sheets';
-import { ILayoutService } from '@univerjs/ui';
-import { BehaviorSubject, Observable } from 'rxjs';
-export interface ISheetLoadingRenderService {
-    readonly workbook$: Observable<Workbook | null>;
-    readonly loading$: Observable<boolean>;
-    readonly previewReady$: Observable<boolean>;
-    showSkeleton(workbookData: IWorkbookData, activeSheetId: string): void;
-    show(workbookData: IWorkbookData, activeSheetId: string, cellData?: IObjectMatrixPrimitiveType<ICellData>): void;
-    handoff(sourceUnitId: string, timeoutMs: number): Promise<boolean>;
-    hide(sourceUnitId: string): void;
-}
-export declare const ISheetLoadingRenderService: import("@wendellhu/redi").IdentifierDecorator<ISheetLoadingRenderService>;
-/**
- * Renders a read-only workbook shell without registering it in IUniverInstanceService.
- * The temporary workbook is therefore invisible to formulas, RPC and collaboration.
- */
-export declare class SheetLoadingRenderService extends Disposable implements ISheetLoadingRenderService {
-    private readonly _injector;
-    private readonly _layoutService;
-    private readonly _sheetInterceptorService;
-    private readonly _renderManagerService;
-    readonly workbook$: BehaviorSubject<Workbook | null>;
-    readonly loading$: BehaviorSubject<boolean>;
-    readonly previewReady$: BehaviorSubject<boolean>;
-    private _loadingRender;
-    private _finalCanvasGuard;
-    private _hiddenFinalCanvas;
-    private _finalCanvasVisibility;
-    constructor(_injector: Injector, _layoutService: ILayoutService, _sheetInterceptorService: SheetInterceptorService, _renderManagerService: IRenderManagerService);
-    showSkeleton(workbookData: IWorkbookData, activeSheetId: string): void;
-    show(workbookData: IWorkbookData, activeSheetId: string, cellData?: IObjectMatrixPrimitiveType<ICellData>): void;
-    handoff(sourceUnitId: string, timeoutMs: number): Promise<boolean>;
-    hide(sourceUnitId: string): void;
-    dispose(): void;
-    private _createLoadingWorkbook;
-    private _createLoadingRender;
-    private _waitForFinalCanvas;
-    private _getFinalRender$;
-    private _guardFinalCanvas;
-    private _requestFinalRender;
-    private _hideFinalCanvas;
-    private _restoreFinalCanvas;
-    private _waitForNextAnimationFrame;
-    private _disposeLoadingRender;
-    private _disposeRender;
-}

package/lib/types/views/cell-popup/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * 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 { ISheetLocationBase } from '@univerjs/sheets';
-import type { IPopup } from '@univerjs/ui';
-export declare const CellPopup: (props: {
-    popup: IPopup<ISheetLocationBase & {
-        direction: "horizontal" | "vertical";
-    }>;
-}) => import("react/jsx-runtime").JSX.Element;

package/lib/types/views/dropdown/cascader-dropdown/index.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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 { ICascaderOption } from '@univerjs/design';
-import type { IPopup } from '@univerjs/ui';
-import type { IBaseDropdownProps } from '../type';
-export interface ICascaderDropdownProps {
-    options: ICascaderOption[];
-    defaultValue?: string[];
-    onChange: (value: string[]) => void;
-}
-export declare function CascaderDropdown(props: {
-    popup: IPopup<ICascaderDropdownProps & IBaseDropdownProps>;
-}): import("react/jsx-runtime").JSX.Element;
-export declare namespace CascaderDropdown {
-    var componentKey: string;
-}

package/lib/types/views/dropdown/color-dropdown/index.d.ts

@@ -1,27 +0,0 @@
-/**
- * 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 { IPopup } from '@univerjs/ui';
-import type { IBaseDropdownProps } from '../type';
-export interface IColorDropdownProps {
-    defaultValue?: string;
-    onChange?: (value: string) => void;
-}
-export declare function ColorDropdown(props: {
-    popup: IPopup<IColorDropdownProps & IBaseDropdownProps>;
-}): import("react/jsx-runtime").JSX.Element;
-export declare namespace ColorDropdown {
-    var componentKey: string;
-}

package/lib/types/views/dropdown/date-dropdown/index.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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 { DateKit } from '@univerjs/core';
-import type { IPopup } from '@univerjs/ui';
-import type { IBaseDropdownProps } from '../type';
-export interface IDateDropdownProps {
-    defaultValue?: DateKit;
-    onChange?: (value: DateKit | undefined) => boolean | Promise<boolean>;
-    patternType?: 'datetime' | 'date' | 'time';
-    showTime?: boolean;
-}
-export declare function DateDropdown(props: {
-    popup: IPopup<IDateDropdownProps & IBaseDropdownProps>;
-}): import("react/jsx-runtime").JSX.Element;
-export declare namespace DateDropdown {
-    var componentKey: string;
-}

package/lib/types/views/dropdown/list-dropdown/index.d.ts

@@ -1,36 +0,0 @@
-/**
- * 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 { IPopup } from '@univerjs/ui';
-import type { IBaseDropdownProps } from '../type';
-export interface IListDropdownProps {
-    multiple?: boolean;
-    onEdit?: () => void;
-    onChange?: (value: string[]) => boolean | Promise<boolean>;
-    options: {
-        label: string;
-        value: string;
-        color?: string;
-    }[];
-    defaultValue?: string;
-    showEdit?: boolean;
-    showSearch?: boolean;
-}
-export declare function ListDropDown(props: {
-    popup: IPopup<IListDropdownProps & IBaseDropdownProps>;
-}): import("react/jsx-runtime").JSX.Element | null;
-export declare namespace ListDropDown {
-    var componentKey: string;
-}

package/lib/types/views/permission/error-msg-dialog/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * 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 declare const AlertDialog: ({ errorMsg }: {
-    errorMsg: string;
-}) => import("react/jsx-runtime").JSX.Element;

package/lib/types/views/permission/panel/index.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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 { IPermissionPanelRule } from '../../../services/permission/sheet-permission-panel.model';
-interface ISheetPermissionPanelProps {
-    showDetail: boolean;
-    fromSheetBar: boolean;
-    rule?: IPermissionPanelRule;
-    oldRule?: IPermissionPanelRule;
-}
-export declare const SheetPermissionPanel: ({ showDetail, fromSheetBar, rule, oldRule }: ISheetPermissionPanelProps) => import("react/jsx-runtime").JSX.Element | null;
-export {};

package/lib/types/views/permission/panel-list/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 declare function SheetPermissionPanelList(): import("react/jsx-runtime").JSX.Element | null;

package/lib/types/views/permission/permission-dialog/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 declare const SheetPermissionDialog: () => import("react/jsx-runtime").JSX.Element;

package/lib/types/views/permission/spin/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * 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 { ReactNode } from 'react';
-interface ISpinProps {
-    loading: boolean;
-    children: ReactNode;
-}
-declare const Spin: ({ loading, children }: ISpinProps) => import("react/jsx-runtime").JSX.Element;
-export default Spin;

package/lib/types/views/permission/user-dialog/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 declare const SheetPermissionUserDialog: () => import("react/jsx-runtime").JSX.Element;