@univerjs/sheets-ui 0.6.10 → 0.7.0-beta.1

package/lib/locale/en-US.js

@@ -192,16 +192,16 @@ const e = {
     toBottomAdd: "Towards Bottom Add",
     toLeftAdd: "Towards Left Add",
     toRightAdd: "Towards Right Add",
-    deleteSelectedRow: "Delete Selected row",
-    deleteSelectedColumn: "Delete Selected column",
+    deleteSelectedRow: "Delete Selected Row",
+    deleteSelectedColumn: "Delete Selected Column",
     hideSelectedRow: "Hide Selected Row",
-    showHideRow: "Show Selected Row",
+    showHideRow: "Show Hide Row",
     rowHeight: "Row Height",
     hideSelectedColumn: "Hide Selected Column",
     showHideColumn: "Show Hide Column",
     columnWidth: "Column Width",
     moveLeft: "Move Left",
-    moveUp: "Move up",
+    moveUp: "Move Up",
     moveRight: "Move Right",
     moveDown: "Move Down",
     add: "Add",

package/lib/types/controllers/config.schema.d.ts

@@ -1,6 +1,7 @@
 import { DependencyOverride } from '@univerjs/core';
 import { IScrollBarProps } from '@univerjs/engine-render';
-import { MenuConfig } from '@univerjs/ui';
+import { ComponentType, MenuConfig } from '@univerjs/ui';
+import { IPermissionDetailUserPartProps } from '../views/permission/panel-detail/PermissionDetailUserPart';
 export declare const SHEETS_UI_PLUGIN_CONFIG_KEY = "sheets-ui.config";
 export declare const configSymbol: unique symbol;
 export interface IUniverSheetsUIConfig {
@@ -17,10 +18,57 @@ export interface IUniverSheetsUIConfig {
      * Whether to show the formula bar.
      */
     formulaBar?: boolean;
+    /**
+     * The config of the footer.
+     * @default {}
+     */
+    footer?: false | {
+        /**
+         * Sheet bar is the manager of sub sheets, including add/switch/delete sub sheets.
+         * @default true
+         */
+        sheetBar?: boolean;
+        /**
+         * statistic bar including statistic info current selections, such as count, sum, average, etc.
+         * @default true
+         */
+        statisticBar?: boolean;
+        /**
+         * Including the menus in the footer. such as highlight, gridlines, etc.
+         * @default true
+         */
+        menus?: boolean;
+        /**
+         * Zoom slider is the zoom slider in the footer.
+         * @default true
+         */
+        zoomSlider?: boolean;
+    };
+    /**
+     * @deprecated Use `footer.statisticBar` instead.
+     */
     statusBarStatistic?: boolean;
     clipboardConfig?: {
         hidePasteOptions?: boolean;
     };
     scrollConfig?: IScrollBarProps;
+    /**
+     * Whether to show the protected range shadow.
+     * @default true
+     */
+    protectedRangeShadow?: boolean;
+    /**
+     * The custom component of the protected range user selector.
+     */
+    protectedRangeUserSelector?: {
+        /**
+         * custom component, should implement the `IPermissionDetailUserPartProps` interface.
+         */
+        component: ComponentType<IPermissionDetailUserPartProps>;
+        /**
+         * The framework of the component. Must be passed correctly.
+         */
+        framework: 'react' | 'vue3';
+    };
 }
 export declare const defaultPluginConfig: IUniverSheetsUIConfig;

package/lib/types/controllers/render-controllers/zoom.render-controller.d.ts

@@ -21,5 +21,4 @@ export declare class SheetsZoomRenderController extends Disposable implements IR
      * @param zoomRatio
      */
     private _updateViewZoom;
-    private _getSheetObject;
 }

package/lib/types/controllers/shortcuts/editor.shortcut.d.ts

@@ -9,5 +9,6 @@ export declare const EditorCursorEscShortcut: IShortcutItem;
 export declare const EditorCursorCtrlEnterShortcut: IShortcutItem;
 export declare const EditorBreakLineShortcut: IShortcutItem;
 export declare const EditorDeleteLeftShortcut: IShortcutItem;
+export declare const EditorDeleteRightShortcut: IShortcutItem;
 export declare const ShiftEditorDeleteLeftShortcut: IShortcutItem;
 export declare const EditorDeleteLeftShortcutInActive: IShortcutItem;

package/lib/types/controllers/shortcuts/value.shortcut.d.ts

@@ -2,3 +2,4 @@ import { IShortcutItem } from '@univerjs/ui';
 export declare const ClearSelectionValueShortcutItem: IShortcutItem;
 export declare const ClearSelectionValueShortcutItemMac: IShortcutItem;
 export declare const ShiftClearSelectionValueShortcutItem: IShortcutItem;
+export declare const ShiftDeleteSelectionValueShortcutItem: IShortcutItem;

package/lib/types/index.d.ts

@@ -92,8 +92,11 @@ export { FormatPainterStatus, IFormatPainterService } from './services/format-pa
 export type { IFormatPainterBeforeApplyHookParams, IFormatPainterHook } from './services/format-painter/format-painter.service';
 export { SELECTION_SHAPE_DEPTH } from './services/selection/const';
 export { type IBaseSheetBarProps } from './views/sheet-bar/sheet-bar-tabs/SheetBarItem';
+export { useKeyEventConfig } from './views/editor-container';
 export { type IDropdownParam, ISheetCellDropdownManagerService, SheetCellDropdownManagerService } from './services/cell-dropdown-manager.service';
 export { FormulaBar } from './views/formula-bar/FormulaBar';
+export { type IPermissionDetailUserPartProps } from './views/permission/panel-detail/PermissionDetailUserPart';
+export { CellPopupManagerService } from './services/cell-popup-manager.service';
 export { SetWorksheetColAutoWidthCommand } from './commands/commands/set-worksheet-auto-col-width.command';
 export { AutoClearContentCommand, AutoFillCommand } from './commands/commands/auto-fill.command';
 export { type ISheetPasteByShortKeyParams, type ISheetPasteParams, SheetCopyCommand, SheetCutCommand, SheetPasteBesidesBorderCommand, SheetPasteColWidthCommand, SheetPasteCommand, SheetPasteFormatCommand, SheetPasteShortKeyCommand, SheetPasteValueCommand, } from './commands/commands/clipboard.command';

package/lib/types/plugin.d.ts

@@ -1,16 +1,18 @@
 import { IUniverSheetsUIConfig } from './controllers/config.schema';
 import { IConfigService, Injector, IUniverInstanceService, Plugin, UniverInstanceType } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
+import { ComponentManager } from '@univerjs/ui';
 export declare class UniverSheetsUIPlugin extends Plugin {
     private readonly _config;
     readonly _injector: Injector;
     private readonly _renderManagerService;
     private readonly _configService;
     private readonly _univerInstanceService;
+    private readonly _componentManager;
     static pluginName: string;
     static type: UniverInstanceType;
     /** @ignore */
-    constructor(_config: Partial<IUniverSheetsUIConfig> | undefined, _injector: Injector, _renderManagerService: IRenderManagerService, _configService: IConfigService, _univerInstanceService: IUniverInstanceService);
+    constructor(_config: Partial<IUniverSheetsUIConfig> | undefined, _injector: Injector, _renderManagerService: IRenderManagerService, _configService: IConfigService, _univerInstanceService: IUniverInstanceService, _componentManager: ComponentManager);
     onStarting(): void;
     onReady(): void;
     onRendered(): void;

package/lib/types/services/cell-alert-manager.service.d.ts

@@ -2,6 +2,7 @@ import { IDisposable, Disposable } from '@univerjs/core';
 import { ISheetLocationBase } from '@univerjs/sheets';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { SheetCanvasPopManagerService } from './canvas-pop-manager.service';
+import { CellPopupManagerService } from './cell-popup-manager.service';
 export declare enum CellAlertType {
     INFO = 0,
     WARNING = 1,
@@ -19,6 +20,7 @@ export interface ICellAlert {
 export declare class CellAlertManagerService extends Disposable {
     private readonly _renderManagerService;
     private readonly _canvasPopManagerService;
+    private readonly _cellPopupManagerService;
     private _currentAlert$;
     private _currentAlert;
     get currentAlert(): Map<string, {
@@ -29,7 +31,7 @@ export declare class CellAlertManagerService extends Disposable {
         alert: ICellAlert;
         dispose: IDisposable;
     }][]>;
-    constructor(_renderManagerService: IRenderManagerService, _canvasPopManagerService: SheetCanvasPopManagerService);
+    constructor(_renderManagerService: IRenderManagerService, _canvasPopManagerService: SheetCanvasPopManagerService, _cellPopupManagerService: CellPopupManagerService);
     showAlert(alert: ICellAlert): void;
     removeAlert(key: string): void;
     clearAlert(): void;

package/lib/types/services/cell-popup-manager.service.d.ts

@@ -0,0 +1,29 @@
+import { IDisposable, Disposable } from '@univerjs/core';
+import { ISheetLocationBase } from '@univerjs/sheets';
+import { ICanvasPopup, SheetCanvasPopManagerService } from './canvas-pop-manager.service';
+export interface ICellPopup extends Omit<ICanvasPopup, 'direction' | 'offset' | 'mask'> {
+    direction?: 'horizontal' | 'vertical';
+    id?: string;
+    priority: number;
+}
+export interface ICellPopupDirectionCache {
+    popups: ICellPopup[];
+    disposable: IDisposable;
+}
+export interface ICellPopupCache {
+    horizontal?: ICellPopupDirectionCache;
+    vertical?: ICellPopupDirectionCache;
+}
+export interface ICellPopupChange extends ISheetLocationBase {
+    direction: 'horizontal' | 'vertical';
+}
+export declare class CellPopupManagerService extends Disposable {
+    private readonly _sheetCanvasPopManagerService;
+    private readonly _cellPopupMap;
+    private readonly _change$;
+    readonly change$: import('rxjs').Observable<ICellPopupChange>;
+    constructor(_sheetCanvasPopManagerService: SheetCanvasPopManagerService);
+    private _ensureCellPopupMap;
+    showPopup(location: ISheetLocationBase, popup: ICellPopup): IDisposable;
+    getPopups(unitId: string, subUnitId: string, row: number, col: number, direction: 'horizontal' | 'vertical'): ICellPopup[];
+}

package/lib/types/services/editor-bridge.service.d.ts

@@ -1,9 +1,9 @@
 import { IDisposable, IPosition, ISelectionCell, Nullable, Disposable, IContextService, IUniverInstanceService, ThemeService } from '@univerjs/core';
 import { Engine, IDocumentLayoutObject, Scene, DeviceInputEventType, IRenderManagerService } from '@univerjs/engine-render';
-import { SheetsSelectionsService, SheetInterceptorService } from '@univerjs/sheets';
 import { KeyCode } from '@univerjs/ui';
 import { Observable, BehaviorSubject } from 'rxjs';
 import { IEditorService } from '@univerjs/docs-ui';
+import { SheetInterceptorService } from '@univerjs/sheets';
 export interface IEditorBridgeServiceVisibleParam {
     visible: boolean;
     eventType: DeviceInputEventType;
@@ -71,7 +71,6 @@ export declare class EditorBridgeService extends Disposable implements IEditorBr
     private readonly _themeService;
     private readonly _univerInstanceService;
     private readonly _editorService;
-    private readonly _refSelectionsService;
     private readonly _contextService;
     private _editorUnitId;
     private _editorIsDirty;
@@ -106,7 +105,7 @@ export declare class EditorBridgeService extends Disposable implements IEditorBr
     readonly afterVisible$: Observable<IEditorBridgeServiceVisibleParam>;
     private readonly _forceKeepVisible$;
     readonly forceKeepVisible$: Observable<boolean>;
-    constructor(_sheetInterceptorService: SheetInterceptorService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _univerInstanceService: IUniverInstanceService, _editorService: IEditorService, _refSelectionsService: SheetsSelectionsService, _contextService: IContextService);
+    constructor(_sheetInterceptorService: SheetInterceptorService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _univerInstanceService: IUniverInstanceService, _editorService: IEditorService, _contextService: IContextService);
     refreshEditCellState(): void;
     refreshEditCellPosition(resetSizeOnly?: boolean): void;
     setEditCell(param: ICurrentEditCellParam): void;

package/lib/types/services/print-interceptor.service.d.ts

@@ -17,6 +17,7 @@ interface ISheetPrintComponentContext extends ISheetPrintContext {
     spreadsheet: Spreadsheet;
 }
 export declare class SheetPrintInterceptorService extends Disposable {
+    private _printComponentMap;
     readonly interceptor: InterceptorManager<{
         PRINTING_RANGE: import('@univerjs/core').IInterceptor<IRange, {
             unitId: string;
@@ -26,5 +27,7 @@ export declare class SheetPrintInterceptorService extends Disposable {
         PRINTING_DOM_COLLECT: import('@univerjs/core').IInterceptor<DisposableCollection, ISheetPrintContext>;
     }>;
     constructor();
+    registerPrintComponent(componentKey: string, printingComponentKey: string): void;
+    getPrintComponent(componentKey: string): string | undefined;
 }
 export {};

package/lib/types/services/selection/base-selection-render.service.d.ts

@@ -1,6 +1,7 @@
-import { ICellInfo, ICellWithCoord, IContextService, IDisposable, IFreeze, IInterceptor, Injector, IRange, IRangeWithCoord, IStyleSheet, Nullable, Disposable, InterceptorManager, RANGE_TYPE, ThemeService } from '@univerjs/core';
+import { ICellInfo, ICellWithCoord, IContextService, IDisposable, IFreeze, IInterceptor, Injector, IRange, IRangeWithCoord, Nullable, Disposable, InterceptorManager, RANGE_TYPE, ThemeService } from '@univerjs/core';
 import { IMouseEvent, IPointerEvent, IRenderModule, Scene, SpreadsheetSkeleton, Viewport, ScrollTimer, ScrollTimerType } from '@univerjs/engine-render';
 import { ISelectionStyle, ISelectionWithCoord, ISelectionWithStyle } from '@univerjs/sheets';
+import { Theme } from '@univerjs/themes';
 import { IShortcutService } from '@univerjs/ui';
 import { Observable, Subscription, BehaviorSubject, Subject } from 'rxjs';
 import { SheetSkeletonManagerService } from '../sheet-skeleton-manager.service';
@@ -136,7 +137,7 @@ export declare class BaseSelectionRenderService extends Disposable implements IS
     refreshSelectionMoveStart(): void;
     refreshSelectionMoveEnd(): void;
     _initSelectionThemeFromThemeService(): void;
-    setSelectionTheme(prop: IStyleSheet): void;
+    setSelectionTheme(theme: Theme): void;
     protected _changeRuntime(skeleton: SpreadsheetSkeleton, scene: Scene, viewport?: Viewport): void;
     getSkeleton(): SpreadsheetSkeleton;
     /**

package/lib/types/services/sheets-render.service.d.ts

@@ -1,4 +1,4 @@
-import { IDisposable, IContextService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { IDisposable, IContextService, IUniverInstanceService, RxDisposable, ThemeService } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
 /**
  * This controller is responsible for managing units of a specific kind (UniverSheet) to be rendered on the canvas.
@@ -7,8 +7,9 @@ export declare class SheetsRenderService extends RxDisposable {
     private readonly _contextService;
     private readonly _instanceSrv;
     private readonly _renderManagerService;
+    private readonly _themeService;
     private _skeletonChangeMutations;
-    constructor(_contextService: IContextService, _instanceSrv: IUniverInstanceService, _renderManagerService: IRenderManagerService);
+    constructor(_contextService: IContextService, _instanceSrv: IUniverInstanceService, _renderManagerService: IRenderManagerService, _themeService: ThemeService);
     /**
      * Register a mutation id that will trigger the skeleton change.
      *
@@ -21,6 +22,7 @@ export declare class SheetsRenderService extends RxDisposable {
      */
     checkMutationShouldTriggerRerender(id: string): boolean;
     private _init;
+    private _initDarkModeListener;
     private _initWorkbookListener;
     private _createRenderer;
     private _disposeRenderer;

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

@@ -0,0 +1,16 @@
+/**
+ * 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 CELL_POPUP_COMPONENT_KEY = "sheets.component.cell-popup";

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

@@ -0,0 +1,7 @@
+import { ISheetLocationBase } from '@univerjs/sheets';
+import { 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/defined-name/DefinedNameOverlay.d.ts

@@ -13,6 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface IDefinedNameOverlayProps {
-}
-export declare function DefinedNameOverlay(props: IDefinedNameOverlayProps): import("react/jsx-runtime").JSX.Element;
+export declare function DefinedNameOverlay(): import("react/jsx-runtime").JSX.Element;

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

@@ -10,6 +10,7 @@ export interface IListDropdownProps {
         color?: string;
     }[];
     defaultValue?: string;
+    showEdit?: boolean;
 }
 export declare function ListDropDown(props: {
     popup: IPopup<IListDropdownProps & IBaseDropdownProps>;

package/lib/types/views/editor-container/index.d.ts

@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export * from './EditorContainer';
+export { useKeyEventConfig } from './hooks';

package/lib/types/views/permission/panel-detail/PermissionDetailUserPart.d.ts

@@ -1,5 +1,5 @@
 import { EditStateEnum, ViewStateEnum } from '@univerjs/sheets';
-interface IPermissionDetailUserPartProps {
+export interface IPermissionDetailUserPartProps {
     editState: EditStateEnum;
     onEditStateChange: (v: EditStateEnum) => void;
     viewState: ViewStateEnum;
@@ -7,4 +7,3 @@ interface IPermissionDetailUserPartProps {
     permissionId: string;
 }
 export declare const PermissionDetailUserPart: (props: IPermissionDetailUserPartProps) => import("react/jsx-runtime").JSX.Element | null;
-export {};

package/lib/types/views/sheet-bar/sheet-bar-tabs/utils/slide-tab-bar.d.ts

@@ -3,11 +3,9 @@ export interface IScrollState {
     leftEnd: boolean;
     rightEnd: boolean;
 }
-export interface SlideTabBarConfig {
-    slideTabBarClassName: string;
-    slideTabBarItemActiveClassName: string;
-    slideTabBarItemClassName: string;
-    slideTabBarSpanEditClassName: string;
+export interface ISlideTabBarConfig {
+    slideTabBarSelector: string;
+    slideTabBarItemSelector: string;
     slideTabBarContainer: HTMLDivElement | null;
     slideTabBarItemAutoSort: boolean;
     currentIndex: number;
@@ -76,7 +74,7 @@ export declare class SlideTabBar {
     protected _activeTabItemIndex: number;
     protected _slideTabBar: HTMLElement;
     protected _slideTabItems: SlideTabItem[];
-    protected _config: SlideTabBarConfig;
+    protected _config: ISlideTabBarConfig;
     protected _downActionX: number;
     protected _moveActionX: number;
     protected _compareIndex: number;
@@ -106,7 +104,7 @@ export declare class SlideTabBar {
      * The distance required to move to the right border
      */
     protected _rightMoveX: number;
-    constructor(config: Partial<SlideTabBarConfig>);
+    constructor(config: Partial<ISlideTabBarConfig>);
     static checkedSkipSlide(event: MouseEvent): boolean;
     static keepLastIndex(inputHtml: HTMLElement): void;
     static keepSelectAll(inputHtml: HTMLElement): void;
@@ -118,7 +116,7 @@ export declare class SlideTabBar {
     primeval(): HTMLElement;
     updateItems(): void;
     getScrollbar(): SlideScrollbar;
-    getConfig(): SlideTabBarConfig;
+    getConfig(): ISlideTabBarConfig;
     getBoundingRect(): DOMRect;
     getSlideTabItems(): SlideTabItem[];
     getActiveItem(): SlideTabItem | null;

package/lib/types/views/{count-bar → sheet-slider}/CountBar.d.ts

@@ -13,9 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-interface ICountBarProps {
-    changeRatio?: (ratio: string) => void;
-    onChange?: (value: string) => void;
-}
-export declare function CountBar(props: ICountBarProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export declare function SheetZoomSlider(): import("react/jsx-runtime").JSX.Element;

package/lib/types/views/status-bar/CopyableStatisticItem.d.ts

@@ -1,5 +1,5 @@
 import { IFunctionNames } from '@univerjs/engine-formula';
-import { default as React } from 'react';
+import { FC } from 'react';
 export interface IStatisticItem {
     name: IFunctionNames;
     value: number;
@@ -7,10 +7,10 @@ export interface IStatisticItem {
     disable: boolean;
     pattern: string | null;
 }
-export declare const functionDisplayNames: FunctionNameMap;
-interface FunctionNameMap {
+export declare const functionDisplayNames: IFunctionNameMap;
+interface IFunctionNameMap {
     [key: string]: string;
 }
-export declare const CopyableStatisticItem: React.FC<IStatisticItem>;
+export declare const CopyableStatisticItem: FC<IStatisticItem>;
 export declare function formatNumber(item: IStatisticItem): string | 0;
 export {};