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(docs-ui): refine embed bleed and Sheet Float DOM scroll (#7350)

Univereb627320f8b5
diff --git a/packages/docs-drawing-ui/src/controllers/__tests__/doc-float-dom.controller.spec.ts b/packages/docs-drawing-ui/src/controllers/__tests__/doc-float-dom.controller.spec.ts
index 66399872be..96e4ec4c5c 100644
--- a/packages/docs-drawing-ui/src/controllers/__tests__/doc-float-dom.controller.spec.ts
+++ b/packages/docs-drawing-ui/src/controllers/__tests__/doc-float-dom.controller.spec.ts
@@ -14,8 +14,9 @@
* limitations under the License.
*/
-import { DrawingTypeEnum } from '@univerjs/core';
+import { DrawingTypeEnum, UniverInstanceType } from '@univerjs/core';
import { InsertDocDrawingCommand } from '@univerjs/docs-drawing';
+import { SetDocZoomRatioOperation } from '@univerjs/docs-ui';
import { Rect } from '@univerjs/engine-render';
import { BehaviorSubject, Subject } from 'rxjs';
import { describe, expect, it, vi } from 'vitest';
@@ -131,9 +132,9 @@ function createController(options: { drawing?: Record<string, unknown>; rects?:
describe('DocFloatDomController', () => {
it('preserves existing props while adding custom block runtime viewport', () => {
expect(mergeDocFloatDomRuntimeProps({ keep: true }, {
- customBlockRenderViewport: { bleedLeft: 96, bleedWidth: 1440, contentHeight: 720, contentWidth: 1280, height: 480, viewportHeight: 320 },
+ customBlockRenderViewport: { bleedLeft: 96, bleedWidth: 1440, contentHeight: 720, contentWidth: 1280, height: 480, pageContentWidth: 1008, viewScale: 1.5, viewportHeight: 320 },
} as never)).toEqual({
- customBlockRenderViewport: { bleedLeft: 96, bleedWidth: 1440, contentHeight: 720, contentWidth: 1280, height: 480, viewportHeight: 320 },
+ customBlockRenderViewport: { bleedLeft: 96, bleedWidth: 1440, contentHeight: 720, contentWidth: 1280, height: 480, pageContentWidth: 1008, viewScale: 1.5, viewportHeight: 320 },
keep: true,
});
});
@@ -160,6 +161,47 @@ describe('DocFloatDomController', () => {
});
});
+ it('updates float dom position after host doc zoom without rewriting runtime viewport', async () => {
+ const rect = new Rect('dom-rect', {
+ left: 30,
+ top: 50,
+ width: 50,
+ height: 40,
+ });
+ const { add$, canvasFloatDomService, commandHandlers, controller, scene } = createController({
+ rects: [rect],
+ drawing: {
+ customBlockRenderViewport: {
+ contentHeight: 240,
+ height: 240,
+ viewScale: 1,
+ viewportHeight: 120,
+ },
+ },
+ });
+
+ add$.next([{ unitId: 'doc-1', subUnitId: 'doc-1', drawingId: 'dom-1' }]);
+ await Promise.resolve();
+ const position$ = canvasFloatDomService.addFloatDom.mock.calls[0][0].position$ as BehaviorSubject<unknown>;
+ scene.getAncestorScale.mockReturnValue({ scaleX: 1, scaleY: 1 });
+ commandHandlers.forEach((handler) => handler({
+ id: SetDocZoomRatioOperation.id,
+ params: { unitId: 'doc-1', zoomRatio: 2 },
+ }));
+ scene.getAncestorScale.mockReturnValue({ scaleX: 2, scaleY: 2 });
+ await Promise.resolve();
+
+ expect(position$.getValue()).toMatchObject({
+ startX: 40,
+ startY: 60,
+ width: 100,
+ height: 480,
+ });
+ expect(canvasFloatDomService.updateFloatDom).not.toHaveBeenCalled();
+
+ controller.dispose();
+ });
+
it('adds rendered float doms, updates their position, and removes them with their rect object', async () => {
const rect = new Rect('dom-rect', {
left: 30,
@@ -257,7 +299,7 @@ describe('DocFloatDomController', () => {
controller.dispose();
});
- it('updates rendered float dom bounds from doc drawing transform refreshes', async () => {
+ it('updates rendered float dom bounds only from the owning document unit', async () => {
const rect = new Rect('dom-rect', {
left: 30,
top: 50,
@@ -278,7 +320,16 @@ describe('DocFloatDomController', () => {
const positions: unknown[] = [];
const sub = position$.subscribe((position: unknown) => positions.push(position));
+ const positionCount = positions.length;
refreshTransform$.next([{
+ unitId: 'doc-2',
+ drawingId: 'dom-1',
+ transform: { left: 0, top: 0, width: 160, height: 240, angle: 0 },
+ }]);
+ expect(positions).toHaveLength(positionCount);
+
+ refreshTransform$.next([{
+ unitId: 'doc-1',
drawingId: 'dom-1',
transform: { left: 40, top: 60, width: 160, height: 240, angle: 0 },
customBlockRenderViewport: { contentHeight: 240, height: 240, viewportHeight: 120 },
@@ -332,7 +383,7 @@ describe('DocFloatDomController', () => {
controller.dispose();
});
- it('disables host event pass-through for embed float dom runtimes', async () => {
+ it('uses the full content box for sheet-like embed float dom runtimes', async () => {
const rect = new Rect('dom-rect', {
left: 30,
top: 50,
@@ -342,7 +393,12 @@ describe('DocFloatDomController', () => {
const { controller, add$, canvasFloatDomService } = createController({
rects: [rect],
drawing: {
- data: { version: 1, embedId: 'embed-1', hostAnchorId: 'anchor-1' },
+ data: {
+ version: 1,
+ embedId: 'embed-1',
+ hostAnchorId: 'anchor-1',
+ childType: UniverInstanceType.UNIVER_SHEET,
+ },
},
});
@@ -350,6 +406,37 @@ describe('DocFloatDomController', () => {
await Promise.resolve();
expect(canvasFloatDomService.addFloatDom).toHaveBeenCalledWith(expect.objectContaining({
+ contentBox: { contentInset: 0, wrapperInset: 0 },
+ eventPassThrough: false,
+ }));
+
+ controller.dispose();
+ });
+
+ it('keeps the legacy content box for other embed float dom runtimes', async () => {
+ const rect = new Rect('dom-rect', {
+ left: 30,
+ top: 50,
+ width: 50,
+ height: 40,
+ } as never);
+ const { controller, add$, canvasFloatDomService } = createController({
+ rects: [rect],
+ drawing: {
+ data: {
+ version: 1,
+ embedId: 'embed-1',
+ hostAnchorId: 'anchor-1',
+ childType: UniverInstanceType.UNIVER_SLIDE,
+ },
+ },
+ });
+
+ add$.next([{ unitId: 'doc-1', subUnitId: 'doc-1', drawingId: 'dom-1' }]);
+ await Promise.resolve();
+
+ expect(canvasFloatDomService.addFloatDom).toHaveBeenCalledWith(expect.objectContaining({
+ contentBox: undefined,
eventPassThrough: false,
}));
@@ -378,6 +465,7 @@ describe('DocFloatDomController', () => {
const sub = position$.subscribe((position: unknown) => positions.push(position));
refreshTransform$.next([{
+ unitId: 'doc-1',
drawingId: 'dom-1',
customBlockRenderViewport: { contentHeight: 240, height: 240, viewportHeight: 120 },
}]);
@@ -415,12 +503,14 @@ describe('DocFloatDomController', () => {
const sub = position$.subscribe((position: unknown) => positions.push(position));
refreshTransform$.next([{
+ unitId: 'doc-1',
drawingId: 'dom-1',
transform: { left: 40, top: 60, width: 160, height: 240, angle: 0 },
customBlockRenderViewport: { contentHeight: 240, height: 240, viewportHeight: 120 },
}]);
rect.transformByState({ left: 45, top: 65, width: 160, height: 40, angle: 0 } as never);
refreshTransform$.next([{
+ unitId: 'doc-1',
drawingId: 'dom-1',
transform: { left: 45, top: 65, width: 160, height: 40, angle: 0 },
}]);
@@ -459,6 +549,7 @@ describe('DocFloatDomController', () => {
rect.transformByState({ left: 30, top: 60, width: 720, height: 405, angle: 0 } as never);
refreshTransform$.next([{
+ unitId: 'doc-1',
drawingId: 'dom-1',
transform: { left: 30, top: 60, width: 720, height: 405, angle: 0 },
}]);
diff --git a/packages/docs-drawing-ui/src/controllers/doc-float-dom.controller.ts b/packages/docs-drawing-ui/src/controllers/doc-float-dom.controller.ts
index 02ca6f5de0..0595bd28e2 100644
--- a/packages/docs-drawing-ui/src/controllers/doc-float-dom.controller.ts
+++ b/packages/docs-drawing-ui/src/controllers/doc-float-dom.controller.ts
@@ -35,7 +35,7 @@ import {
toDisposable,
UniverInstanceType,
} from '@univerjs/core';
-import { docDrawingPositionToTransform, DocSkeletonManagerService } from '@univerjs/docs';
+import { docDrawingPositionToTransform, DocSkeletonManagerService, isSheetLikeDocsCustomBlockChildType } from '@univerjs/docs';
import { InsertDocDrawingCommand } from '@univerjs/docs-drawing';
import { SetDocZoomRatioOperation, VIEWPORT_KEY } from '@univerjs/docs-ui';
import { IDrawingManagerService } from '@univerjs/drawing';
@@ -95,7 +95,7 @@ interface ICanvasFloatDomInfo {
interface IDocFloatDomParams extends IDocFloatDomDataBase {
}
-type IDocFloatDomRuntimeViewport = Partial<Pick<IDocsCustomBlockRenderViewport, 'bleedLeft' | 'bleedWidth' | 'contentHeight' | 'contentWidth' | 'height' | 'viewportHeight'>>;
+type IDocFloatDomRuntimeViewport = Partial<Pick<IDocsCustomBlockRenderViewport, 'bleedLeft' | 'bleedWidth' | 'contentHeight' | 'contentWidth' | 'height' | 'pageContentWidth' | 'viewScale' | 'viewportHeight'>>;
interface IDocFloatDomRuntimeParam extends IDocFloatDom {
customBlockRenderViewport?: IDocFloatDomRuntimeViewport;
@@ -133,6 +133,13 @@ function pickValidCustomBlockRenderViewport(viewport: IDocFloatDomRuntimeViewpor
if (isPositiveNumber(viewport?.height)) {
result.height = viewport!.height;
}
+ if (isPositiveNumber(viewport?.pageContentWidth)) {
+ result.pageContentWidth = viewport!.pageContentWidth;
+ }
+ const viewScale = viewport?.viewScale;
+ if (isPositiveNumber(viewScale)) {
+ result.viewScale = viewScale;
+ }
if (isPositiveNumber(viewport?.viewportHeight)) {
result.viewportHeight = viewport!.viewportHeight;
}
@@ -259,6 +266,9 @@ export class DocFloatDomController extends Disposable {
position$,
id: rectParam.drawingId,
componentKey: rectParam.componentKey,
+ contentBox: isSheetLikeEmbedFloatDomRuntimeParam(runtimeParam)
+ ? { contentInset: 0, wrapperInset: 0 }
+ : undefined,
eventPassThrough: preserveRuntimeGeometry ? false : undefined,
preserveOnFocusChange: preserveRuntimeGeometry,
onPointerDown: (evt) => {
@@ -304,7 +314,7 @@ export class DocFloatDomController extends Disposable {
this._drawingManagerService.refreshTransform$.subscribe((params) => {
params.forEach((param) => {
const floatDomInfo = this._domLayerInfoMap.get(param.drawingId);
- if (!floatDomInfo) {
+ if (!floatDomInfo || floatDomInfo.unitId !== param.unitId) {
return;
}
@@ -411,7 +421,9 @@ export class DocFloatDomController extends Disposable {
if (commandInfo.id === SetDocZoomRatioOperation.id) {
const params = (commandInfo.params) as ISetDocZoomRatioOperationParams;
const { unitId } = params;
- updateDoc(unitId);
+ globalThis.queueMicrotask(() => {
+ if (!this._disposed) updateDoc(unitId);
+ });
}
}));
}
@@ -535,6 +547,19 @@ function isEmbedFloatDomRuntimeParam(param: IDocFloatDomRuntimeParam): boolean {
return candidate.version === 1 && typeof candidate.embedId === 'string' && typeof candidate.hostAnchorId === 'string';
}
+function isSheetLikeEmbedFloatDomRuntimeParam(param: IDocFloatDomRuntimeParam): boolean {
+ if (!isEmbedFloatDomRuntimeParam(param)) {
+ return false;
+ }
+
+ const data = param.data;
+ return !!data &&
+ typeof data === 'object' &&
+ 'childType' in data &&
+ typeof data.childType === 'number' &&
+ isSheetLikeDocsCustomBlockChildType(data.childType);
+}
+
function createTransformFromRect(rect: Rect): Partial<ITransformState> {
return {
angle: rect.angle,
diff --git a/packages/docs-drawing-ui/src/controllers/render-controllers/doc-drawing-transform-update.controller.ts b/packages/docs-drawing-ui/src/controllers/render-controllers/doc-drawing-transform-update.controller.ts
index fa57c0b24b..72966d6bd1 100644
--- a/packages/docs-drawing-ui/src/controllers/render-controllers/doc-drawing-transform-update.controller.ts
+++ b/packages/docs-drawing-ui/src/controllers/render-controllers/doc-drawing-transform-update.controller.ts
@@ -36,7 +36,7 @@ import { DocSkeletonManagerService, RichTextEditingMutation } from '@univerjs/do
import { IEditorService, SetDocZoomRatioOperation } from '@univerjs/docs-ui';
import { IDrawingManagerService } from '@univerjs/drawing';
import { getDocsTableRenderViewport, getTableIdAndSliceIndex, Liquid, TRANSFORM_CHANGE_OBSERVABLE_TYPE } from '@univerjs/engine-render';
-import { debounceTime, filter } from 'rxjs';
+import { debounceTime, filter, merge } from 'rxjs';
import { DocRefreshDrawingsService } from '../../services/doc-refresh-drawings.service';
interface IDrawingParamsWithBehindText {
@@ -47,7 +47,7 @@ interface IDrawingParamsWithBehindText {
hidden?: boolean;
transform: ITransformState;
transforms: ITransformState[];
- customBlockRenderViewport?: Partial<Pick<IDocsCustomBlockRenderViewport, 'bleedLeft' | 'bleedWidth' | 'contentHeight' | 'contentWidth' | 'height' | 'viewportHeight'>>;
+ customBlockRenderViewport?: Partial<Pick<IDocsCustomBlockRenderViewport, 'bleedLeft' | 'bleedWidth' | 'contentHeight' | 'contentWidth' | 'height' | 'pageContentWidth' | 'viewportHeight'>>;
// The same drawing render in different place, like image in header and footer.
// The default value is BooleanNumber.FALSE. if it's true, Please use transforms.
isMultiTransform: BooleanNumber;
@@ -245,7 +245,7 @@ export class DocDrawingTransformUpdateController extends Disposable implements I
private _initialize() {
this._initialRenderRefresh();
this._drawingInitializeListener();
- this._initResize();
+ this._initTransformRefresh();
}
private _initialRenderRefresh() {
@@ -303,10 +303,16 @@ export class DocDrawingTransformUpdateController extends Disposable implements I
);
}
- private _initResize() {
+ private _initTransformRefresh() {
this.disposeWithMe(
- fromEventSubject(this._context.engine.onTransformChange$).pipe(
- filter((evt) => evt.type === TRANSFORM_CHANGE_OBSERVABLE_TYPE.resize),
+ merge(
+ fromEventSubject(this._context.engine.onTransformChange$).pipe(
+ filter((evt) => evt.type === TRANSFORM_CHANGE_OBSERVABLE_TYPE.resize)
+ ),
+ fromEventSubject(this._context.scene.onTransformChange$).pipe(
+ filter((evt) => evt.type === TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale)
+ )
+ ).pipe(
debounceTime(16)
).subscribe(() => {
const skeleton = this._docSkeletonManagerService.getSkeleton();
diff --git a/packages/docs-ui/src/__tests__/embed-docs-custom-block-bleed.spec.ts b/packages/docs-ui/src/__tests__/embed-docs-custom-block-bleed.spec.ts
index 2645ed97ba..c5bdde321b 100644
--- a/packages/docs-ui/src/__tests__/embed-docs-custom-block-bleed.spec.ts
+++ b/packages/docs-ui/src/__tests__/embed-docs-custom-block-bleed.spec.ts
@@ -70,6 +70,22 @@ describe('resolveDocsTableLikeCustomBlockBleedViewport', () => {
});
});
+ it('converts measured screen geometry back to logical geometry at document scale', () => {
+ const root = createElementWithRect({ left: 440, right: 2360, width: 1920 });
+ document.body.appendChild(root);
+ vi.spyOn(window, 'innerWidth', 'get').mockReturnValue(2880);
+
+ expect(resolveDocsTableLikeCustomBlockBleedViewport(root, 1800, {
+ viewScale: 2,
+ })).toEqual({
+ bleedLeft: 215,
+ bleedRight: 255,
+ bleedWidth: 1430,
+ contentWidth: 1800,
+ virtualWidth: 2015,
+ });
+ });
+
it('uses authoritative render viewport bleed hints without expanding the layout root', () => {
const root = createElementWithRect({ left: 220, right: 1180, width: 960 });
document.body.appendChild(root);
@@ -87,7 +103,7 @@ describe('resolveDocsTableLikeCustomBlockBleedViewport', () => {
});
});
- it('keeps authoritative bleed hints even when runtime content width has not caught up', () => {
+ it('keeps authoritative bleed hints while runtime content width has not caught up', () => {
const root = createElementWithRect({ left: 220, right: 1180, width: 960 });
expect(resolveDocsTableLikeCustomBlockBleedViewport(root, 960, {
@@ -102,6 +118,37 @@ describe('resolveDocsTableLikeCustomBlockBleedViewport', () => {
});
});
+ it('does not bleed when authoritative content width fits the block', () => {
+ const root = createElementWithRect({ left: 220, right: 1180, width: 960 });
+
+ expect(resolveDocsTableLikeCustomBlockBleedViewport(root, 960, {
+ authoritativeContentWidth: true,
+ bleedLeft: 210,
+ bleedWidth: 1420,
+ })).toEqual({
+ bleedLeft: 0,
+ bleedRight: 0,
+ bleedWidth: 960,
+ contentWidth: 960,
+ virtualWidth: 960,
+ });
+ });
+
+ it('uses the full visible canvas bleed once content exceeds the page', () => {
+ const root = createElementWithRect({ left: 220, right: 1180, width: 960 });
+
+ expect(resolveDocsTableLikeCustomBlockBleedViewport(root, 1100, {
+ bleedLeft: 210,
+ bleedWidth: 1420,
+ })).toEqual({
+ bleedLeft: 210,
+ bleedRight: 250,
+ bleedWidth: 1420,
+ contentWidth: 1100,
+ virtualWidth: 1420,
+ });
+ });
+
it('prefers authoritative product content width over runtime DOM fallback', () => {
expect(resolveDocsTableLikeCustomBlockContentWidth(1600, 960)).toBe(1600);
expect(resolveDocsTableLikeCustomBlockContentWidth(undefined, 960)).toBe(960);
diff --git a/packages/docs-ui/src/__tests__/embed-host-anchor.spec.ts b/packages/docs-ui/src/__tests__/embed-host-anchor.spec.ts
index 62d25a5fbb..6744b69236 100644
--- a/packages/docs-ui/src/__tests__/embed-host-anchor.spec.ts
+++ b/packages/docs-ui/src/__tests__/embed-host-anchor.spec.ts
@@ -115,11 +115,35 @@ describe('resolveDocsCustomBlockRenderViewport', () => {
height: 480,
layoutWidth: 960,
offsetLeft: 0,
+ pageContentWidth: 1008,
+ viewScale: 1,
viewportHeight: 480,
width: 960,
});
});
+ it('keeps document scale separate from logical sheet-like viewport dimensions', () => {
+ expect(resolveDocsCustomBlockRenderViewport({
+ childType: UniverInstanceType.UNIVER_SHEET,
+ docsLeft: 120,
+ documentFlavor: DocumentFlavor.MODERN,
+ fallbackHeight: 480,
+ fallbackWidth: 960,
+ pageMarginLeft: 96,
+ pageMarginRight: 96,
+ pageWidth: 1200,
+ scale: 2,
+ visibleCanvasLeft: 0,
+ visibleCanvasWidth: 1440,
+ })).toEqual(expect.objectContaining({
+ bleedLeft: 211,
+ bleedWidth: 1430,
+ contentHeight: 480,
+ viewScale: 2,
+ width: 960,
+ }));
+ });
+
it('uses actual table height for sheet-like docs blocks so docs owns vertical scrolling', () => {
expect(resolveDocsCustomBlockRenderViewport({
childType: UniverInstanceType.UNIVER_BASE,
@@ -221,6 +245,8 @@ describe('resolveDocsCustomBlockRenderViewport', () => {
height: 480,
layoutWidth: 600,
offsetLeft: 0,
+ pageContentWidth: 600,
+ viewScale: 1,
viewportHeight: 480,
width: 600,
});
@@ -242,6 +268,8 @@ describe('resolveDocsCustomBlockRenderViewport', () => {
height: 480,
layoutWidth: 420,
offsetLeft: 0,
+ pageContentWidth: 600,
+ viewScale: 1,
viewportHeight: 480,
width: 420,
});
diff --git a/packages/docs-ui/src/embed-docs-custom-block-bleed.ts b/packages/docs-ui/src/embed-docs-custom-block-bleed.ts
index ca060b53b6..60de2ed390 100644
--- a/packages/docs-ui/src/embed-docs-custom-block-bleed.ts
+++ b/packages/docs-ui/src/embed-docs-custom-block-bleed.ts
@@ -25,8 +25,10 @@ export interface IDocsCustomBlockBleedViewport {
}
export interface IDocsCustomBlockBleedViewportHint {
+ authoritativeContentWidth?: boolean;
bleedLeft?: number;
bleedWidth?: number;
+ viewScale?: number;
}
export function createDefaultDocsTableLikeCustomBlockBleedViewport(): IDocsCustomBlockBleedViewport {
@@ -46,11 +48,26 @@ export function createDefaultDocsTableLikeCustomBlockBleedViewport(): IDocsCusto
export function resolveDocsTableLikeCustomBlockBleedViewport(root: HTMLElement, contentWidth: number, hint?: IDocsCustomBlockBleedViewportHint): IDocsCustomBlockBleedViewport {
const rootRect = root.getBoundingClientRect();
- const rootWidth = Math.max(1, rootRect.width);
+ const hintedViewScale = hint?.viewScale;
+ const viewScale = typeof hintedViewScale === 'number' && Number.isFinite(hintedViewScale) && hintedViewScale > 0
+ ? hintedViewScale
+ : 1;
+ const rootWidth = Math.max(1, rootRect.width / viewScale);
const normalizedContentWidth = Math.max(1, contentWidth);
const hintedBleedLeft = hint?.bleedLeft;
const hintedBleedWidth = hint?.bleedWidth;
- if (Number.isFinite(hintedBleedWidth) && (hintedBleedWidth ?? 0) > 0) {
+ const hasBleedHint = Number.isFinite(hintedBleedWidth) && (hintedBleedWidth ?? 0) > 0;
+ if (normalizedContentWidth <= rootWidth && (hint?.authoritativeContentWidth || !hasBleedHint)) {
+ return {
+ bleedLeft: 0,
+ bleedRight: 0,
+ bleedWidth: rootWidth,
+ contentWidth: normalizedContentWidth,
+ virtualWidth: rootWidth,
+ };
+ }
+
+ if (hasBleedHint) {
const bleedLeft = Math.max(0, hintedBleedLeft ?? 0);
const bleedWidth = Math.max(1, hintedBleedWidth!);
return {
@@ -62,28 +79,19 @@ export function resolveDocsTableLikeCustomBlockBleedViewport(root: HTMLElement,
};
}
- if (normalizedContentWidth <= rootWidth) {
- return {
- bleedLeft: 0,
- bleedRight: 0,
- bleedWidth: rootWidth,
- contentWidth: normalizedContentWidth,
- virtualWidth: rootWidth,
- };
- }
-
const bounds = resolveDocsTableLikeCustomBlockBleedBounds(root);
const viewportLeft = bounds.left + DOCS_CUSTOM_BLOCK_VIEWPORT_INSET;
const viewportWidth = Math.max(1, bounds.width - DOCS_CUSTOM_BLOCK_VIEWPORT_INSET * 2);
- const bleedLeft = Math.max(0, rootRect.left - viewportLeft);
- const bleedRight = Math.max(0, viewportLeft + viewportWidth - rootRect.right);
+ const bleedLeft = Math.max(0, (rootRect.left - viewportLeft) / viewScale);
+ const bleedRight = Math.max(0, (viewportLeft + viewportWidth - rootRect.right) / viewScale);
+ const logicalViewportWidth = viewportWidth / viewScale;
return {
bleedLeft,
bleedRight,
- bleedWidth: viewportWidth,
+ bleedWidth: logicalViewportWidth,
contentWidth: normalizedContentWidth,
- virtualWidth: Math.max(viewportWidth, bleedLeft + normalizedContentWidth),
+ virtualWidth: Math.max(logicalViewportWidth, bleedLeft + normalizedContentWidth),
};
}
diff --git a/packages/docs-ui/src/embed-host-anchor.ts b/packages/docs-ui/src/embed-host-anchor.ts
index 1e99b012cb..788afce80f 100644
--- a/packages/docs-ui/src/embed-host-anchor.ts
+++ b/packages/docs-ui/src/embed-host-anchor.ts
@@ -45,6 +45,8 @@ export interface IDocsCustomBlockLayoutViewport {
height: number;
layoutWidth?: number;
offsetLeft?: number;
+ pageContentWidth?: number;
+ viewScale?: number;
viewportHeight?: number;
width: number;
}
@@ -62,6 +64,7 @@ export function resolveDocsCustomBlockRenderViewport(params: IDocsCustomBlockRen
: undefined;
const height = sheetLike ? contentHeight : fallbackHeight;
const viewportHeight = sheetLike && visibleCanvasHeight != null ? Math.min(contentHeight, visibleCanvasHeight) : height;
+ const viewScale = params.scale && params.scale > 0 ? params.scale : 1;
if (!sheetLike) {
return {
@@ -88,13 +91,14 @@ export function resolveDocsCustomBlockRenderViewport(params: IDocsCustomBlockRen
height,
layoutWidth,
offsetLeft: 0,
+ pageContentWidth,
+ viewScale,
viewportHeight,
width: layoutWidth,
};
}
- const scale = params.scale && params.scale > 0 ? params.scale : 1;
- const inset = MODERN_DOCS_CUSTOM_BLOCK_VIEWPORT_INSET / scale;
+ const inset = MODERN_DOCS_CUSTOM_BLOCK_VIEWPORT_INSET / viewScale;
const docsLeft = params.docsLeft ?? 0;
const fallbackViewportLeft = docsLeft + inset;
const fallbackViewportWidth = Math.max(0, pageWidth! - inset * 2);
@@ -116,6 +120,8 @@ export function resolveDocsCustomBlockRenderViewport(params: IDocsCustomBlockRen
height,
layoutWidth,
offsetLeft: 0,
+ pageContentWidth,
+ viewScale,
viewportHeight,
width: layoutWidth,
};
diff --git a/packages/docs/src/services/__tests__/doc-skeleton-manager.service.spec.ts b/packages/docs/src/services/__tests__/doc-skeleton-manager.service.spec.ts
index 0578098c03..eaf179172b 100644
--- a/packages/docs/src/services/__tests__/doc-skeleton-manager.service.spec.ts
+++ b/packages/docs/src/services/__tests__/doc-skeleton-manager.service.spec.ts
@@ -88,5 +88,13 @@ describe('DocSkeletonManagerService', () => {
expect(service.getViewModel().getDataModel().getUnitId()).toBe('doc-1');
expect(service.getSkeleton()).toBeTruthy();
+
+ const publishedSkeletons: unknown[] = [];
+ const subscription = service.currentSkeleton$.subscribe((skeleton) => publishedSkeletons.push(skeleton));
+ const skeleton = service.recalculate();
+
+ expect(skeleton).toBe(service.getSkeleton());
+ expect(publishedSkeletons).toEqual([skeleton, skeleton]);
+ subscription.unsubscribe();
});
});
diff --git a/packages/docs/src/services/doc-skeleton-manager.service.ts b/packages/docs/src/services/doc-skeleton-manager.service.ts
index 1f1bc6dad1..cc02833fb1 100644
--- a/packages/docs/src/services/doc-skeleton-manager.service.ts
+++ b/packages/docs/src/services/doc-skeleton-manager.service.ts
@@ -77,6 +77,14 @@ export class DocSkeletonManagerService extends RxDisposable implements IRenderMo
return this._docViewModel;
}
+ recalculate(): DocumentSkeleton {
+ const skeleton = this._skeleton;
+ skeleton.calculate();
+ this._currentSkeletonBefore$.next(skeleton);
+ this._currentSkeleton$.next(skeleton);
+ return skeleton;
+ }
+
private _init() {
const documentDataModel = this._context.unit;
this._update(documentDataModel);
@@ -103,14 +111,7 @@ export class DocSkeletonManagerService extends RxDisposable implements IRenderMo
this._skeleton = this._buildSkeleton(this._docViewModel);
}
- const skeleton = this._skeleton;
- skeleton.calculate();
-
- // sub: packages/docs-ui/src/controllers/render-controllers/doc.render-controller.ts
- this._currentSkeletonBefore$.next(skeleton);
-
- // sub: packages/docs-ui/src/controllers/render-controllers/text-selection.render-controller.ts
- this._currentSkeleton$.next(skeleton);
+ this.recalculate();
// sub: packages/docs/src/services/doc-interceptor/doc-interceptor.service.ts
this._currentViewModel$.next(this._docViewModel);
diff --git a/packages/engine-render/src/basics/i-document-skeleton-cached.ts b/packages/engine-render/src/basics/i-document-skeleton-cached.ts
index 66fc2abee9..b1d97502be 100644
--- a/packages/engine-render/src/basics/i-document-skeleton-cached.ts
+++ b/packages/engine-render/src/basics/i-document-skeleton-cached.ts
@@ -304,6 +304,8 @@ export interface IDocumentSkeletonDrawing {
contentHeight?: number;
contentWidth?: number;
height?: number;
+ pageContentWidth?: number;
+ viewScale?: number;
viewportHeight?: number;
};
}
diff --git a/packages/engine-render/src/basics/tools.ts b/packages/engine-render/src/basics/tools.ts
index 8fa636e2f4..0aa2dfcab9 100644
--- a/packages/engine-render/src/basics/tools.ts
+++ b/packages/engine-render/src/basics/tools.ts
@@ -41,6 +41,11 @@ const PI_OVER_DEG180 = Math.PI / DEG180;
const DEG180_OVER_PI = DEG180 / Math.PI;
const RGB_PAREN = 'rgb(';
const RGBA_PAREN = 'rgba(';
+const SCROLLABLE_OVERFLOW_EPSILON = 0.5;
+
+export function hasScrollableOverflow(contentSize: number, viewportSize: number): boolean {
+ return contentSize - viewportSize > SCROLLABLE_OVERFLOW_EPSILON;
+}
// TODO :move to core @jerry
export const getColor = (RgbArray: number[], opacity?: number): string => {
diff --git a/packages/engine-render/src/components/docs/custom-block-render-viewport.ts b/packages/engine-render/src/components/docs/custom-block-render-viewport.ts
index ed67c2cb9d..529e3cc9ff 100644
--- a/packages/engine-render/src/components/docs/custom-block-render-viewport.ts
+++ b/packages/engine-render/src/components/docs/custom-block-render-viewport.ts
@@ -31,6 +31,8 @@ export interface IDocsCustomBlockRenderViewport {
height: number;
layoutWidth?: number;
offsetLeft?: number;
+ pageContentWidth?: number;
+ viewScale?: number;
viewportHeight?: number;
width: number;
}
diff --git a/packages/engine-render/src/components/docs/layout/block/paragraph/__tests__/layout-ruler.spec.ts b/packages/engine-render/src/components/docs/layout/block/paragraph/__tests__/layout-ruler.spec.ts
index 16ab3c3a4c..5959c4032e 100644
--- a/packages/engine-render/src/components/docs/layout/block/paragraph/__tests__/layout-ruler.spec.ts
+++ b/packages/engine-render/src/components/docs/layout/block/paragraph/__tests__/layout-ruler.spec.ts
@@ -808,6 +808,8 @@ describe('layout-ruler', () => {
contentHeight: 120,
contentWidth: 320,
height: 80,
+ pageContentWidth: 300,
+ viewScale: 1.5,
viewportHeight: 64,
layoutWidth: 180,
width: 180,
@@ -888,6 +890,8 @@ describe('layout-ruler', () => {
expect(drawing?.customBlockRenderViewport?.contentHeight).toBe(120);
expect(drawing?.customBlockRenderViewport?.contentWidth).toBe(320);
expect(drawing?.customBlockRenderViewport?.height).toBe(80);
+ expect(drawing?.customBlockRenderViewport?.pageContentWidth).toBe(300);
+ expect(drawing?.customBlockRenderViewport?.viewScale).toBe(1.5);
expect(drawing?.customBlockRenderViewport?.viewportHeight).toBe(64);
expect(drawing?.aTop).toBe(30);
});
diff --git a/packages/engine-render/src/components/docs/layout/block/paragraph/layout-ruler.ts b/packages/engine-render/src/components/docs/layout/block/paragraph/layout-ruler.ts
index aa9ee5b7fd..1189d76cca 100644
--- a/packages/engine-render/src/components/docs/layout/block/paragraph/layout-ruler.ts
+++ b/packages/engine-render/src/components/docs/layout/block/paragraph/layout-ruler.ts
@@ -1789,6 +1789,8 @@ export function updateInlineDrawingPosition(
contentHeight: viewport.contentHeight,
contentWidth: viewport.contentWidth,
height: viewport.height,
+ pageContentWidth: viewport.pageContentWidth,
+ viewScale: viewport.viewScale,
viewportHeight: viewport.viewportHeight,
}
: undefined;
@@ -1895,6 +1897,8 @@ function __getDrawingPosition(
contentHeight: viewport.contentHeight,
contentWidth: viewport.contentWidth,
height: viewport.height,
+ pageContentWidth: viewport.pageContentWidth,
+ viewScale: viewport.viewScale,
viewportHeight: viewport.viewportHeight,
}
: undefined;
diff --git a/packages/engine-render/src/shape/__tests__/scroll-bar.spec.ts b/packages/engine-render/src/shape/__tests__/scroll-bar.spec.ts
index 2ffae67c60..e6c10f5d48 100644
--- a/packages/engine-render/src/shape/__tests__/scroll-bar.spec.ts
+++ b/packages/engine-render/src/shape/__tests__/scroll-bar.spec.ts
@@ -129,6 +129,33 @@ describe('ScrollBar', () => {
scrollBar.dispose();
});
+ it('optionally hides unscrollable tracks and restores them when content overflows', () => {
+ const scrollBar = ScrollBar.attachTo(viewport, {
+ enableHorizontal: true,
+ enableVertical: true,
+ hideTrackWhenUnscrollable: true,
+ });
+
+ scrollBar.resize(160, 120, 100, 80);
+
+ expect(scrollBar.horizonScrollTrack?.visible).toBe(false);
+ expect(scrollBar.verticalScrollTrack?.visible).toBe(false);
+ expect(scrollBar.placeholderBarRect?.visible).toBe(false);
+
+ scrollBar.resize(160, 120, 160.5, 120.5);
+
+ expect(scrollBar.horizonScrollTrack?.visible).toBe(false);
+ expect(scrollBar.verticalScrollTrack?.visible).toBe(false);
+
+ scrollBar.resize(160, 120, 640, 480);
+
+ expect(scrollBar.horizonScrollTrack?.visible).toBe(true);
+ expect(scrollBar.verticalScrollTrack?.visible).toBe(true);
+ expect(scrollBar.placeholderBarRect?.visible).toBe(true);
+
+ scrollBar.dispose();
+ });
+
it('uses track clicks and thumb dragging to update viewport scroll', () => {
const scrollBar = new ScrollBar(viewport, { mainScene: scene });
const scrollToBarPos = vi.spyOn(viewport, 'scrollToBarPos');
diff --git a/packages/engine-render/src/shape/scroll-bar.ts b/packages/engine-render/src/shape/scroll-bar.ts
index 2ced170e85..178eba6889 100644
--- a/packages/engine-render/src/shape/scroll-bar.ts
+++ b/packages/engine-render/src/shape/scroll-bar.ts
@@ -22,6 +22,7 @@ import type { Scene } from '../scene';
import type { Viewport } from '../viewport';
import { Disposable, Tools } from '@univerjs/core';
import { Subscription } from 'rxjs';
+import { hasScrollableOverflow } from '../basics/tools';
import { Transform } from '../basics/transform';
import { Rect } from './rect';
@@ -48,6 +49,8 @@ export interface IScrollBarProps {
enableHorizontal?: boolean;
/** Enable the vertical scroll bar. True by default. */
enableVertical?: boolean;
+ /** Hide the track when the corresponding content axis does not overflow. False by default. */
+ hideTrackWhenUnscrollable?: boolean;
/** The min width of horizon thumb. Default is 17 px. */
minThumbSizeH?: number;
/** The min height of vertical thumb. Default is 17 px. */
@@ -56,14 +59,18 @@ export interface IScrollBarProps {
const MIN_THUMB_SIZE = 17;
const DEFAULT_TRACK_SIZE = 10;
+const DEFAULT_TRACK_BORDER_SIZE = 1;
const HOVER_TRACK_SIZE = 10;
const DEFAULT_THUMB_MARGIN = 2;
const HOVER_THUMB_MARGIN = 1;
const BAR_DRAG_SCROLL_THROTTLE_MS = 32;
export class ScrollBar extends Disposable {
+ static readonly DEFAULT_TOTAL_SIZE = DEFAULT_TRACK_SIZE + DEFAULT_TRACK_BORDER_SIZE;
+
_enableHorizontal: boolean = true;
_enableVertical: boolean = true;
+ private _hideTrackWhenUnscrollable = false;
horizontalThumbSize: number = 0;
horizontalMinusMiniThumb: number = 0;
@@ -121,7 +128,7 @@ export class ScrollBar extends Disposable {
private _hThumbMargin = DEFAULT_THUMB_MARGIN;
// origin: barBorder, used for strokeWidth of scroll track, is draw on the center of the track border, so the visible border thickness is barBorder / 2 at both side of the track, and the visible track thickness is `trackThickness - barBorder`.
- private _trackBorderThickness = 1;
+ private _trackBorderThickness = DEFAULT_TRACK_BORDER_SIZE;
private _thumbLengthRatio = 1;
/**
@@ -198,6 +205,22 @@ export class ScrollBar extends Disposable {
this._enableVertical = val;
}
+ get hideTrackWhenUnscrollable() {
+ return this._hideTrackWhenUnscrollable;
+ }
+
+ set hideTrackWhenUnscrollable(val: boolean) {
+ if (this._hideTrackWhenUnscrollable === val) {
+ return;
+ }
+
+ this._hideTrackWhenUnscrollable = val;
+ this._resizeHorizontal();
+ this._resizeVertical();
+ this._resizeRightBottomCorner();
+ this.makeDirty(true);
+ }
+
get limitX() {
if (!this.horizonThumbRect?.visible) {
return 0;
@@ -470,7 +493,11 @@ export class ScrollBar extends Disposable {
});
// content is smaller than viewport size
- if (this.horizontalThumbSize >= viewportW - (this._trackThickness + 2)) {
+ const scrollable = hasScrollableOverflow(contentWidth, viewportW);
+ this.horizonScrollTrack?.setProps({
+ visible: !this._hideTrackWhenUnscrollable || scrollable,
+ });
+ if (!scrollable) {
this.horizonThumbRect?.setProps({
visible: false,
});
@@ -517,7 +544,11 @@ export class ScrollBar extends Disposable {
});
// content is smaller than viewport size
- if (this.verticalThumbSize >= viewportH - this._trackThickness) {
+ const scrollable = hasScrollableOverflow(contentHeight, viewportH);
+ this.verticalScrollTrack?.setProps({
+ visible: !this._hideTrackWhenUnscrollable || scrollable,
+ });
+ if (!scrollable) {
this.verticalThumbRect?.setProps({
visible: false,
});
@@ -540,6 +571,10 @@ export class ScrollBar extends Disposable {
const viewportH = this._viewportH;
const viewportW = this._viewportW;
if (this._enableHorizontal && this._enableVertical) {
+ this.placeholderBarRect?.setProps({
+ visible: !this._hideTrackWhenUnscrollable
+ || Boolean(this.horizonScrollTrack?.visible && this.verticalScrollTrack?.visible),
+ });
this.placeholderBarRect?.transformByState({
left: viewportW - this._trackThickness,
top: viewportH - this._trackThickness,
diff --git a/packages/engine-render/src/viewport.ts b/packages/engine-render/src/viewport.ts
index 4c662808a5..f3f5e6bae5 100644
--- a/packages/engine-render/src/viewport.ts
+++ b/packages/engine-render/src/viewport.ts
@@ -25,7 +25,7 @@ import type { ScrollBar } from './shape/scroll-bar';
import { EventSubject, Tools } from '@univerjs/core';
import { Subject } from 'rxjs';
import { RENDER_CLASS_TYPE } from './basics/const';
-import { fixLineWidthByScale, toPx } from './basics/tools';
+import { fixLineWidthByScale, hasScrollableOverflow, toPx } from './basics/tools';
import { Transform } from './basics/transform';
import { Vector2 } from './basics/vector2';
import { subtractViewportRange } from './basics/viewport-subtract';
@@ -1087,10 +1087,10 @@ export class Viewport {
scrollX = scrollX ?? this.scrollX;
scrollY = scrollY ?? this.scrollY;
const { height, width } = this._calcViewPortSize();
- if (this._sceneWCurrVpAfterScale <= width) {
+ if (!hasScrollableOverflow(this._sceneWCurrVpAfterScale, width)) {
scrollX = 0;
}
- if (this._sceneHCurrVpAfterScale <= height) {
+ if (!hasScrollableOverflow(this._sceneHCurrVpAfterScale, height)) {
scrollY = 0;
}
diff --git a/packages/sheets-drawing-ui/src/services/__tests__/canvas-float-dom-manager.service.spec.ts b/packages/sheets-drawing-ui/src/services/__tests__/canvas-float-dom-manager.service.spec.ts
index eaa1ed49b4..6d9948ae76 100644
--- a/packages/sheets-drawing-ui/src/services/__tests__/canvas-float-dom-manager.service.spec.ts
+++ b/packages/sheets-drawing-ui/src/services/__tests__/canvas-float-dom-manager.service.spec.ts
@@ -25,6 +25,7 @@ import {
Disposable,
DrawingTypeEnum,
EventSubject,
+ IUniverInstanceService,
LifecycleService,
LifecycleStages,
LocaleType,
@@ -35,7 +36,7 @@ import { IRenderManagerService, Rect, SHEET_VIEWPORT_KEY, SpreadsheetSkeleton }
import { DrawingApplyType, InsertSheetDrawingCommand, ISheetDrawingService, RemoveSheetDrawingCommand, SetDrawingApplyMutation, SetSheetDrawingCommand } from '@univerjs/sheets-drawing';
import { ISheetSelectionRenderService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
import { CanvasFloatDomService } from '@univerjs/ui';
-import { BehaviorSubject, Subject } from 'rxjs';
+import { BehaviorSubject, of, Subject } from 'rxjs';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { createSheetsDrawingUiTestBed } from '../../__tests__/create-sheets-drawing-ui-test-bed';
import {
@@ -1998,9 +1999,10 @@ describe('SheetCanvasFloatDomManagerService', () => {
}));
});
- it('refreshes float dom position when the sheet viewport scrolls', () => {
+ it('refreshes float dom position when a non-current sheet renderer scrolls', () => {
const fixture = setup();
disposables.push(fixture);
+ vi.spyOn(fixture.get(IUniverInstanceService), 'getCurrentTypeOfUnit$').mockReturnValue(of(null));
fixture.get(LifecycleService).stage = LifecycleStages.Rendered;
const canvasFloatDomService = fixture.get(CanvasFloatDomService);
diff --git a/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts b/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
index b08463b43b..4518ad8e1e 100644
--- a/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
+++ b/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
@@ -1483,6 +1483,7 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
}
});
listener && disposableCollection.add(listener);
+ this._bindFloatDomScroll(disposableCollection, info, renderObject.renderUnit.scene, skeleton.skeleton, target.worksheet);
this._domLayerInfoMap.set(drawingId, info);
});
})
@@ -1546,32 +1547,6 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
})
);
- // #region scroll
- this.disposeWithMe(
- this._univerInstanceService.getCurrentTypeOfUnit$<Workbook>(UniverInstanceType.UNIVER_SHEET).pipe(
- switchMap((workbook) => workbook ? workbook.activeSheet$ : of(null)),
- map((worksheet) => {
- if (!worksheet) return null;
- const unitId = worksheet.getUnitId();
- const render = this._renderManagerService.getRenderUnitById(unitId);
- return render ? { render, unitId, subUnitId: worksheet.getSheetId() } : null;
- }),
- switchMap((render) =>
- render
- ? fromEventSubject(render.render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_MAIN)!.onScrollAfter$)
- .pipe(map(() => ({ unitId: render.unitId, subUnitId: render.subUnitId })))
- : of(null)
- )
- ).subscribe((value) => {
- if (!value) return; // TODO@weird94: maybe we should throw an error here and do some cleaning work?
-
- const { unitId, subUnitId } = value;
- updateSheet(unitId, subUnitId);
- })
- );
-
- //#endregion
-
// #region zoom
this.disposeWithMe(this._commandService.onCommandExecuted((commandInfo) => {
if (commandInfo.id === SetZoomRatioOperation.id) {
@@ -1592,6 +1567,23 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
//# endregion
}
+ private _bindFloatDomScroll(
+ disposableCollection: DisposableCollection,
+ info: ICanvasFloatDomInfo,
+ scene: Scene,
+ skeleton: SpreadsheetSkeleton,
+ worksheet: Worksheet
+ ): void {
+ const viewport = scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_MAIN);
+ if (!viewport) {
+ return;
+ }
+
+ disposableCollection.add(fromEventSubject(viewport.onScrollAfter$).subscribe(() => {
+ info.position$.next(calcSheetFloatDomPosition(info.rect, scene, skeleton, worksheet, info));
+ }));
+ }
+
updateFloatDomProps(unitId: string, subUnitId: string, id: string, props: Record<string, any>) {
const info = this._domLayerInfoMap.get(id);
const renderObject = this._getSceneAndTransformerByDrawingSearch(unitId);
@@ -2112,6 +2104,7 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
this._canvasFloatDomService.removeFloatDom(drawingId);
});
listener && disposableCollection.add(listener);
+ this._bindFloatDomScroll(disposableCollection, floatDomInfo, renderObject.renderUnit.scene, skeletonParam.skeleton, target.worksheet);
this._domLayerInfoMap.set(drawingId, floatDomInfo);
}
@@ -2352,6 +2345,7 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
this._canvasFloatDomService.removeFloatDom(drawingId);
});
listener && disposableCollection.add(listener);
+ this._bindFloatDomScroll(disposableCollection, floatDomInfo, renderObject.renderUnit.scene, skeleton.skeleton, target.worksheet);
this._domLayerInfoMap.set(drawingId, floatDomInfo);
}
diff --git a/packages/ui/src/services/dom/canvas-dom-layer.service.ts b/packages/ui/src/services/dom/canvas-dom-layer.service.ts
index bf1ec9571d..efad5e7b66 100644
--- a/packages/ui/src/services/dom/canvas-dom-layer.service.ts
+++ b/packages/ui/src/services/dom/canvas-dom-layer.service.ts
@@ -16,7 +16,7 @@
import type { IPosition, Serializable } from '@univerjs/core';
import type { Observable } from 'rxjs';
-import { Disposable } from '@univerjs/core';
+import { Disposable, toDisposable } from '@univerjs/core';
import { BehaviorSubject, Subject } from 'rxjs';
export interface IFloatDomLayout extends IPosition {
@@ -78,6 +78,7 @@ export function shouldRenderFloatDomLayer(layer: Pick<IFloatDom, 'unitId' | 'pre
export class CanvasFloatDomService extends Disposable {
private _domLayerMap = new Map<string, IFloatDom>();
+ private _scopedRenderRootCount = new Map<string, number>();
private _domLayers$ = new BehaviorSubject<[string, IFloatDom][]>([]);
domLayers$ = this._domLayers$.asObservable();
@@ -108,6 +109,29 @@ export class CanvasFloatDomService extends Disposable {
this._notice();
}
+ hasScopedRenderRoot(unitId: string): boolean {
+ return this._scopedRenderRootCount.has(unitId);
+ }
+
+ registerScopedRenderRoot(unitId: string) {
+ this._scopedRenderRootCount.set(unitId, (this._scopedRenderRootCount.get(unitId) ?? 0) + 1);
+ this._notice();
+
+ return toDisposable(() => {
+ const count = this._scopedRenderRootCount.get(unitId);
+ if (count == null) {
+ return;
+ }
+
+ if (count === 1) {
+ this._scopedRenderRootCount.delete(unitId);
+ } else {
+ this._scopedRenderRootCount.set(unitId, count - 1);
+ }
+ this._notice();
+ });
+ }
+
removeFloatDom(id: string): void {
if (this._domLayerMap.delete(id)) {
this._notice();
@@ -121,6 +145,7 @@ export class CanvasFloatDomService extends Disposable {
override dispose(): void {
this._domLayerMap.clear();
+ this._scopedRenderRootCount.clear();
this._domLayers$.next([]);
this._domLayers$.complete();
super.dispose();
diff --git a/packages/ui/src/views/components/dom/FloatDom.tsx b/packages/ui/src/views/components/dom/FloatDom.tsx
index 18133bafc0..e44b1001e5 100644
--- a/packages/ui/src/views/components/dom/FloatDom.tsx
+++ b/packages/ui/src/views/components/dom/FloatDom.tsx
@@ -160,7 +160,23 @@ export const FloatDom = ({ unitId }: { unitId?: string }) => {
const focusUnit = useObservable(instanceService.focused$);
const currentUnitId = resolveFloatDomCurrentUnitId(unitId, focusUnit);
- return layers?.filter((layer) => shouldRenderFloatDomLayer(layer[1], currentUnitId))?.map((layer) => (
+ useEffect(() => {
+ if (typeof unitId !== 'string') {
+ return;
+ }
+
+ const disposable = domLayerService.registerScopedRenderRoot(unitId);
+ return () => disposable.dispose();
+ }, [domLayerService, unitId]);
+
+ const visibleLayers = typeof unitId === 'string'
+ ? layers?.filter((layer) => layer[1].unitId === unitId)
+ : layers?.filter((layer) =>
+ !domLayerService.hasScopedRenderRoot(layer[1].unitId) &&
+ shouldRenderFloatDomLayer(layer[1], currentUnitId)
+ );
+
+ return visibleLayers?.map((layer) => (
<FloatDomSingle
id={layer[1].domId ?? layer[0]}
layer={layer[1]}
diff --git a/packages/ui/src/views/components/dom/__tests__/FloatDom.spec.tsx b/packages/ui/src/views/components/dom/__tests__/FloatDom.spec.tsx
index 156264f61d..09a22ef21d 100644
--- a/packages/ui/src/views/components/dom/__tests__/FloatDom.spec.tsx
+++ b/packages/ui/src/views/components/dom/__tests__/FloatDom.spec.tsx
@@ -227,6 +227,33 @@ describe('FloatDom', () => {
expect(document.getElementById('float-1')).not.toBeNull();
});
+ it('does not render preserved layers from another unit in an explicitly scoped root', () => {
+ const rendered = renderWithDependencies(<FloatDom unitId="sheet-1" />);
+
+ act(() => rendered.injector.get(CanvasFloatDomService).addFloatDom({
+ ...createFloatDom(),
+ preserveOnFocusChange: true,
+ }));
+
+ expect(screen.queryByText('float content')).toBeNull();
+ expect(document.getElementById('float-1')).toBeNull();
+ });
+
+ it('renders a unit only in its explicit root when the same unit is focused globally', async () => {
+ const rendered = renderWithDependencies(
+ <>
+ <div data-testid="global-root"><FloatDom /></div>
+ <div data-testid="scoped-root"><FloatDom unitId="doc-1" /></div>
+ </>,
+ { getUnitId: () => 'doc-1' }
+ );
+
+ act(() => rendered.injector.get(CanvasFloatDomService).addFloatDom(createFloatDom()));
+
+ await waitFor(() => expect(screen.getByTestId('scoped-root').textContent).toBe('float content'));
+ expect(screen.getByTestId('global-root').textContent).toBe('');
+ });
+
it('updates content box insets at runtime through CanvasFloatDomService', async () => {
const rendered = renderWithDependencies(<FloatDom unitId="doc-1" />);
const service = rendered.injector.get(CanvasFloatDomService);