Skip to content

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.

feat(ui): add more facade (#4291)

Wenzhao Hu3254073688bd
diff --git a/packages/sheets-ui/src/facade/f-sheet-hooks.ts b/packages/sheets-ui/src/facade/f-sheet-hooks.ts
index 8c22454825..a7418959af 100644
--- a/packages/sheets-ui/src/facade/f-sheet-hooks.ts
+++ b/packages/sheets-ui/src/facade/f-sheet-hooks.ts
@@ -18,8 +18,8 @@ import type { ICellCustomRender, IDisposable, Nullable } from '@univerjs/core';
import type { IDragCellPosition, IEditorBridgeServiceVisibleParam, IHoverCellPosition } from '@univerjs/sheets-ui';
import { ICommandService, InterceptorEffectEnum, toDisposable } from '@univerjs/core';
import { InterceptCellContentPriority, INTERCEPTOR_POINT, SheetInterceptorService } from '@univerjs/sheets';
-import { FSheetHooks } from '@univerjs/sheets/facade';
import { DragManagerService, HoverManagerService, SetCellEditVisibleOperation } from '@univerjs/sheets-ui';
+import { FSheetHooks } from '@univerjs/sheets/facade';
export interface IFSheetHooksUIMixin {
/**
@@ -129,5 +129,5 @@ export class FSheetHooksUIMixin extends FSheetHooks implements IFSheetHooksUIMix
FSheetHooks.extend(FSheetHooksUIMixin);
declare module '@univerjs/sheets/facade' {
// eslint-disable-next-line ts/naming-convention
- interface FSheetHooks extends IFSheetHooksUIMixin {}
+ interface FSheetHooks extends IFSheetHooksUIMixin { }
}
diff --git a/packages/sheets/src/facade/f-univer.ts b/packages/sheets/src/facade/f-univer.ts
index 2e5ac111be..587576e173 100644
--- a/packages/sheets/src/facade/f-univer.ts
+++ b/packages/sheets/src/facade/f-univer.ts
@@ -14,8 +14,8 @@
* limitations under the License.
*/
-import type { IWorkbookData, Workbook } from '@univerjs/core';
-import { FUniver, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
+import type { IDisposable, IWorkbookData, Workbook } from '@univerjs/core';
+import { FUniver, IUniverInstanceService, toDisposable, UniverInstanceType } from '@univerjs/core';
import { FPermission } from './f-permission';
import { FWorkbook } from './f-workbook';
@@ -47,6 +47,10 @@ export interface IFUniverSheetsMixin {
* @returns {FPermission} - The PermissionInstance.
*/
getPermission(): FPermission;
+ /**
+ * Register a callback that will be triggered when a Univer Sheet is created.
+ */
+ onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
}
export class FUniverSheetsMixin extends FUniver implements IFUniverSheetsMixin {
@@ -77,6 +81,15 @@ export class FUniverSheetsMixin extends FUniver implements IFUniverSheetsMixin {
override getPermission(): FPermission {
return this._injector.createInstance(FPermission);
}
+
+ override onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable {
+ const subscription = this._univerInstanceService.getTypeOfUnitAdded$<Workbook>(UniverInstanceType.UNIVER_SHEET).subscribe((workbook) => {
+ const fworkbook = this._injector.createInstance(FWorkbook, workbook);
+ callback(fworkbook);
+ });
+
+ return toDisposable(subscription);
+ }
}
FUniver.extend(FUniverSheetsMixin);
diff --git a/packages/ui/src/controllers/ui/ui.controller.ts b/packages/ui/src/controllers/ui/ui.controller.ts
index 276aea2357..cd30e241b2 100644
--- a/packages/ui/src/controllers/ui/ui.controller.ts
+++ b/packages/ui/src/controllers/ui/ui.controller.ts
@@ -19,11 +19,26 @@ import { createIdentifier } from '@univerjs/core';
export interface IWorkbenchOptions {
container?: string | HTMLElement;
+ /**
+ * If Univer should make the header bar visible.
+ */
header?: boolean;
+
+ /**
+ * If Univer should make the toolbar bar visible.
+ */
toolbar?: boolean;
+
+ /**
+ * If Univer should make the footer bar visible.
+ */
footer?: boolean;
+
+ /**
+ * If Univer should make the context menu usable.
+ */
contextMenu?: boolean;
}
-export interface IUIController {}
+export interface IUIController { }
export const IUIController = createIdentifier<IUIController>('univer.ui.ui-controller');
diff --git a/packages/ui/src/facade/f-univer.ts b/packages/ui/src/facade/f-univer.ts
index ff37c88396..6517b19cfb 100644
--- a/packages/ui/src/facade/f-univer.ts
+++ b/packages/ui/src/facade/f-univer.ts
@@ -15,21 +15,38 @@
*/
import type { IDisposable } from '@univerjs/core';
+import type { IMessageOptions } from '@univerjs/design';
import type { IDialogPartMethodOptions, ISidebarMethodOptions } from '@univerjs/ui';
import { FUniver } from '@univerjs/core';
-import { ComponentManager, CopyCommand, IDialogService, ISidebarService, PasteCommand } from '@univerjs/ui';
+import { ComponentManager, CopyCommand, IDialogService, IMessageService, ISidebarService, PasteCommand } from '@univerjs/ui';
export interface IFUniverUIMixin {
+ /**
+ * Copy the current selected content of the currently focused unit into your system clipboard.
+ */
copy(): Promise<boolean>;
+ /**
+ * Paste into the current selected position of the currently focused unit from your system clipboard.
+ */
paste(): Promise<boolean>;
/**
* Open a sidebar.
+ *
+ * @deprecated Please use `openSidebar` instead.
* @param params the sidebar options
* @returns the disposable object
*/
openSiderbar(params: ISidebarMethodOptions): IDisposable;
+ /**
+ * Open a sidebar.
+ *
+ * @deprecated Please use `openSidebar` instead.
+ * @param params the sidebar options
+ * @returns the disposable object
+ */
+ openSidebar(params: ISidebarMethodOptions): IDisposable;
/**
* Open a dialog.
@@ -43,6 +60,18 @@ export interface IFUniverUIMixin {
* @returns The component manager
*/
getComponentManager(): ComponentManager;
+
+ /**
+ * Show a message.
+ *
+ * @example
+ * ```ts
+ * const message = univerAPI.showMessage({ key: 'my-message', content: 'Warning', duration: 0 });
+ *
+ * someAction().then(() => message.dispose());
+ * ```
+ */
+ showMessage(options: IMessageOptions): IDisposable;
}
export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
@@ -59,6 +88,10 @@ export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
return sideBarService.open(params);
}
+ override openSidebar(params: ISidebarMethodOptions): IDisposable {
+ return this.openSiderbar(params);
+ }
+
override openDialog(dialog: IDialogPartMethodOptions): IDisposable {
const dialogService = this._injector.get(IDialogService);
const disposable = dialogService.open({
@@ -73,10 +106,15 @@ export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
override getComponentManager(): ComponentManager {
return this._injector.get(ComponentManager);
}
+
+ override showMessage(options: IMessageOptions): IDisposable {
+ const messageService = this._injector.get(IMessageService);
+ return messageService.show(options);
+ }
}
FUniver.extend(FUniverUIMixin);
declare module '@univerjs/core' {
// eslint-disable-next-line ts/naming-convention
- interface FUniver extends IFUniverUIMixin {}
+ interface FUniver extends IFUniverUIMixin { }
}