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
feat(sheets-ui): add hover facade api (#4092)
zhangwa23f2fbed49e
diff --git a/packages/sheets-ui/src/facade/f-range.ts b/packages/sheets-ui/src/facade/f-range.tsindex 8bb468363e..0475afdb2d 100644--- a/packages/sheets-ui/src/facade/f-range.ts+++ b/packages/sheets-ui/src/facade/f-range.ts@@ -14,13 +14,13 @@* limitations under the License.*/-import type { ICellWithCoord, IDisposable, Nullable } from '@univerjs/core';-import type { ISheetLocation } from '@univerjs/sheets';+import type { ICellWithCoord, IDisposable, ISelectionCell, Nullable } from '@univerjs/core';+import type { ISelectionStyle, ISheetLocation } from '@univerjs/sheets';import type { ComponentType } from '@univerjs/ui';-import { DisposableCollection, generateRandomId } from '@univerjs/core';+import { DisposableCollection, generateRandomId, toDisposable } from '@univerjs/core';import { IRenderManagerService } from '@univerjs/engine-render';import { FRange } from '@univerjs/sheets/facade';-import { CellAlertManagerService, type ICanvasPopup, type ICellAlert, SheetCanvasPopManagerService } from '@univerjs/sheets-ui';+import { CellAlertManagerService, type ICanvasPopup, type ICellAlert, IMarkSelectionService, SheetCanvasPopManagerService } from '@univerjs/sheets-ui';import { ISheetClipboardService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';import { ComponentManager } from '@univerjs/ui';@@ -69,6 +69,10 @@ interface IFRangeSheetsUIMixin {*/attachAlertPopup(alert: Omit<ICellAlert, 'location'>): IDisposable;+ /**+ * Highlight this range.+ */+ highlight(style?: Nullable<Partial<ISelectionStyle>>, primary?: Nullable<ISelectionCell>): IDisposable;}class FRangeSheetsUIMixin extends FRange implements IFRangeSheetsUIMixin {@@ -138,6 +142,18 @@ class FRangeSheetsUIMixin extends FRange implements IFRangeSheetsUIMixin {},};}++ override highlight(style?: Nullable<Partial<ISelectionStyle>>, primary?: Nullable<ISelectionCell>): IDisposable {+ const markSelectionService = this._injector.get(IMarkSelectionService);+ const id = markSelectionService.addShape({ range: this._range, style, primary });++ if (!id) {+ throw new Error('Failed to highlight current range');+ }+ return toDisposable(() => {+ markSelectionService.removeShape(id);+ });+ }}FRange.extend(FRangeSheetsUIMixin);diff --git a/packages/sheets-ui/src/facade/f-workbook.ts b/packages/sheets-ui/src/facade/f-workbook.tsindex 16e6d3e4df..d757763f3d 100644--- a/packages/sheets-ui/src/facade/f-workbook.ts+++ b/packages/sheets-ui/src/facade/f-workbook.ts@@ -14,9 +14,12 @@* limitations under the License.*/-import { type IDisposable, ILogService } from '@univerjs/core';+import type { IHoverRichTextInfo, IHoverRichTextPosition } from '../services/hover-manager.service';+import { type IDisposable, ILogService, toDisposable } from '@univerjs/core';import { FWorkbook } from '@univerjs/sheets/facade';+import { HoverManagerService } from '@univerjs/sheets-ui';import { type IDialogPartMethodOptions, IDialogService, type ISidebarMethodOptions, ISidebarService } from '@univerjs/ui';+import { filter } from 'rxjs';interface IFWorkbookSheetsUIMixin {/**@@ -38,6 +41,22 @@ interface IFWorkbookSheetsUIMixin {* @returns the disposable object*/openDialog(dialog: IDialogPartMethodOptions): IDisposable;++ /**+ * Subscribe to cell click events+ *+ * @param callback - The callback function to be called when a cell is clicked+ * @returns A disposable object that can be used to unsubscribe from the event+ */+ onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable;++ /**+ * Subscribe cell hover events+ *+ * @param callback - The callback function to be called when a cell is hovered+ * @returns A disposable object that can be used to unsubscribe from the event+ */+ onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable;}class FWorokbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheetsUIMixin {@@ -67,6 +86,24 @@ class FWorokbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheetsUIMixlogService.warn('[FWorkbook]', `${name} is deprecated. Please use the function of the same name on "FUniver".`);}++ override onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable {+ const hoverManagerService = this._injector.get(HoverManagerService);+ return toDisposable(+ hoverManagerService.currentClickedCell$+ .pipe(filter((cell) => !!cell))+ .subscribe(callback)+ );+ }++ override onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable {+ const hoverManagerService = this._injector.get(HoverManagerService);+ return toDisposable(+ hoverManagerService.currentRichText$+ .pipe(filter((cell) => !!cell))+ .subscribe(callback)+ );+ }}FWorkbook.extend(FWorokbookSheetsUIMixin);diff --git a/packages/sheets-ui/src/services/hover-manager.service.ts b/packages/sheets-ui/src/services/hover-manager.service.tsindex b792f08895..5eb8dca101 100644--- a/packages/sheets-ui/src/services/hover-manager.service.ts+++ b/packages/sheets-ui/src/services/hover-manager.service.ts@@ -16,7 +16,7 @@import type { ICustomRange, IParagraph, IPosition, Nullable, Workbook } from '@univerjs/core';import type { IBoundRectNoAngle, SpreadsheetSkeleton } from '@univerjs/engine-render';-import type { ISheetLocation } from '@univerjs/sheets';+import type { ISheetLocation, ISheetLocationBase } from '@univerjs/sheets';import { Disposable, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';import { IRenderManagerService } from '@univerjs/engine-render';import { BehaviorSubject, distinctUntilChanged, map, Subject } from 'rxjs';@@ -33,7 +33,22 @@ export interface IHoverCellPosition {location: ISheetLocation;}-export interface IHoverRichTextPosition extends IHoverCellPosition {+export interface IHoverRichTextInfo extends IHoverCellPosition {+ /**+ * active custom range in cell, if cell is rich-text+ */+ customRange?: Nullable<ICustomRange>;+ /**+ * active bullet in cell, if cell is rich-text+ */+ bullet?: Nullable<IParagraph>;+ /**+ * rect of custom-range or bullet+ */+ rect?: Nullable<IBoundRectNoAngle>;+}++export interface IHoverRichTextPosition extends ISheetLocationBase {/*** active custom range in cell, if cell is rich-text*/@@ -50,8 +65,8 @@ export interface IHoverRichTextPosition extends IHoverCellPosition {export class HoverManagerService extends Disposable {private _currentCell$ = new BehaviorSubject<Nullable<IHoverCellPosition>>(null);- private _currentRichText$ = new BehaviorSubject<Nullable<IHoverRichTextPosition>>(null);- private _currentClickedCell$ = new Subject<IHoverRichTextPosition>();+ private _currentRichText$ = new BehaviorSubject<Nullable<IHoverRichTextInfo>>(null);+ private _currentClickedCell$ = new Subject<IHoverRichTextInfo>();// Notify when hovering over different cellscurrentCell$ = this._currentCell$.asObservable().pipe(@@ -88,7 +103,7 @@ export class HoverManagerService extends Disposable {customRange: cell.customRange,bullet: cell.bullet,rect: cell.rect,- })+ } as IHoverRichTextPosition));// Notify when mouse position changes