@univerjs/ui 0.2.6 → 0.2.7

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

@@ -7,11 +7,12 @@ export interface ITextEditorProps {
     id: string;
     className?: string;
     snapshot?: IDocumentData;
+    value?: string;
     resizeCallBack?: (editor: Nullable<HTMLDivElement>) => void;
     cancelDefaultResizeListener?: boolean;
-    isSheetEditor?: boolean;
     canvasStyle?: IEditorCanvasStyle;
-    value?: string;
+    isSheetEditor?: boolean;
+    isFormulaEditor?: boolean;
     isSingle?: boolean;
     isReadonly?: boolean;
     onlyInputFormula?: boolean;

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

@@ -5,6 +5,7 @@ type ObservableOrFn<T> = Observable<T> | (() => Observable<T>);
 export declare function useObservable<T>(observable: ObservableOrFn<T>, defaultValue: T | undefined, shouldHaveSyncValue?: true): T;
 export declare function useObservable<T>(observable: Nullable<ObservableOrFn<T>>, defaultValue: T): T;
 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 {};

package/lib/types/index.d.ts

@@ -46,7 +46,7 @@ export { IGlobalZoneService } from './services/global-zone/global-zone.service';
 export { KeyCode, MetaKeys } from './services/shortcut/keycode';
 export { ShortcutService, type IShortcutItem, IShortcutService } from './services/shortcut/shortcut.service';
 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';
 export { UniverUIPlugin, DISABLE_AUTO_FOCUS_KEY } from './ui-plugin';
 export { UniverMobileUIPlugin } from './mobile-ui-plugin';
@@ -54,7 +54,7 @@ export * from './utils';
 export { Menu } from './components/menu/desktop/Menu';
 export { type IConfirmPartMethodOptions } from './views/components/confirm-part/interface';
 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';
 export { RangeSelector } from './components/range-selector/RangeSelector';
 export { ProgressBar } from './components/progress-bar/ProgressBar';
@@ -74,11 +74,14 @@ export { GlobalZone } from './views/components/global-zone/GlobalZone';
 export { builtInGlobalComponents } from './views/parts';
 export { DesktopContextMenu as ContextMenu } from './views/components/context-menu/ContextMenu';
 export { Sidebar } from './views/components/sidebar/Sidebar';
+export { type ISidebarMethodOptions } from './views/components/sidebar/interface';
 export { ZenZone } from './views/components/zen-zone/ZenZone';
 export { CanvasPopup } from './views/components/popup/CanvasPopup';
 export { CanvasFloatDomService, type IFloatDomLayout } from './services/dom/canvas-dom-layer.service';
 export { FloatDom } from './views/components/dom/FloatDom';
 export { MobileContextMenu } from './views/components/context-menu/MobileContextMenu';
 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';

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

@@ -1,6 +1,6 @@
 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';
 
 export interface IEditorStateParam extends Partial<IPosition> {
@@ -15,6 +15,11 @@ export interface IEditorConfigParam {
     cancelDefaultResizeListener?: boolean;
     canvasStyle?: IEditorCanvasStyle;
     isSheetEditor: boolean;
+    /**
+     * If the editor is for formula editing.
+     * @deprecated this is a temp fix before refactoring editor.
+     */
+    isFormulaEditor: boolean;
     isSingle: boolean;
     isReadonly: boolean;
     onlyInputFormula: boolean;
@@ -65,6 +70,8 @@ export declare class Editor {
     getBoundingClientRect(): DOMRect;
     isVisible(): boolean | undefined;
     isSheetEditor(): boolean;
+    /** @deprecated */
+    isFormulaEditor(): boolean;
     getValue(): string;
     getBody(): IDocumentBody | undefined;
     update(param: Partial<IEditorSetParam>): void;
@@ -98,7 +105,7 @@ export interface IEditorService {
     closeRangePrompt(): void;
     blur$: Observable<unknown>;
     blur(): void;
-    focus$: Observable<ISuccinctTextRangeParam>;
+    focus$: Observable<ISuccinctDocRangeParam>;
     focus(editorUnitId?: string): void;
     setValue$: Observable<IEditorSetValueParam>;
     valueChange$: Observable<Readonly<Editor>>;
@@ -141,7 +148,7 @@ export declare class EditorService extends Disposable implements IEditorService,
     private readonly _blur$;
     readonly blur$: Observable<unknown>;
     private readonly _focus$;
-    readonly focus$: Observable<ISuccinctTextRangeParam>;
+    readonly focus$: Observable<ISuccinctDocRangeParam>;
     private readonly _setValue$;
     readonly setValue$: Observable<IEditorSetValueParam>;
     private readonly _valueChange$;
@@ -187,7 +194,6 @@ export declare class EditorService extends Disposable implements IEditorService,
     checkValueLegality(editorUnitId: string): boolean;
     private _refreshValueChange;
     private _getCurrentEditorUnitId;
-    private _refresh;
     private _getBlank;
 }
 export declare const IEditorService: import('@univerjs/core').IdentifierDecorator<IEditorService>;

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

@@ -12,13 +12,13 @@ export interface ILayoutService {
     registerFocusHandler(type: UniverInstanceType, handler: FocusHandlerFn): IDisposable;
     /** Register the root container element. */
     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;
 }
 export declare const ILayoutService: import('@univerjs/core').IdentifierDecorator<ILayoutService>;
 /**
@@ -33,18 +33,18 @@ export declare class DesktopLayoutService extends Disposable implements ILayoutS
     private _isFocused;
     get isFocused(): boolean;
     private readonly _focusHandlers;
-    private _canvasContainers;
+    private _contentElements;
     private _allContainers;
     constructor(_contextService: ContextService, _univerInstanceService: IUniverInstanceService, _editorService: IEditorService);
     get rootContainerElement(): Nullable<HTMLElement>;
     focus(): void;
     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;
     private _initEditorStatus;
     private _blurSheetEditor;

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

@@ -38,6 +38,11 @@ export declare enum MenuItemType {
 interface IMenuItemBase<V> {
     /** ID of the menu item. Normally it should be the same as the ID of the command that it would invoke.  */
     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;
     title?: string;
     description?: string;
@@ -66,6 +71,7 @@ export interface IMenuButtonItem<V = undefined> extends IMenuItemBase<V> {
     activated$?: Observable<boolean>;
 }
 export interface IValueOption<T = undefined> {
+    id?: string;
     value?: string | number;
     value$?: Observable<T>;
     label?: string | {
@@ -79,7 +85,7 @@ export interface IValueOption<T = undefined> {
     tooltip?: string;
     style?: object;
     disabled?: boolean;
-    id?: string;
+    commandId?: string;
 }
 export interface ICustomComponentProps<T> {
     value: T;

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

@@ -2,6 +2,7 @@ import { Disposable, ICommandService, IContextService, IDisposable } from '@univ
 import { Observable } from 'rxjs';
 import { ILayoutService } from '../layout/layout.service';
 import { IPlatformService } from '../platform/platform.service';
+import { KeyCode } from './keycode';
 
 export interface IShortcutItem<P extends object = object> {
     /** This should reuse the corresponding command's id. */
@@ -13,7 +14,7 @@ export interface IShortcutItem<P extends object = object> {
     /** A callback that will be triggered to examine if the shortcut should be invoked. */
     preconditions?: (contextService: IContextService) => boolean;
     /** A command can be bound to several bindings, with different static parameters perhaps. */
-    binding: number;
+    binding: KeyCode | number;
     mac?: number;
     win?: number;
     linux?: number;

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

@@ -7,6 +7,8 @@ export declare class DesktopSidebarService implements ISidebarService {
     private _sidebarOptions;
     readonly sidebarOptions$: Subject<ISidebarMethodOptions>;
     readonly scrollEvent$: Subject<Event>;
+    get visible(): boolean;
+    get options(): ISidebarMethodOptions;
     open(params: ISidebarMethodOptions): IDisposable;
-    close(): void;
+    close(id?: string): void;
 }

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

@@ -2,10 +2,13 @@ import { IDisposable } from '@univerjs/core';
 import { Subject } from 'rxjs';
 import { ISidebarMethodOptions } from '../../views/components/sidebar/interface';
 
-export declare const ISidebarService: import('@univerjs/core').IdentifierDecorator<ISidebarService>;
 export interface ISidebarService {
     readonly sidebarOptions$: Subject<ISidebarMethodOptions>;
     readonly scrollEvent$: Subject<Event>;
     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>;

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

@@ -20,7 +20,7 @@ export interface IToolbarRenderHookHandler {
  * you can use this hook to get the toolbar status.
  * @returns toolbar status
  */
-export declare function useToolbarGroups(categories: MenuPositionWithCustom[]): IToolbarRenderHookHandler;
+export declare function useToolbarGroups(categories: MenuPositionWithCustom[], initCategory?: string): IToolbarRenderHookHandler;
 export interface IToolbarItemStatus {
     disabled: boolean;
     value: any;

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

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

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

@@ -3,6 +3,6 @@ import { IWorkbenchOptions } from '../../controllers/ui/ui.controller';
 
 export interface IUniverWorkbenchProps extends IWorkbenchOptions {
     mountContainer: HTMLElement;
-    onRendered?: (container: HTMLElement) => void;
+    onRendered?: (containerElement: HTMLElement) => void;
 }
 export declare function DesktopWorkbench(props: IUniverWorkbenchProps): React.JSX.Element;