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.

fix(facade): hidden mixin in ui & data-validation & thread-comment (#4554)

zhangw99127d759f47
diff --git a/packages/core/src/facade/f-univer.ts b/packages/core/src/facade/f-univer.ts
index 33244e8a04..ab35dcf0e8 100644
--- a/packages/core/src/facade/f-univer.ts
+++ b/packages/core/src/facade/f-univer.ts
@@ -295,8 +295,8 @@ export class FUniver extends FBaseInitialable {
/**
* Add an event listener
- * @param event key of event
- * @param callback callback when event triggered
+ * @param {string} event key of event
+ * @param {(params: IEventParamConfig[typeof event]) => void} callback callback when event triggered
* @returns {Disposable} The Disposable instance, for remove the listener
* @example
* ```ts
@@ -312,8 +312,8 @@ export class FUniver extends FBaseInitialable {
/**
* Fire an event, used in internal only.
- * @param event {string} key of event
- * @param params {any} params of event
+ * @param {string} event key of event
+ * @param {any} params params of event
* @returns {boolean} should cancel
* @example
* ```ts
@@ -330,7 +330,7 @@ export class FUniver extends FBaseInitialable {
/**
* Get the callback map corresponding to the event
- * @param event
+ * @param {keyof IEventParamConfig} event
* @returns {number} The number of callbacks
*/
protected hasEventCallback(event: keyof IEventParamConfig): boolean {
@@ -368,7 +368,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new rich text.
- * @param data
+ * @param {IDocumentData} data
* @returns {RichTextBuilder} The new rich text instance
* @example
* ```ts
@@ -381,7 +381,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new rich text value.
- * @param data - The rich text data
+ * @param {IDocumentData} data - The rich text data
* @returns {RichTextValue} The new rich text value instance
* @example
* ```ts
@@ -394,7 +394,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new paragraph style.
- * @param style - The paragraph style
+ * @param {IParagraphStyle} style - The paragraph style
* @returns {ParagraphStyleBuilder} The new paragraph style instance
* @example
* ```ts
@@ -407,7 +407,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new paragraph style value.
- * @param style - The paragraph style
+ * @param {IParagraphStyle} style - The paragraph style
* @returns {ParagraphStyleValue} The new paragraph style value instance
* @example
* ```ts
@@ -420,7 +420,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new text style.
- * @param style - The text style
+ * @param {ITextStyle} style - The text style
* @returns {TextStyleBuilder} The new text style instance
* @example
* ```ts
@@ -433,7 +433,7 @@ export class FUniver extends FBaseInitialable {
/**
* Create a new text style value.
- * @param style - The text style
+ * @param {ITextStyle} style - The text style
* @returns {TextStyleValue} The new text style value instance
* @example
* ```ts
@@ -444,6 +444,15 @@ export class FUniver extends FBaseInitialable {
return TextStyleValue.create(style);
}
+ /**
+ * Create a new text decoration.
+ * @param {ITextDecoration} decoration - The text decoration
+ * @returns {TextDecorationBuilder} The new text decoration instance
+ * @example
+ * ```ts
+ * const decoration = univerApi.newTextDecoration();
+ * ```
+ */
newTextDecoration(decoration?: ITextDecoration): TextDecorationBuilder {
return new TextDecorationBuilder(decoration);
}
diff --git a/packages/sheets-crosshair-highlight/src/facade/f-univer.ts b/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
index be67a3adb8..82cb5dbf8b 100644
--- a/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
+++ b/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
@@ -20,6 +20,9 @@ import type { FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
import { FUniver, ICommandService } from '@univerjs/core';
import { CROSSHAIR_HIGHLIGHT_COLORS, DisableCrosshairHighlightOperation, EnableCrosshairHighlightOperation, SetCrosshairHighlightColorOperation, SheetsCrosshairHighlightService } from '@univerjs/sheets-crosshair-highlight';
+/**
+ * @ignore
+ */
export interface IFSheetCrosshairHighlightEventMixin {
/**
* Triggered when the crosshair highlight is enabled or disabled.
@@ -77,6 +80,9 @@ export interface ICrosshairHighlightColorChangedEvent extends IEventBase {
worksheet: FWorksheet;
}
+/**
+ * @ignore
+ */
export class FSheetCrosshairHighlightEventMixin implements IFSheetCrosshairHighlightEventMixin {
get CrosshairHighlightEnabledChanged(): 'CrosshairHighlightEnabledChanged' {
return 'CrosshairHighlightEnabledChanged';
@@ -87,11 +93,17 @@ export class FSheetCrosshairHighlightEventMixin implements IFSheetCrosshairHighl
}
}
+/**
+ * @ignore
+ */
export interface ISheetCrosshairHighlightEventConfigs {
CrosshairHighlightEnabledChanged: ICrosshairHighlightEnabledChangedEvent;
CrosshairHighlightColorChanged: ICrosshairHighlightColorChangedEvent;
}
+/**
+ * @ignore
+ */
export interface IFUniverCrosshairHighlightMixin {
/**
* Enable or disable crosshair highlight.
@@ -141,6 +153,9 @@ export interface IFUniverCrosshairHighlightMixin {
readonly CROSSHAIR_HIGHLIGHT_COLORS: string[];
}
+/**
+ * @ignore
+ */
export class FUniverCrosshairHighlightMixin extends FUniver implements IFUniverCrosshairHighlightMixin {
/**
* @ignore
diff --git a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
index 829071d9fe..cab2ca7762 100644
--- a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
+++ b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
@@ -21,12 +21,12 @@ import { serializeRangeToRefString } from '@univerjs/engine-formula';
import { FDataValidation } from './f-data-validation';
/**
- * Builder for data validation rules.
+ * Builder for data validation rules. use {@link FUniver} `univerAPI.newDataValidation()` to create a new builder.
* @example
* ```typescript
* // Set the data validation for cell A1 to require a value from B1:B10
* const range = FRange.create('Sheet1', 'B1:B10');
- * const rule = FUniver.newDataValidation().requireValueInRange(range).build();
+ * const rule = univerAPI.newDataValidation().requireValueInRange(range).build();
* cell.setDataValidation(rule);
* ```
* @hideconstructor
diff --git a/packages/sheets-data-validation/src/facade/f-event.ts b/packages/sheets-data-validation/src/facade/f-event.ts
index 94ebfcf505..bb89b6bcaa 100644
--- a/packages/sheets-data-validation/src/facade/f-event.ts
+++ b/packages/sheets-data-validation/src/facade/f-event.ts
@@ -158,6 +158,9 @@ export interface IBeforeSheetDataValidationDeleteAllEvent extends IEventBase {
rules: FDataValidation[];
}
+/**
+ * @ignore
+ */
export interface IDataValidationEventParamConfig {
SheetDataValidationChanged: ISheetDataValidationChangedEvent;
SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;
@@ -169,6 +172,9 @@ export interface IDataValidationEventParamConfig {
BeforeSheetDataValidationOptionsUpdate: IBeforeSheetDataValidationOptionsUpdateEvent;
}
+/**
+ * @ignore
+ */
interface IDataValidationEvent {
/**
* Event fired when a rule is added, deleted, or modified
@@ -268,6 +274,9 @@ interface IDataValidationEvent {
readonly BeforeSheetDataValidationOptionsUpdate: 'BeforeSheetDataValidationOptionsUpdate';
}
+/**
+ * @ignore
+ */
export class FDataValidationEvent implements IDataValidationEvent {
get SheetDataValidationChanged(): 'SheetDataValidationChanged' {
return 'SheetDataValidationChanged';
@@ -302,6 +311,9 @@ export class FDataValidationEvent implements IDataValidationEvent {
}
}
+/**
+ * @ignore
+ */
export interface IDataValidationEventConfig {
SheetDataValidationChanged: ISheetDataValidationChangedEvent;
SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;
diff --git a/packages/sheets-data-validation/src/facade/f-range.ts b/packages/sheets-data-validation/src/facade/f-range.ts
index 27fd6d8d3a..13ab364729 100644
--- a/packages/sheets-data-validation/src/facade/f-range.ts
+++ b/packages/sheets-data-validation/src/facade/f-range.ts
@@ -20,6 +20,9 @@ import { AddSheetDataValidationCommand, ClearRangeDataValidationCommand, SheetsD
import { FRange } from '@univerjs/sheets/facade';
import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
export interface IFRangeDataValidationMixin {
/**
* Set a data validation rule to current range. if rule is null, clear data validation rule.
@@ -68,6 +71,9 @@ export interface IFRangeDataValidationMixin {
getValidatorStatus(): Promise<DataValidationStatus[][]>;
}
+/**
+ * @ignore
+ */
export class FRangeDataValidationMixin extends FRange implements IFRangeDataValidationMixin {
override setDataValidation(rule: Nullable<FDataValidation>): FRange {
if (!rule) {
diff --git a/packages/sheets-data-validation/src/facade/f-univer.ts b/packages/sheets-data-validation/src/facade/f-univer.ts
index 7a61e4296e..622745d74d 100644
--- a/packages/sheets-data-validation/src/facade/f-univer.ts
+++ b/packages/sheets-data-validation/src/facade/f-univer.ts
@@ -22,9 +22,10 @@ import { AddSheetDataValidationCommand, RemoveSheetAllDataValidationCommand, Rem
import { FDataValidation } from './f-data-validation';
import { FDataValidationBuilder } from './f-data-validation-builder';
+/**
+ * @ignore
+ */
export class FUnvierDataValidationMixin extends FUniver {
- // eslint-disable-next-line jsdoc/require-returns
- /**
/**
* @deprecated use `univerAPI.newDataValidation()` as instead.
*/
diff --git a/packages/sheets-data-validation/src/facade/f-workbook.ts b/packages/sheets-data-validation/src/facade/f-workbook.ts
index 6ff8e1c717..e9cba4b7f6 100644
--- a/packages/sheets-data-validation/src/facade/f-workbook.ts
+++ b/packages/sheets-data-validation/src/facade/f-workbook.ts
@@ -39,6 +39,9 @@ import {
import { FWorkbook } from '@univerjs/sheets/facade';
import { filter } from 'rxjs';
+/**
+ * @ignore
+ */
export interface IFWorkbookDataValidationMixin {
/**
* Get data validation validator status for current workbook.
@@ -112,6 +115,9 @@ export interface IFWorkbookDataValidationMixin {
): IDisposable;
}
+/**
+ * @ignore
+ */
export class FWorkbookDataValidationMixin extends FWorkbook implements IFWorkbookDataValidationMixin {
declare _dataValidationModel: SheetDataValidationModel;
diff --git a/packages/sheets-data-validation/src/facade/f-worksheet.ts b/packages/sheets-data-validation/src/facade/f-worksheet.ts
index 6970ca29f7..d266df2ac0 100644
--- a/packages/sheets-data-validation/src/facade/f-worksheet.ts
+++ b/packages/sheets-data-validation/src/facade/f-worksheet.ts
@@ -20,6 +20,9 @@ import { SheetsDataValidationValidatorService } from '@univerjs/sheets-data-vali
import { FWorksheet } from '@univerjs/sheets/facade';
import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
export interface IFWorksheetDataValidationMixin {
/**
* Get all data validation rules in current sheet.
@@ -61,6 +64,9 @@ export interface IFWorksheetDataValidationMixin {
}
+/**
+ * @ignore
+ */
export class FWorksheetDataValidationMixin extends FWorksheet implements IFWorksheetDataValidationMixin {
override getDataValidations(): FDataValidation[] {
const dataValidationModel = this._injector.get(DataValidationModel);
diff --git a/packages/sheets-thread-comment/src/facade/f-event.ts b/packages/sheets-thread-comment/src/facade/f-event.ts
index ace3da73a6..3fdba08687 100644
--- a/packages/sheets-thread-comment/src/facade/f-event.ts
+++ b/packages/sheets-thread-comment/src/facade/f-event.ts
@@ -19,6 +19,9 @@ import type { FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
import type { FTheadCommentItem, FThreadComment } from './f-thread-comment';
import { FEventName } from '@univerjs/core';
+/**
+ * @ignore
+ */
interface ICommentEventMixin {
/**
* Event fired after comment added
@@ -139,6 +142,9 @@ const CommentEvent: ICommentEventMixin = {
BeforeCommentResolve: 'BeforeCommentResolve',
} as const;
+/**
+ * @ignore
+ */
export class FCommentEvent extends FEventName {
override get CommentAdded(): 'CommentAdded' {
return CommentEvent.CommentAdded;
@@ -300,6 +306,10 @@ export interface ISheetCommentResolveEvent extends IEventBase {
}
FEventName.extend(FCommentEvent);
+
+/**
+ * @ignore
+ */
export interface ISheetCommentEventConfig {
BeforeCommentAdd: IBeforeSheetCommentAddEvent;
CommentAdded: ISheetCommentAddEvent;
diff --git a/packages/sheets-thread-comment/src/facade/f-range.ts b/packages/sheets-thread-comment/src/facade/f-range.ts
index 8cc2eb71e6..e657155196 100644
--- a/packages/sheets-thread-comment/src/facade/f-range.ts
+++ b/packages/sheets-thread-comment/src/facade/f-range.ts
@@ -21,6 +21,9 @@ import { FRange } from '@univerjs/sheets/facade';
import { AddCommentCommand, DeleteCommentTreeCommand, getDT } from '@univerjs/thread-comment';
import { FTheadCommentBuilder, FThreadComment } from './f-thread-comment';
+/**
+ * @ignore
+ */
export interface IFRangeCommentMixin {
/**
* Get the comment of the start cell in the current range.
@@ -98,6 +101,9 @@ export interface IFRangeCommentMixin {
clearCommentsAsync(): Promise<boolean>;
}
+/**
+ * @ignore
+ */
export class FRangeCommentMixin extends FRange implements IFRangeCommentMixin {
override getComment(): Nullable<FThreadComment> {
const injector = this._injector;
diff --git a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
index c83e66754a..c0ff11c067 100644
--- a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
+++ b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
@@ -22,6 +22,9 @@ import { SheetsThreadCommentModel } from '@univerjs/sheets-thread-comment';
import { FRange } from '@univerjs/sheets/facade';
import { AddCommentCommand, DeleteCommentCommand, DeleteCommentTreeCommand, getDT, ResolveCommentCommand, UpdateCommentCommand } from '@univerjs/thread-comment';
+/**
+ * An readonly class that represents a comment.
+ */
export class FTheadCommentItem {
protected _comment: IThreadComment = {
id: generateRandomId(),
@@ -145,6 +148,9 @@ export class FTheadCommentItem {
}
}
+/**
+ * A builder for thread comment. use {@link FUniver} `univerAPI.newTheadComment()` to create a new builder.
+ */
export class FTheadCommentBuilder extends FTheadCommentItem {
static override create(comment?: IThreadComment): FTheadCommentBuilder {
return new FTheadCommentBuilder(comment);
@@ -245,9 +251,12 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
}
/**
- * @hideconstructor
+ * A class that represents a thread comment already in the sheet.
*/
export class FThreadComment {
+ /**
+ * @ignore
+ */
constructor(
private readonly _thread: IThreadComment | IBaseComment,
private readonly _parent: IThreadComment | undefined,
@@ -268,7 +277,7 @@ export class FThreadComment {
/**
* Whether the comment is a root comment
- * @returns Whether the comment is a root comment
+ * @returns {boolean} Whether the comment is a root comment
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -283,7 +292,7 @@ export class FThreadComment {
/**
* Get the comment data
- * @returns The comment data
+ * @returns {IBaseComment} The comment data
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -299,7 +308,7 @@ export class FThreadComment {
/**
* Get the replies of the comment
- * @returns the replies of the comment
+ * @returns {FThreadComment[]} the replies of the comment
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -317,7 +326,7 @@ export class FThreadComment {
/**
* Get the range of the comment
- * @returns The range of the comment
+ * @returns {FRange | null} The range of the comment
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -339,6 +348,7 @@ export class FThreadComment {
return this._injector.createInstance(FRange, workbook, worksheet, range);
}
+ // eslint-disable-next-line
/**
* @deprecated use `getRichText` as instead
*/
@@ -384,6 +394,7 @@ export class FThreadComment {
);
}
+ // eslint-disable-next-line
/**
* @deprecated use `deleteAsync` as instead.
*/
@@ -391,8 +402,8 @@ export class FThreadComment {
return this.deleteAsync();
}
+ // eslint-disable-next-line
/**
- * @param content
* @deprecated use `updateAsync` as instead
*/
async update(content: IDocumentBody): Promise<boolean> {
@@ -401,8 +412,8 @@ export class FThreadComment {
/**
* Update the comment content
- * @param content The new content of the comment
- * @returns success or not
+ * @param {IDocumentBody | RichTextValue} content The new content of the comment
+ * @returns {Promise<boolean>} success or not
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -431,8 +442,8 @@ export class FThreadComment {
return res;
}
+ // eslint-disable-next-line
/**
- * @param resolved
* @deprecated use `resolveAsync` as instead
*/
resolve(resolved?: boolean): Promise<boolean> {
@@ -441,8 +452,8 @@ export class FThreadComment {
/**
* Resolve the comment
- * @param resolved Whether the comment is resolved
- * @returns success or not
+ * @param {boolean} resolved Whether the comment is resolved
+ * @returns {Promise<boolean>} success or not
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
@@ -465,8 +476,8 @@ export class FThreadComment {
/**
* Reply to the comment
- * @param comment The comment to reply to
- * @returns success or not
+ * @param {FTheadCommentBuilder} comment The comment to reply to
+ * @returns {Promise<boolean>} success or not
* @example
* ```ts
* const comment = univerAPI.getActiveWorkbook()
diff --git a/packages/sheets-thread-comment/src/facade/f-univer.ts b/packages/sheets-thread-comment/src/facade/f-univer.ts
index 5a378e830e..8e95628329 100644
--- a/packages/sheets-thread-comment/src/facade/f-univer.ts
+++ b/packages/sheets-thread-comment/src/facade/f-univer.ts
@@ -21,6 +21,9 @@ import { CanceledError, FUniver, ICommandService, RichTextValue } from '@univerj
import { AddCommentCommand, DeleteCommentCommand, ResolveCommentCommand, UpdateCommentCommand } from '@univerjs/thread-comment';
import { FTheadCommentBuilder, FTheadCommentItem } from './f-thread-comment';
+/**
+ * @ignore
+ */
export interface IFUniverCommentMixin {
/**
* @deprecated use `univerAPI.addEvent(univerAPI.event.CommentAdded, () => {})` as instead
@@ -53,6 +56,9 @@ export interface IFUniverCommentMixin {
newTheadComment(): FTheadCommentBuilder;
}
+/**
+ * @ignore
+ */
export class FUniverCommentMixin extends FUniver implements IFUniverCommentMixin {
// eslint-disable-next-line complexity
private _handleCommentCommand(commandInfo: ICommandInfo): void {
diff --git a/packages/sheets-thread-comment/src/facade/f-workbook.ts b/packages/sheets-thread-comment/src/facade/f-workbook.ts
index 44c17b1ceb..4b77676493 100644
--- a/packages/sheets-thread-comment/src/facade/f-workbook.ts
+++ b/packages/sheets-thread-comment/src/facade/f-workbook.ts
@@ -25,6 +25,9 @@ import { FThreadComment } from './f-thread-comment';
// eslint-disable-next-line ts/no-explicit-any
type IUpdateCommandParams = any;
+/**
+ * @ignore
+ */
export interface IFWorkbookThreadCommentMixin {
/**
* Get all comments in the current sheet
@@ -78,6 +81,9 @@ export interface IFWorkbookThreadCommentMixin {
): IDisposable;
}
+/**
+ * @ignore
+ */
export class FWorkbookThreadCommentMixin extends FWorkbook implements IFWorkbookThreadCommentMixin {
declare _threadCommentModel: ThreadCommentModel;
diff --git a/packages/sheets-thread-comment/src/facade/f-worksheet.ts b/packages/sheets-thread-comment/src/facade/f-worksheet.ts
index e7db232928..1b697e7418 100644
--- a/packages/sheets-thread-comment/src/facade/f-worksheet.ts
+++ b/packages/sheets-thread-comment/src/facade/f-worksheet.ts
@@ -22,6 +22,9 @@ import { FWorksheet } from '@univerjs/sheets/facade';
import { AddCommentCommand } from '@univerjs/thread-comment';
import { FThreadComment } from './f-thread-comment';
+/**
+ * @ignore
+ */
export interface IFWorksheetCommentMixin {
/**
* Get all comments in the current sheet
@@ -56,6 +59,9 @@ export interface IFWorksheetCommentMixin {
getCommentById(commentId: string): FThreadComment | undefined;
}
+/**
+ * @ignore
+ */
export class FWorksheetCommentMixin extends FWorksheet implements IFWorksheetCommentMixin {
override getComments(): FThreadComment[] {
const sheetsTheadCommentModel = this._injector.get(SheetsThreadCommentModel);
diff --git a/packages/ui/src/facade/f-enum.ts b/packages/ui/src/facade/f-enum.ts
index afe7b0d7a3..1cecebcf0a 100644
--- a/packages/ui/src/facade/f-enum.ts
+++ b/packages/ui/src/facade/f-enum.ts
@@ -17,10 +17,16 @@
import { FEnum } from '@univerjs/core';
import { BuiltInUIPart } from '@univerjs/ui';
+/**
+ * @ignore
+ */
interface IFUIEnumMixin {
get BuiltInUIPart(): typeof BuiltInUIPart;
}
+/**
+ * @ignore
+ */
export class FUIEnum extends FEnum implements IFUIEnumMixin {
override get BuiltInUIPart(): typeof BuiltInUIPart {
return BuiltInUIPart;
diff --git a/packages/ui/src/facade/f-hooks.ts b/packages/ui/src/facade/f-hooks.ts
index d7da28fbf5..6d4305da59 100644
--- a/packages/ui/src/facade/f-hooks.ts
+++ b/packages/ui/src/facade/f-hooks.ts
@@ -18,6 +18,9 @@ import type { IDisposable } from '@univerjs/core';
import { FHooks, ICommandService } from '@univerjs/core';
import { CopyCommand, PasteCommand, SheetPasteShortKeyCommandName } from '@univerjs/ui';
+/**
+ * @ignore
+ */
export interface IFHooksSheetsUIMixin {
/**
* The onBeforeCopy event is fired before a copy operation is performed.
@@ -55,6 +58,9 @@ export interface IFHooksSheetsUIMixin {
onPaste(callback: () => void): IDisposable;
}
+/**
+ * @ignore
+ */
export class FHooksSheetsMixin extends FHooks implements IFHooksSheetsUIMixin {
override onBeforeCopy(callback: () => void): IDisposable {
const commandService = this._injector.get(ICommandService);
diff --git a/packages/ui/src/facade/f-menu-builder.ts b/packages/ui/src/facade/f-menu-builder.ts
index 7fb3e76338..0dba12cd70 100644
--- a/packages/ui/src/facade/f-menu-builder.ts
+++ b/packages/ui/src/facade/f-menu-builder.ts
@@ -19,6 +19,9 @@ import type { IMenuButtonItem, IMenuItem, MenuSchemaType } from '@univerjs/ui';
import { CommandType, FBase, ICommandService, Inject, Injector, Tools } from '@univerjs/core';
import { IMenuManagerService, MenuItemType, MenuManagerPosition, RibbonPosition, RibbonStartGroup } from '@univerjs/ui';
+/**
+ * @ignore
+ */
export interface IFacadeMenuItem {
/**
* The unique identifier of the menu item.
@@ -47,6 +50,9 @@ export interface IFacadeMenuItem {
order?: number;
}
+/**
+ * @ignore
+ */
export interface IFacadeSubmenuItem {
/**
* The unique identifier of the menu item.
diff --git a/packages/ui/src/facade/f-univer.ts b/packages/ui/src/facade/f-univer.ts
index 5273da24c2..6e9baaf3e2 100644
--- a/packages/ui/src/facade/f-univer.ts
+++ b/packages/ui/src/facade/f-univer.ts
@@ -23,6 +23,9 @@ import { ComponentManager, CopyCommand, IDialogService, IMessageService, ISideba
import { FMenu, FSubmenu } from './f-menu-builder';
import { FShortcut } from './f-shortcut';
+/**
+ * @ignore
+ */
export interface IFUniverUIMixin {
/**
* Return the URL of the current page.
@@ -152,6 +155,9 @@ export interface IFUniverUIMixin {
registerComponent(name: string, component: ComponentType, options?: IComponentOptions): IDisposable;
}
+/**
+ * @ignore
+ */
export class FUniverUIMixin extends FUniver implements IFUniverUIMixin {
override getURL(): URL {
return new URL(window.location.href);