Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
refactor: move some global components to replaceable services (#2270)
Wenzhao Huef6c5fd2a4f6
diff --git a/packages/docs-ui/src/controllers/doc-ui.controller.ts b/packages/docs-ui/src/controllers/doc-ui.controller.tsindex d4fda65409..3de2770e23 100644--- a/packages/docs-ui/src/controllers/doc-ui.controller.ts+++ b/packages/docs-ui/src/controllers/doc-ui.controller.ts@@ -16,8 +16,8 @@import type { DocumentDataModel } from '@univerjs/core';import { Disposable, IUniverInstanceService, LifecycleStages, OnLifecycle, UniverInstanceType } from '@univerjs/core';-import type { IDesktopUIController, IMenuItemFactory } from '@univerjs/ui';-import { ComponentManager, DesktopUIPart, IEditorService, ILayoutService, IMenuService, IUIController } from '@univerjs/ui';+import type { IMenuItemFactory } from '@univerjs/ui';+import { ComponentManager, DesktopUIPart, IEditorService, ILayoutService, IMenuService, IUIPartsService } from '@univerjs/ui';import { Inject, Injector } from '@wendellhu/redi';import { connectInjector } from '@wendellhu/redi/react-bindings';@@ -60,7 +60,7 @@ export class DocUIController extends Disposable {@ILayoutService private readonly _layoutService: ILayoutService,@IEditorService private readonly _editorService: IEditorService,@IMenuService private readonly _menuService: IMenuService,- @IUIController private readonly _uiController: IDesktopUIController,+ @IUIPartsService private readonly _uiPartsService: IUIPartsService,@IUniverInstanceService private readonly _univerInstanceService: IUniverInstanceService) {super();@@ -119,7 +119,7 @@ export class DocUIController extends Disposable {const embedded = this._editorService.isEditor(firstDocUnitId);if (!embedded) {this.disposeWithMe(- this._uiController.registerComponent(DesktopUIPart.CONTENT, () => connectInjector(DocBackground, this._injector))+ this._uiPartsService.registerComponent(DesktopUIPart.CONTENT, () => connectInjector(DocBackground, this._injector)));}}diff --git a/packages/sheets-formula/src/controllers/formula-ui.controller.ts b/packages/sheets-formula/src/controllers/formula-ui.controller.tsindex 0dfe445613..95e138a13c 100644--- a/packages/sheets-formula/src/controllers/formula-ui.controller.ts+++ b/packages/sheets-formula/src/controllers/formula-ui.controller.ts@@ -15,8 +15,7 @@*/import { Disposable, ICommandService, LifecycleStages, OnLifecycle, UniverInstanceType } from '@univerjs/core';-import type { IDesktopUIController } from '@univerjs/ui';-import { ComponentManager, DesktopUIPart, IMenuService, IShortcutService, IUIController } from '@univerjs/ui';+import { ComponentManager, DesktopUIPart, IMenuService, IShortcutService, IUIPartsService } from '@univerjs/ui';import { Inject, Injector } from '@wendellhu/redi';import { connectInjector } from '@wendellhu/redi/react-bindings';@@ -51,7 +50,7 @@ export class FormulaUIController extends Disposable {@IMenuService private readonly _menuService: IMenuService,@ICommandService private readonly _commandService: ICommandService,@IShortcutService private readonly _shortcutService: IShortcutService,- @IUIController private readonly _uiController: IDesktopUIController,+ @IUIPartsService private readonly _uiPartsService: IUIPartsService,@IRenderManagerService private readonly _renderManagerService: IRenderManagerService,@Inject(ComponentManager) private readonly _componentManager: ComponentManager) {@@ -105,7 +104,7 @@ export class FormulaUIController extends Disposable {private _registerComponents(): void {this.disposeWithMe(- this._uiController.registerComponent(DesktopUIPart.CONTENT, () => connectInjector(RenderFormulaPromptContent, this._injector))+ this._uiPartsService.registerComponent(DesktopUIPart.CONTENT, () => connectInjector(RenderFormulaPromptContent, this._injector)));this._componentManager.register(MORE_FUNCTIONS_COMPONENT, MoreFunctions);diff --git a/packages/sheets-ui/src/controllers/sheet-ui.controller.ts b/packages/sheets-ui/src/controllers/sheet-ui.controller.tsindex ce9ed92900..32037f2396 100644--- a/packages/sheets-ui/src/controllers/sheet-ui.controller.ts+++ b/packages/sheets-ui/src/controllers/sheet-ui.controller.ts@@ -23,8 +23,8 @@ import {SetStrikeThroughCommand,SetUnderlineCommand,} from '@univerjs/sheets';-import type { IDesktopUIController, IMenuItemFactory } from '@univerjs/ui';-import { ComponentManager, DesktopUIPart, ILayoutService, IMenuService, IShortcutService, IUIController } from '@univerjs/ui';+import type { IMenuItemFactory } from '@univerjs/ui';+import { ComponentManager, DesktopUIPart, ILayoutService, IMenuService, IShortcutService, IUIPartsService } from '@univerjs/ui';import { Inject, Injector } from '@wendellhu/redi';import { connectInjector } from '@wendellhu/redi/react-bindings';@@ -237,7 +237,7 @@ export class SheetUIController extends Disposable {@ICommandService private readonly _commandService: ICommandService,@IShortcutService private readonly _shortcutService: IShortcutService,@IMenuService private readonly _menuService: IMenuService,- @IUIController private readonly _uiController: IDesktopUIController+ @IUIPartsService private readonly _uiPartsService: IUIPartsService) {super();@@ -467,7 +467,7 @@ export class SheetUIController extends Disposable {}private _initWorkbenchParts(): void {- const uiController = this._uiController;+ const uiController = this._uiPartsService;const injector = this._injector;this.disposeWithMe(uiController.registerComponent(DesktopUIPart.HEADER, () => connectInjector(RenderSheetHeader, injector)));diff --git a/packages/slides-ui/src/controllers/slide-ui.controller.ts b/packages/slides-ui/src/controllers/slide-ui.controller.tsindex 84771ea632..de40219753 100644--- a/packages/slides-ui/src/controllers/slide-ui.controller.ts+++ b/packages/slides-ui/src/controllers/slide-ui.controller.ts@@ -15,8 +15,7 @@*/import { Disposable, ICommandService, LifecycleStages, OnLifecycle } from '@univerjs/core';-import type { IDesktopUIController } from '@univerjs/ui';-import { DesktopUIPart, IUIController } from '@univerjs/ui';+import { DesktopUIPart, IUIPartsService } from '@univerjs/ui';import { Inject, Injector } from '@wendellhu/redi';import { connectInjector } from '@wendellhu/redi/react-bindings';import { SlideSideBar } from '../views/slide-bar/SlideBar';@@ -30,7 +29,7 @@ import { SetSlidePageThumbOperation } from '../commands/operations/setThumb.operexport class SlideUIController extends Disposable {constructor(@Inject(Injector) private readonly _injector: Injector,- @IUIController private readonly _uiController: IDesktopUIController,+ @IUIPartsService private readonly _uiPartsService: IUIPartsService,@ICommandService private readonly _commandService: ICommandService) {super();@@ -48,7 +47,7 @@ export class SlideUIController extends Disposable {private _initUIComponents(): void {this.disposeWithMe(- this._uiController.registerComponent(DesktopUIPart.LEFT_SIDEBAR, () => connectInjector(SlideSideBar, this._injector))+ this._uiPartsService.registerComponent(DesktopUIPart.LEFT_SIDEBAR, () => connectInjector(SlideSideBar, this._injector)));}}diff --git a/packages/ui/src/controllers/ui/ui-desktop.controller.tsx b/packages/ui/src/controllers/ui/ui-desktop.controller.tsxindex 252649f17c..8e8ab4e70c 100644--- a/packages/ui/src/controllers/ui/ui-desktop.controller.tsx+++ b/packages/ui/src/controllers/ui/ui-desktop.controller.tsx@@ -20,39 +20,17 @@ import type { IDisposable } from '@wendellhu/redi';import { Inject, Injector, Optional } from '@wendellhu/redi';import { connectInjector } from '@wendellhu/redi/react-bindings';import { render as createRoot, unmount } from 'rc-util/lib/React/render';-import type { ComponentType } from 'react';import React from 'react';-import type { Observable } from 'rxjs';-import { delay, filter, Subject, take } from 'rxjs';+import { delay, filter, take } from 'rxjs';import { ILayoutService } from '../../services/layout/layout.service';import { App } from '../../views/App';+import { DesktopUIPart, IUIPartsService } from '../../services/parts/parts.service';import type { IWorkbenchOptions } from './ui.controller';-import { IUIController } from './ui.controller';--export enum DesktopUIPart {- HEADER = 'header',- HEADER_MENU = 'header-menu',- CONTENT = 'content',- FOOTER = 'footer',- LEFT_SIDEBAR = 'left-sidebar',-}const STEADY_TIMEOUT = 3000;-export interface IDesktopUIController extends IUIController {- componentRegistered$: Observable<void>;-- registerComponent(part: DesktopUIPart, component: () => ComponentType): IDisposable;- getComponents(part: DesktopUIPart): Set<() => ComponentType>;-}--export class DesktopUIController extends Disposable implements IDesktopUIController {- private _componentsByPart: Map<DesktopUIPart, Set<() => ComponentType>> = new Map();-- private readonly _componentRegistered$ = new Subject<void>();- readonly componentRegistered$ = this._componentRegistered$.asObservable();-+export class DesktopUIController extends Disposable {constructor(@IUniverInstanceService private readonly _instanceService: IUniverInstanceService,@IRenderManagerService private readonly _renderManagerService: IRenderManagerService,@@ -93,26 +71,6 @@ export class DesktopUIController extends Disposable implements IDesktopUIControl}));}-- registerComponent(part: DesktopUIPart, component: () => React.ComponentType): IDisposable {- const components = (- this._componentsByPart.get(part)- || this._componentsByPart.set(part, new Set()).get(part)!- ).add(component);-- this._componentRegistered$.next();-- return toDisposable(() => {- components.delete(component);- if (components.size === 0) {- this._componentsByPart.delete(part);- }- });- }-- getComponents(part: DesktopUIPart): Set<() => ComponentType> {- return new Set([...(this._componentsByPart.get(part) || new Set())]);- }}function bootStrap(@@ -137,15 +95,16 @@ function bootStrap(}const ConnectedApp = connectInjector(App, injector);- const desktopUIController = injector.get(IUIController) as IDesktopUIController;+ const uiPartsService = injector.get(IUIPartsService);const onRendered = (canvasElement: HTMLElement) => callback(canvasElement, mountContainer);function render() {- const headerComponents = desktopUIController.getComponents(DesktopUIPart.HEADER);- const contentComponents = desktopUIController.getComponents(DesktopUIPart.CONTENT);- const footerComponents = desktopUIController.getComponents(DesktopUIPart.FOOTER);- const headerMenuComponents = desktopUIController.getComponents(DesktopUIPart.HEADER_MENU);- const leftSidebarComponents = desktopUIController.getComponents(DesktopUIPart.LEFT_SIDEBAR);+ const headerComponents = uiPartsService.getComponents(DesktopUIPart.HEADER);+ const contentComponents = uiPartsService.getComponents(DesktopUIPart.CONTENT);+ const footerComponents = uiPartsService.getComponents(DesktopUIPart.FOOTER);+ const headerMenuComponents = uiPartsService.getComponents(DesktopUIPart.HEADER_MENU);+ const leftSidebarComponents = uiPartsService.getComponents(DesktopUIPart.LEFT_SIDEBAR);+ const globalComponents = uiPartsService.getComponents(DesktopUIPart.GLOBAL);createRoot(<ConnectedApp@@ -155,6 +114,7 @@ function bootStrap(headerMenuComponents={headerMenuComponents}leftSidebarComponents={leftSidebarComponents}contentComponents={contentComponents}+ globalComponents={globalComponents}onRendered={onRendered}footerComponents={footerComponents}/>,@@ -162,7 +122,7 @@ function bootStrap();}- const updateSubscription = desktopUIController.componentRegistered$.subscribe(render);+ const updateSubscription = uiPartsService.componentRegistered$.subscribe(render);render();return toDisposable(() => {diff --git a/packages/ui/src/index.ts b/packages/ui/src/index.tsindex 30f3ec2e63..c8748cfa33 100644--- a/packages/ui/src/index.ts+++ b/packages/ui/src/index.ts@@ -28,7 +28,8 @@ export {UndoShortcutItem,} from './controllers/shared-shortcut.controller';export { IUIController, type IWorkbenchOptions } from './controllers/ui/ui.controller';-export { DesktopUIController, DesktopUIPart, type IDesktopUIController } from './controllers/ui/ui-desktop.controller';+export { DesktopUIController } from './controllers/ui/ui-desktop.controller';+export { IUIPartsService, DesktopUIPart, DesktopUIPartsService } from './services/parts/parts.service';export { enUS, zhCN, ruRU } from './locale';export { DesktopBeforeCloseService, IBeforeCloseService } from './services/before-close/before-close.service';export { CopyCommand, CutCommand, PasteCommand } from './services/clipboard/clipboard.command';diff --git a/packages/ui/src/services/confirm/desktop-confirm.service.ts b/packages/ui/src/services/confirm/desktop-confirm.service.tsindex 1590ebc227..1ae927402e 100644--- a/packages/ui/src/services/confirm/desktop-confirm.service.ts+++ b/packages/ui/src/services/confirm/desktop-confirm.service.ts@@ -14,17 +14,29 @@* limitations under the License.*/-import { toDisposable } from '@univerjs/core';-import type { IDisposable } from '@wendellhu/redi';+import { Disposable, toDisposable } from '@univerjs/core';+import { type IDisposable, Inject, Injector } from '@wendellhu/redi';import { Subject } from 'rxjs';+import { connectInjector } from '@wendellhu/redi/react-bindings';import type { IConfirmPartMethodOptions } from '../../views/components/confirm-part/interface';+import { DesktopUIPart, IUIPartsService } from '../parts/parts.service';+import { ConfirmPart } from '../../views/components/confirm-part/ConfirmPart';import type { IConfirmService } from './confirm.service';-export class DesktopConfirmService implements IConfirmService {+export class DesktopConfirmService extends Disposable implements IConfirmService {private _confirmOptions: IConfirmPartMethodOptions[] = [];readonly confirmOptions$ = new Subject<IConfirmPartMethodOptions[]>();+ constructor(+ @Inject(Injector) protected readonly _injector: Injector,+ @IUIPartsService protected readonly _uiPartsService: IUIPartsService+ ) {+ super();++ this._initUIPart();+ }+open(option: IConfirmPartMethodOptions): IDisposable {if (this._confirmOptions.find((item) => item.id === option.id)) {this._confirmOptions = this._confirmOptions.map((item) => ({@@ -68,4 +80,10 @@ export class DesktopConfirmService implements IConfirmService {}));this.confirmOptions$.next([...this._confirmOptions]);}++ protected _initUIPart(): void {+ this.disposeWithMe(+ this._uiPartsService.registerComponent(DesktopUIPart.GLOBAL, () => connectInjector(ConfirmPart, this._injector))+ );+ }}diff --git a/packages/ui/src/services/dialog/desktop-dialog.service.ts b/packages/ui/src/services/dialog/desktop-dialog.service.tsindex 8f84bd5384..ddc716d2e8 100644--- a/packages/ui/src/services/dialog/desktop-dialog.service.ts+++ b/packages/ui/src/services/dialog/desktop-dialog.service.ts@@ -15,16 +15,28 @@*/import { Disposable, toDisposable } from '@univerjs/core';-import type { IDisposable } from '@wendellhu/redi';+import { type IDisposable, Inject, Injector } from '@wendellhu/redi';import { Subject } from 'rxjs';+import { connectInjector } from '@wendellhu/redi/react-bindings';import type { IDialogPartMethodOptions } from '../../views/components/dialog-part/interface';+import { DesktopUIPart, IUIPartsService } from '../parts/parts.service';+import { DialogPart } from '../../views/components/dialog-part/DialogPart';import type { IDialogService } from './dialog.service';export class DesktopDialogService extends Disposable implements IDialogService {protected _dialogOptions: IDialogPartMethodOptions[] = [];protected readonly _dialogOptions$ = new Subject<IDialogPartMethodOptions[]>();+ constructor(+ @Inject(Injector) protected readonly _injector: Injector,+ @IUIPartsService protected readonly _uiPartsService: IUIPartsService+ ) {+ super();++ this._initUIPart();+ }+override dispose(): void {super.dispose();@@ -64,4 +76,10 @@ export class DesktopDialogService extends Disposable implements IDialogService {getDialogs$() {return this._dialogOptions$.asObservable();}++ protected _initUIPart(): void {+ this.disposeWithMe(+ this._uiPartsService.registerComponent(DesktopUIPart.GLOBAL, () => connectInjector(DialogPart, this._injector))+ );+ }}diff --git a/packages/ui/src/services/notification/desktop-notification.service.ts b/packages/ui/src/services/notification/desktop-notification.service.tsindex b64c34a4f5..2ba10ceaf1 100644--- a/packages/ui/src/services/notification/desktop-notification.service.ts+++ b/packages/ui/src/services/notification/desktop-notification.service.ts@@ -14,17 +14,32 @@* limitations under the License.*/-import { toDisposable } from '@univerjs/core';-import type { IDisposable } from '@wendellhu/redi';+import { Disposable, toDisposable } from '@univerjs/core';+import { type IDisposable, Inject, Injector } from '@wendellhu/redi';+import { connectInjector } from '@wendellhu/redi/react-bindings';import type { INotificationMethodOptions } from '../../components/notification/Notification';-import { notification } from '../../components/notification/Notification';+import { notification, Notification } from '../../components/notification/Notification';+import { DesktopUIPart, IUIPartsService } from '../parts/parts.service';import type { INotificationService } from './notification.service';-export class DesktopNotificationService implements INotificationService {+export class DesktopNotificationService extends Disposable implements INotificationService {+ constructor(+ @Inject(Injector) private readonly _injector: Injector,+ @IUIPartsService private readonly _uiPartsService: IUIPartsService+ ) {+ super();++ this._initUIPart();+ }+show(params: INotificationMethodOptions): IDisposable {notification.show(params);return toDisposable(() => { /* empty */ });}++ protected _initUIPart(): void {+ this.disposeWithMe(this._uiPartsService.registerComponent(DesktopUIPart.GLOBAL, () => connectInjector(Notification, this._injector)));+ }}diff --git a/packages/ui/src/services/parts/parts.service.ts b/packages/ui/src/services/parts/parts.service.tsnew file mode 100644index 0000000000..42cc0c813c--- /dev/null+++ b/packages/ui/src/services/parts/parts.service.ts@@ -0,0 +1,66 @@+/**+ * Copyright 2023-present DreamNum Inc.+ *+ * 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 { IDisposable } from '@wendellhu/redi';+import { createIdentifier } from '@wendellhu/redi';+import { type Observable, Subject } from 'rxjs';+import { toDisposable } from '@univerjs/core';+import type { ComponentType } from '../../common/component-manager';++export enum DesktopUIPart {+ GLOBAL = 'global',+ HEADER = 'header',+ HEADER_MENU = 'header-menu',+ CONTENT = 'content',+ FOOTER = 'footer',+ LEFT_SIDEBAR = 'left-sidebar',+}++export interface IUIPartsService {+ componentRegistered$: Observable<void>;++ registerComponent(part: DesktopUIPart, component: () => ComponentType): IDisposable;+ getComponents(part: DesktopUIPart): Set<() => ComponentType>;+}++export const IUIPartsService = createIdentifier<IUIPartsService>('ui.parts.service');++export class DesktopUIPartsService implements IUIPartsService {+ private _componentsByPart: Map<DesktopUIPart, Set<() => ComponentType>> = new Map();++ private readonly _componentRegistered$ = new Subject<void>();+ readonly componentRegistered$ = this._componentRegistered$.asObservable();++ registerComponent(part: DesktopUIPart, component: () => React.ComponentType): IDisposable {+ const components = (+ this._componentsByPart.get(part)+ || this._componentsByPart.set(part, new Set()).get(part)!+ ).add(component);++ this._componentRegistered$.next();++ return toDisposable(() => {+ components.delete(component);+ if (components.size === 0) {+ this._componentsByPart.delete(part);+ }+ });+ }++ getComponents(part: DesktopUIPart): Set<() => ComponentType> {+ return new Set([...(this._componentsByPart.get(part) || new Set())]);+ }+}diff --git a/packages/ui/src/ui-plugin.ts b/packages/ui/src/ui-plugin.tsindex 83f5b1309a..63bc78c3a3 100644--- a/packages/ui/src/ui-plugin.ts+++ b/packages/ui/src/ui-plugin.ts@@ -55,6 +55,7 @@ import { IZenZoneService } from './services/zen-zone/zen-zone.service';import { EditorService, IEditorService } from './services/editor/editor.service';import { IRangeSelectorService, RangeSelectorService } from './services/range-selector/range-selector.service';import { IProgressService, ProgressService } from './services/progress/progress.service';+import { DesktopUIPartsService, IUIPartsService } from './services/parts/parts.service';const PLUGIN_NAME = 'ui';@@ -101,6 +102,7 @@ export class UniverUIPlugin extends Plugin {// services[ShortcutPanelService],+ [IUIPartsService, { useClass: DesktopUIPartsService }],[ILayoutService, { useClass: DesktopLayoutService }],[IShortcutService, { useClass: DesktopShortcutService }],[IPlatformService, { useClass: DesktopPlatformService }],diff --git a/packages/ui/src/views/App.tsx b/packages/ui/src/views/App.tsxindex 98df9efaca..2416ebad70 100644--- a/packages/ui/src/views/App.tsx+++ b/packages/ui/src/views/App.tsx@@ -27,21 +27,35 @@ import { ComponentContainer } from './components/ComponentContainer';import { Toolbar } from './components/doc-bars/Toolbar';import { Sidebar } from './components/sidebar/Sidebar';import { ZenZone } from './components/zen-zone/ZenZone';-import { globalComponents } from './parts';import { CanvasPopup } from './components/popup';+import { builtInGlobalComponents } from './parts';export interface IUniverAppProps extends IWorkbenchOptions {mountContainer: HTMLElement;++ globalComponents?: Set<() => ComponentType>;headerComponents?: Set<() => ComponentType>;contentComponents?: Set<() => ComponentType>;footerComponents?: Set<() => ComponentType>;headerMenuComponents?: Set<() => ComponentType>;leftSidebarComponents?: Set<() => ComponentType>;+onRendered?: (container: HTMLElement) => void;}export function App(props: IUniverAppProps) {- const { header, footer, mountContainer, headerComponents, headerMenuComponents, contentComponents, footerComponents, leftSidebarComponents, onRendered } = props;+ const {+ header,+ footer,+ mountContainer,+ headerComponents,+ headerMenuComponents,+ contentComponents,+ footerComponents,+ leftSidebarComponents,+ globalComponents,+ onRendered,+ } = props;const localeService = useDependency(LocaleService);const themeService = useDependency(ThemeService);@@ -144,6 +158,7 @@ export function App(props: IUniverAppProps) {</div><ComponentContainer components={globalComponents} />+ <ComponentContainer components={builtInGlobalComponents} /></ConfigProvider>);}diff --git a/packages/ui/src/views/parts.ts b/packages/ui/src/views/parts.tsindex 87aff8a047..a91b2a436d 100644--- a/packages/ui/src/views/parts.ts+++ b/packages/ui/src/views/parts.ts@@ -16,16 +16,10 @@import type { ComponentType } from 'react';-import { Notification } from '../components/notification/Notification';-import { ConfirmPart } from './components/confirm-part/ConfirmPart';import { ContextMenu } from './components/context-menu/ContextMenu';-import { DialogPart } from './components/dialog-part/DialogPart';import { GlobalZone } from './components/global-zone/GlobalZone';-export const globalComponents: Set<() => ComponentType> = new Set([- () => DialogPart,- () => ConfirmPart,- () => Notification,+export const builtInGlobalComponents: Set<() => ComponentType> = new Set([() => ContextMenu,() => GlobalZone,]);