@univerjs/ui - npm Package Compare versions

Comparing version 0.2.6 to 0.2.7

lib/types/components/editor/TextEditor.d.ts

@@ -10,7 +10,8 @@ import { IDocumentData, Nullable } from '@univerjs/core';
     snapshot?: IDocumentData;
+    value?: string;
     resizeCallBack?: (editor: Nullable<HTMLDivElement>) => void;
     cancelDefaultResizeListener?: boolean;
+    canvasStyle?: IEditorCanvasStyle;
     isSheetEditor?: boolean;
-    canvasStyle?: IEditorCanvasStyle;
-    value?: string;
+    isFormulaEditor?: boolean;
     isSingle?: boolean;
@@ -17,0 +18,0 @@ isReadonly?: boolean;

lib/types/components/hooks/observable.d.ts

@@ -8,4 +8,5 @@ import { Nullable } from '@univerjs/core';
 export declare function useObservable<T>(observable: Nullable<ObservableOrFn<T>>, defaultValue?: undefined): T | undefined;
+export declare function useObservable<T>(observable: Nullable<ObservableOrFn<T>>, defaultValue: T, shouldHaveSyncValue?: boolean, deps?: any[]): T;
 export declare function useObservable<T>(observable: Nullable<ObservableOrFn<T>>, defaultValue: undefined, shouldHaveSyncValue: true, deps?: any[]): T;
 export declare function useObservable<T>(observable: Nullable<ObservableOrFn<T>>, defaultValue?: T, shouldHaveSyncValue?: boolean, deps?: any[]): T | undefined;
 export {};

lib/types/index.d.ts

@@ -49,3 +49,3 @@ /**
 export { DesktopSidebarService } from './services/sidebar/desktop-sidebar.service';
-export { ISidebarService } from './services/sidebar/sidebar.service';
+export { ISidebarService, ILeftSidebarService } from './services/sidebar/sidebar.service';
 export { IZenZoneService } from './services/zen-zone/zen-zone.service';
@@ -58,3 +58,3 @@ export { UniverUIPlugin, DISABLE_AUTO_FOCUS_KEY } from './ui-plugin';
 export { ComponentContainer, useComponentsOfPart, type IComponentContainerProps } from './views/components/ComponentContainer';
-export { IEditorService, EditorService } from './services/editor/editor.service';
+export { IEditorService, EditorService, Editor } from './services/editor/editor.service';
 export { TextEditor } from './components/editor/TextEditor';
@@ -79,2 +79,3 @@ export { RangeSelector } from './components/range-selector/RangeSelector';
 export { Sidebar } from './views/components/sidebar/Sidebar';
+export { type ISidebarMethodOptions } from './views/components/sidebar/interface';
 export { ZenZone } from './views/components/zen-zone/ZenZone';
@@ -86,3 +87,5 @@ export { CanvasPopup } from './views/components/popup/CanvasPopup';
 export { Toolbar } from './views/components/doc-bars/Toolbar';
+export { ToolbarItem } from './views/components/doc-bars/ToolbarItem';
+export { ToolbarButton } from './views/components/doc-bars/Button/ToolbarButton';
 export { ToggleShortcutPanelOperation } from './commands/operations/toggle-shortcut-panel.operation';
 export { SetEditorResizeOperation } from './commands/operations/editor/set-editor-resize.operation';

lib/types/services/editor/editor.service.d.ts

 import { DocumentDataModel, IDisposable, IDocumentBody, IDocumentData, IPosition, Nullable, Disposable, IContextService, IUniverInstanceService } from '@univerjs/core';
 import { Observable } from 'rxjs';
-import { IRender, ISuccinctTextRangeParam, IRenderManagerService } from '@univerjs/engine-render';
+import { IRender, ISuccinctDocRangeParam, IRenderManagerService } from '@univerjs/engine-render';
 import { LexerTreeBuilder } from '@univerjs/engine-formula';
@@ -18,2 +18,7 @@
     isSheetEditor: boolean;
+    /**
+     * If the editor is for formula editing.
+     * @deprecated this is a temp fix before refactoring editor.
+     */
+    isFormulaEditor: boolean;
     isSingle: boolean;
@@ -69,2 +74,4 @@ isReadonly: boolean;
     isSheetEditor(): boolean;
+    /** @deprecated */
+    isFormulaEditor(): boolean;
     getValue(): string;
@@ -103,3 +110,3 @@ getBody(): IDocumentBody | undefined;
     blur(): void;
-    focus$: Observable<ISuccinctTextRangeParam>;
+    focus$: Observable<ISuccinctDocRangeParam>;
     focus(editorUnitId?: string): void;
@@ -147,3 +154,3 @@ setValue$: Observable<IEditorSetValueParam>;
     private readonly _focus$;
-    readonly focus$: Observable<ISuccinctTextRangeParam>;
+    readonly focus$: Observable<ISuccinctDocRangeParam>;
     private readonly _setValue$;
@@ -194,5 +201,4 @@ readonly setValue$: Observable<IEditorSetValueParam>;
     private _getCurrentEditorUnitId;
-    private _refresh;
     private _getBlank;
 }
 export declare const IEditorService: import('@univerjs/core').IdentifierDecorator<IEditorService>;

lib/types/services/layout/layout.service.d.ts

@@ -15,9 +15,9 @@ import { ContextService, IDisposable, Nullable, Disposable, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
     registerRootContainerElement(container: HTMLElement): IDisposable;
-    /** Register a canvas element. */
-    registerCanvasElement(container: HTMLCanvasElement): IDisposable;
+    /** Register a content element. */
+    registerContentElement(container: HTMLElement): IDisposable;
     /** Register an element as a container, especially floating components like Dialogs and Notifications. */
     registerContainerElement(container: HTMLElement): IDisposable;
-    getCanvasElement(): HTMLCanvasElement;
+    getContentElement(): HTMLElement;
     checkElementInCurrentContainers(element: HTMLElement): boolean;
-    checkCanvasIsFocused(): boolean;
+    checkContentIsFocused(): boolean;
 }
@@ -37,3 +37,3 @@ export declare const ILayoutService: import('@univerjs/core').IdentifierDecorator<ILayoutService>;
     private readonly _focusHandlers;
-    private _canvasContainers;
+    private _contentElements;
     private _allContainers;
@@ -44,8 +44,8 @@ constructor(_contextService: ContextService, _univerInstanceService: IUniverInstanceService, _editorService: IEditorService);
     registerFocusHandler(type: UniverInstanceType, handler: FocusHandlerFn): IDisposable;
-    registerCanvasElement(container: HTMLCanvasElement): IDisposable;
-    getCanvasElement(): HTMLCanvasElement;
+    registerContentElement(container: HTMLElement): IDisposable;
+    getContentElement(): HTMLElement;
     registerRootContainerElement(container: HTMLElement): IDisposable;
     registerContainerElement(container: HTMLElement): IDisposable;
     checkElementInCurrentContainers(element: HTMLElement): boolean;
-    checkCanvasIsFocused(): boolean;
+    checkContentIsFocused(): boolean;
     private _initUniverFocusListener;
@@ -52,0 +52,0 @@ private _initEditorStatus;

lib/types/services/menu/menu.d.ts

@@ -41,2 +41,7 @@ import { IAccessor } from '@univerjs/core';
     id: string;
+    /**
+     * If two menus reuse the same command (e.g. copy & paste command). They should have the same command
+     * id and different ids.
+     */
+    commandId?: string;
     subId?: string;
@@ -70,2 +75,3 @@ title?: string;
 export interface IValueOption<T = undefined> {
+    id?: string;
     value?: string | number;
@@ -84,3 +90,3 @@ value$?: Observable<T>;
     disabled?: boolean;
-    id?: string;
+    commandId?: string;
 }
@@ -87,0 +93,0 @@ export interface ICustomComponentProps<T> {

lib/types/services/shortcut/shortcut.service.d.ts

@@ -5,2 +5,3 @@ import { Disposable, ICommandService, IContextService, IDisposable } from '@univerjs/core';
 import { IPlatformService } from '../platform/platform.service';
+import { KeyCode } from './keycode';
 
@@ -17,3 +18,3 @@ export interface IShortcutItem<P extends object = object> {
     /** A command can be bound to several bindings, with different static parameters perhaps. */
-    binding: number;
+    binding: KeyCode | number;
     mac?: number;
@@ -20,0 +21,0 @@ win?: number;

lib/types/services/sidebar/desktop-sidebar.service.d.ts

@@ -10,4 +10,6 @@ import { IDisposable } from '@univerjs/core';
     readonly scrollEvent$: Subject<Event>;
+    get visible(): boolean;
+    get options(): ISidebarMethodOptions;
     open(params: ISidebarMethodOptions): IDisposable;
-    close(): void;
+    close(id?: string): void;
 }

lib/types/services/sidebar/sidebar.service.d.ts

@@ -5,3 +5,2 @@ import { IDisposable } from '@univerjs/core';
 
-export declare const ISidebarService: import('@univerjs/core').IdentifierDecorator<ISidebarService>;
 export interface ISidebarService {
@@ -11,3 +10,7 @@ readonly sidebarOptions$: Subject<ISidebarMethodOptions>;
     open(params: ISidebarMethodOptions): IDisposable;
-    close(): void;
+    close(id?: string): void;
+    get visible(): boolean;
+    get options(): ISidebarMethodOptions;
 }
+export declare const ILeftSidebarService: import('@univerjs/core').IdentifierDecorator<ISidebarService>;
+export declare const ISidebarService: import('@univerjs/core').IdentifierDecorator<ISidebarService>;

lib/types/views/components/doc-bars/hook.d.ts

@@ -23,3 +23,3 @@ import { IDisplayMenuItem, IMenuItem, MenuGroup, MenuPosition } from '../../../services/menu/menu';
  */
-export declare function useToolbarGroups(categories: MenuPositionWithCustom[]): IToolbarRenderHookHandler;
+export declare function useToolbarGroups(categories: MenuPositionWithCustom[], initCategory?: string): IToolbarRenderHookHandler;
 export interface IToolbarItemStatus {
@@ -26,0 +26,0 @@ disabled: boolean;

lib/types/views/components/sidebar/interface.d.ts

 import { ICustomLabelProps } from '../../../components/custom-label/CustomLabel';
 
 export interface ISidebarMethodOptions {
+    id?: string;
     header?: ICustomLabelProps;
@@ -5,0 +6,0 @@ children?: ICustomLabelProps;

lib/types/views/workbench/Workbench.d.ts

@@ -6,4 +6,4 @@ import { default as React } from 'react';
     mountContainer: HTMLElement;
-    onRendered?: (container: HTMLElement) => void;
+    onRendered?: (containerElement: HTMLElement) => void;
 }
 export declare function DesktopWorkbench(props: IUniverWorkbenchProps): React.JSX.Element;

package.json

 {
   "name": "@univerjs/ui",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "private": false,
@@ -57,10 +57,10 @@ "description": "UniverSheet normal plugin UI manager",
     "rxjs": ">=7.0.0",
-    "@univerjs/core": "0.2.6",
-    "@univerjs/engine-render": "0.2.6",
-    "@univerjs/engine-formula": "0.2.6",
-    "@univerjs/ui": "0.2.6",
-    "@univerjs/design": "0.2.6"
+    "@univerjs/core": "0.2.7",
+    "@univerjs/design": "0.2.7",
+    "@univerjs/engine-formula": "0.2.7",
+    "@univerjs/ui": "0.2.7",
+    "@univerjs/engine-render": "0.2.7"
   },
   "dependencies": {
-    "@univerjs/icons": "^0.1.70",
+    "@univerjs/icons": "^0.1.72",
     "localforage": "^1.10.0",
@@ -86,9 +86,9 @@ "rc-notification": "^5.6.0",
     "vite": "^5.3.5",
-    "vitest": "^2.0.4",
-    "vue": "^3.4.29",
-    "@univerjs/engine-formula": "0.2.6",
-    "@univerjs/design": "0.2.6",
-    "@univerjs/core": "0.2.6",
-    "@univerjs/engine-render": "0.2.6",
-    "@univerjs/shared": "0.2.6"
+    "vitest": "^2.0.5",
+    "vue": "^3.4.35",
+    "@univerjs/core": "0.2.7",
+    "@univerjs/design": "0.2.7",
+    "@univerjs/engine-formula": "0.2.7",
+    "@univerjs/engine-render": "0.2.7",
+    "@univerjs/shared": "0.2.7"
   },
@@ -95,0 +95,0 @@ "univerSpace": {

No alert changes

Improved metrics

Total package byte prevSize

1658699

increased by0.62%

Lines of code

15986

increased by0.58%

Dependency changes

• + Added@rc-component/color-picker@2.0.1(transitive)

• + Added@types/lodash@4.17.15(transitive)

• + Added@types/lodash.mergewith@4.6.9(transitive)

• + Added@univerjs/core@0.2.7(transitive)

• + Added@univerjs/design@0.2.7(transitive)

• + Added@univerjs/engine-formula@0.2.7(transitive)

• + Added@univerjs/engine-render@0.2.7(transitive)

• + Added@univerjs/protocol@0.1.38(transitive)

• + Added@univerjs/rpc@0.2.7(transitive)

• + Addedlodash.mergewith@4.6.2(transitive)

• - Removed@rc-component/color-picker@1.9.0(transitive)

• - Removed@univerjs/core@0.2.6(transitive)

• - Removed@univerjs/design@0.2.6(transitive)

• - Removed@univerjs/engine-formula@0.2.6(transitive)

• - Removed@univerjs/engine-render@0.2.6(transitive)

• - Removed@univerjs/protocol@0.1.38-alpha.23(transitive)

• - Removed@univerjs/rpc@0.2.6(transitive)

• Updated@univerjs/icons@^0.1.72