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
fix(docs-ui): enable modern outlines and handle table overlap (#7904)
Univere38d22b802c0
diff --git a/packages/docs-ui/README.md b/packages/docs-ui/README.mdindex 0225b30140..a05ece521d 100644--- a/packages/docs-ui/README.md+++ b/packages/docs-ui/README.md@@ -34,6 +34,28 @@ univer.registerPlugin(UniverDocsUIPlugin);// Merge EnUS into your Univer locale map when this package contributes UI text.```+## Document outline (`toc`)++The optional `IUniverDocsUIConfig.toc` setting controls the left-hand document outline for heading navigation.++| `toc` | Modern documents | Traditional documents |+| --- | --- | --- |+| Omitted | Enabled | Disabled |+| `true` | Enabled | Enabled |+| `false` | Disabled | Disabled |++Set it when registering the plugin to override the document mode's default:++```ts+univer.registerPlugin(UniverDocsUIPlugin, {+ toc: false,+});+```++Preset integrations can pass the same option to `UniverDocsCorePreset({ container: 'app', toc: false })`.+When enabled, the outline collapses if there is insufficient space or table content overlaps it,+and reopens when the layout provides enough space without overlap.+## Format painterUse the shared Start ribbon format painter to copy character formatting. Include a paragraphdiff --git a/packages/docs-ui/src/config/config.ts b/packages/docs-ui/src/config/config.tsindex 311582ebf9..ea2b134725 100644--- a/packages/docs-ui/src/config/config.ts+++ b/packages/docs-ui/src/config/config.ts@@ -39,6 +39,11 @@ export interface IDocFitToWidthOptions {export interface IUniverDocsUIConfig {menu?: MenuConfig;container?: HTMLElement | string;+ /**+ * Show the left-hand document outline for heading navigation.+ * When omitted, enabled for modern documents and disabled for traditional documents.+ * Explicit `true` or `false` overrides the default in either document mode.+ */toc?: boolean;footer?: boolean;wordCount?: boolean;@@ -57,7 +62,6 @@ export const DEFAULT_DOC_FIT_TO_WIDTH_OPTIONS: Required<Omit<IDocFitToWidthOptio};export const defaultPluginConfig: IUniverDocsUIConfig = {- toc: false,footer: true,wordCount: true,placeholder: true,diff --git a/packages/docs-ui/src/views/DocSideMenu.tsx b/packages/docs-ui/src/views/DocSideMenu.tsxindex f0c91ce743..9739f7520a 100644--- a/packages/docs-ui/src/views/DocSideMenu.tsx+++ b/packages/docs-ui/src/views/DocSideMenu.tsx@@ -15,11 +15,8 @@*/import type { DocumentDataModel, IParagraph } from '@univerjs/core';-import type { IUniverDocsUIConfig } from '../config/config';-import type { LocaleKey } from '../locale/types';-import type { IMutiPageParagraphBound } from '../services/doc-event-manager.service';-import type { ISideMenuItem } from './SideMenu';import {+ DocumentFlavor,fromEventSubject,getParagraphContentStartOffsets,getPlainText,@@ -29,13 +26,23 @@ import {NamedStyleType,UniverInstanceType,} from '@univerjs/core';-import { IRenderManagerService } from '@univerjs/engine-render';+import {+ Documents,+ getDocsTableRenderViewport,+ getTableIdAndSliceIndex,+ IRenderManagerService,+} from '@univerjs/engine-render';import { IWorkbenchService, useConfigValue, useDependency, useEvent, useObservable } from '@univerjs/ui';-import { useEffect, useMemo, useState } from 'react';-import { auditTime, debounceTime, map, merge, startWith, throttleTime } from 'rxjs';+import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';+import { auditTime, debounceTime, distinctUntilChanged, map, merge, startWith, throttleTime } from 'rxjs';+import type { IUniverDocsUIConfig } from '../config/config';+import type { LocaleKey } from '../locale/types';+import type { IMutiPageParagraphBound } from '../services/doc-event-manager.service';+import type { ISideMenuItem } from './SideMenu';import { VIEWPORT_KEY } from '../basics/docs-view-key';import { DOCS_UI_PLUGIN_CONFIG_KEY } from '../config/config';import { DocEventManagerService } from '../services/doc-event-manager.service';+import { isDocSideMenuTableOverlapping } from './doc-side-menu-layout';import { SideMenu } from './SideMenu';const transformNamedStyleTypeToLevel = (type: NamedStyleType) => {@@ -91,14 +98,14 @@ export function DocSideMenu() {const workbenchService = useDependency(IWorkbenchService);const rootUnitType = useObservable(workbenchService.rootUnitType$, null, true);- if (rootUnitType === UniverInstanceType.UNIVER_DOC && config?.toc) {- return <DocSideMenuContent />;+ if (rootUnitType === UniverInstanceType.UNIVER_DOC && config?.toc !== false) {+ return <DocSideMenuContent toc={config?.toc} />;}return null;}-function DocSideMenuContent() {+function DocSideMenuContent({ toc }: { toc?: boolean }) {const instanceService = useDependency(IUniverInstanceService);const localeService = useDependency(LocaleService);const currentDoc = useObservable(@@ -107,6 +114,7 @@ function DocSideMenuContent() {false,[instanceService]);+ const enabled = toc ?? (currentDoc?.getSnapshot().documentStyle?.documentFlavor === DocumentFlavor.MODERN);const renderManagerService = useDependency(IRenderManagerService);const documentData = useObservable(currentDoc@@ -121,31 +129,56 @@ function DocSideMenuContent() {);const fullDataStream = documentData?.body?.dataStream ?? '';const [activeId, setActiveId] = useState<string | undefined>(undefined);+ const [outlineHeight, setOutlineHeight] = useState(0);+ const containerRef = useRef<HTMLDivElement>(null);const unitId = currentDoc?.getUnitId() ?? '';const renderer = renderManagerService.getRenderUnitById(unitId);const title = documentData?.title;const docEventManagerService = renderer?.with(DocEventManagerService);- const paragraphBounds = docEventManagerService?.paragraphBounds;- const readLayout = () => ({- left: renderer?.mainComponent?.left ?? 0,- canvasHeight: renderer?.engine.height ?? 0,- canvasWidth: renderer?.engine.width ?? 0,- scaleY: renderer?.scene.scaleY ?? 1,- });+ const viewport = renderer?.scene.getViewport(VIEWPORT_KEY.VIEW_MAIN);+ const readLayout = () => {+ const scaleX = renderer?.scene.scaleX ?? 1;+ const scaleY = renderer?.scene.scaleY ?? 1;+ const scrollX = viewport?.viewportScrollX ?? 0;+ const scrollY = viewport?.viewportScrollY ?? 0;+ const canvasHeight = renderer?.engine.height ?? 0;+ const left = ((renderer?.mainComponent?.left ?? 0) - scrollX) * scaleX;+ const outlineRect = {+ left: scrollX + 16 / scaleX,+ right: scrollX + 272 / scaleX,+ top: scrollY + 16 / scaleY,+ bottom: scrollY + Math.min(canvasHeight - 16, 16 + outlineHeight) / scaleY,+ };+ const overlapsTable = left >= 288 && outlineHeight > 0 && Array.from(docEventManagerService?.tableBounds.values() ?? []).some(({ tableId, rect }) =>+ isDocSideMenuTableOverlapping(+ outlineRect,+ rect,+ getDocsTableRenderViewport(unitId, getTableIdAndSliceIndex(tableId).tableId)+ )+ );++ return { left, canvasHeight, canvasWidth: renderer?.engine.width ?? 0, scaleY, overlapsTable };+ };const layout = useObservable(renderer?.engine.onTransformChange$? () => merge(fromEventSubject(renderer.engine.onTransformChange$),+ fromEventSubject(renderer.scene.onTransformChange$),+ ...(renderer.mainComponent instanceof Documents ? [renderer.mainComponent.pageRender$] : []),+ ...(viewport ? [fromEventSubject(viewport.onScrollAfter$)] : []),...(renderer.mainComponent ? [fromEventSubject(renderer.mainComponent.onTransformChange$)] : [])).pipe(auditTime(33),map(readLayout),- startWith(readLayout())+ startWith(readLayout()),+ distinctUntilChanged((previous, current) => previous.left === current.left &&+ previous.canvasHeight === current.canvasHeight && previous.canvasWidth === current.canvasWidth &&+ previous.scaleY === current.scaleY && previous.overlapsTable === current.overlapsTable)): null,readLayout(),false,- [renderer]+ [renderer, viewport, outlineHeight]);const { left, canvasHeight, canvasWidth, scaleY } = layout;@@ -158,7 +191,7 @@ function DocSideMenuContent() {});return map;}, [paragraphs]);- const mode = left < 240 ? 'float' : 'side-bar';+ const mode = left < 288 || layout.overlapsTable ? 'float' : 'side-bar';const paragraphMenus = paragraphs?.filter((p) =>p.paragraphStyle?.namedStyleType !== undefined &&@@ -179,7 +212,7 @@ function DocSideMenuContent() {const handleScroll = useEvent((params) => {const scrollTop = params.viewportScrollY;const bottom = scrollTop + (canvasHeight / scaleY);- const activeId = findActiveHeading(paragraphBounds, paragraphMap, scrollTop, bottom);+ const activeId = findActiveHeading(docEventManagerService?.paragraphBounds, paragraphMap, scrollTop, bottom);if (activeId) {setActiveId(activeId);}@@ -199,7 +232,29 @@ function DocSideMenuContent() {...(paragraphMenus ?? []),].filter(Boolean) as ISideMenuItem[];- const [open, setOpen] = useState(true);+ const outlineTitle = menus.find((menu) => menu.isTitle)?.text;+ useLayoutEffect(() => {+ setOutlineHeight(0);+ }, [unitId, menus.length, outlineTitle]);++ useLayoutEffect(() => {+ const container = containerRef.current;+ const menu = container?.firstElementChild;+ if (!container || !menu) {+ return;+ }++ const measureOutline = () => {+ const height = container.querySelector('nav')?.getBoundingClientRect().height;+ // Retain the expanded height so scrolling can reopen a collapsed outline safely.+ if (height) {+ setOutlineHeight(height);+ }+ };+ const observer = new ResizeObserver(measureOutline);+ observer.observe(menu);+ return () => observer.disconnect();+ }, [mode, unitId, menus.length, enabled]);useEffect(() => {const viewport = renderer?.scene.getViewport(VIEWPORT_KEY.VIEW_MAIN);@@ -229,7 +284,7 @@ function DocSideMenuContent() {if (!paragraph) {return;}- const bound = paragraphBounds?.get(paragraph.startIndex);+ const bound = docEventManagerService?.paragraphBounds.get(paragraph.startIndex);if (!bound) {return;}@@ -238,19 +293,19 @@ function DocSideMenuContent() {setActiveId(menu.id);});- if (!currentDoc || isInternalEditorID(unitId) || !menus?.length) {+ if (!enabled || !currentDoc || isInternalEditorID(unitId) || !menus?.length) {return null;}return (<div+ ref={containerRef}className="univer-absolute univer-bottom-0 univer-left-0 univer-top-0 univer-z-[100] univer-w-[0px]"><SideMenu+ key={mode}label={localeService.t<LocaleKey>('docs-ui.outline.title')}menus={menus}- open={open}- onOpenChange={setOpen}mode={mode}maxWidth={Math.max(0, Math.floor(mode === 'float' ? canvasWidth : left) - 24)}wrapperClass="univer-mt-4"diff --git a/packages/docs-ui/src/views/SideMenu.tsx b/packages/docs-ui/src/views/SideMenu.tsxindex 010761295a..c2d54526bf 100644--- a/packages/docs-ui/src/views/SideMenu.tsx+++ b/packages/docs-ui/src/views/SideMenu.tsx@@ -15,9 +15,9 @@*/import type { CSSProperties, KeyboardEvent } from 'react';-import { clsx, scrollbarClassName } from '@univerjs/design';+import { Button, clsx, scrollbarClassName } from '@univerjs/design';import { CatalogueIcon, MoreLeftIcon } from '@univerjs/icons';-import { forwardRef, useEffect, useId, useImperativeHandle, useMemo, useRef } from 'react';+import { forwardRef, useCallback, useEffect, useId, useImperativeHandle, useMemo, useRef, useState } from 'react';export interface ISideMenuItem {text: string;@@ -49,7 +49,15 @@ export interface ISideMenuInstance {}export const SideMenu = forwardRef<ISideMenuInstance, ISideMenuProps>((props, ref) => {- const { label, menus, onClick, className, style, mode, maxHeight, activeId, open, onOpenChange, maxWidth, wrapperClass, wrapperStyle, iconClass, iconStyle } = props;+ const { label, menus, onClick, className, style, mode = 'side-bar', maxHeight, activeId, open: controlledOpen, onOpenChange, maxWidth, wrapperClass, wrapperStyle, iconClass, iconStyle } = props;+ const [expanded, setExpanded] = useState(mode === 'side-bar');+ const open = controlledOpen ?? expanded;+ const handleOpenChange = useCallback((nextOpen: boolean) => {+ if (controlledOpen === undefined) {+ setExpanded(nextOpen);+ }+ onOpenChange?.(nextOpen);+ }, [controlledOpen, onOpenChange]);const panelId = useId();const wrapperRef = useRef<HTMLDivElement>(null);const containerRef = useRef<HTMLDivElement>(null);@@ -60,7 +68,9 @@ export const SideMenu = forwardRef<ISideMenuInstance, ISideMenuProps>((props, rescrollTo: (id: string) => {const container = containerRef.current;const target = itemsRef.current.get(id);- if (!container || !target) return;+ if (!container || !target) {+ return;+ }const top = target.offsetTop;const bottom = top + target.offsetHeight;@@ -81,28 +91,32 @@ export const SideMenu = forwardRef<ISideMenuInstance, ISideMenuProps>((props, re}, [activeId, instance, open]);useEffect(() => {- if (!open || mode !== 'float') return;+ if (!open || mode !== 'float') {+ return;+ }const handlePointerDown = (event: PointerEvent) => {if (event.target instanceof Node && !wrapperRef.current?.contains(event.target)) {- onOpenChange?.(false);+ handleOpenChange(false);}};document.addEventListener('pointerdown', handlePointerDown);return () => document.removeEventListener('pointerdown', handlePointerDown);- }, [mode, onOpenChange, open]);+ }, [handleOpenChange, mode, open]);const handleKeyDown = (event: KeyboardEvent<HTMLDivElement>) => {if (event.key === 'Escape' && open) {event.preventDefault();event.stopPropagation();- onOpenChange?.(false);+ handleOpenChange(false);toggleRef.current?.focus();return;}const items = Array.from(itemsRef.current.values());const index = items.indexOf(event.target as HTMLButtonElement);- if (index === -1) return;+ if (index === -1) {+ return;+ }let next: number;switch (event.key) {@@ -118,7 +132,8 @@ export const SideMenu = forwardRef<ISideMenuInstance, ISideMenuProps>((props, recase 'End':next = items.length - 1;break;- default: return;+ default:+ return;}event.preventDefault();event.stopPropagation();@@ -128,116 +143,87 @@ export const SideMenu = forwardRef<ISideMenuInstance, ISideMenuProps>((props, rereturn (<divref={wrapperRef}- className={clsx('univer-relative univer-ml-3', wrapperClass)}- style={{ width, ...wrapperStyle }}+ className={clsx('univer-relative univer-ms-4', wrapperClass)}+ style={{ width: open ? width : 32, ...wrapperStyle }}onKeyDown={handleKeyDown}>- <button+ <Buttonref={toggleRef}type="button"+ variant="ghost"+ size="icon"aria-label={label}aria-expanded={!!open}aria-controls={open ? panelId : undefined}title={label}- onClick={() => onOpenChange?.(!open)}+ onClick={() => handleOpenChange(!open)}className={clsx(`- univer-absolute univer-top-1.5 univer-z-10 univer-flex univer-size-8 univer-cursor-pointer- univer-items-center univer-justify-center univer-rounded-md univer-border-0 univer-bg-gray-0- univer-text-gray-500 univer-transition-colors- hover:univer-bg-gray-100 hover:univer-text-gray-900+ univer-absolute univer-start-0 univer-top-0 univer-z-10 !univer-text-gray-500+ hover:!univer-text-gray-900focus-visible:univer-outline focus-visible:univer-outline-2 focus-visible:univer-outline-primary-600- dark:univer-bg-gray-900 dark:univer-text-gray-400- dark:hover:univer-bg-gray-800- `, !open && 'univer-shadow-sm', iconClass)}- style={{ left: open ? width - 40 : 0, ...iconStyle }}+ dark:!univer-text-gray-400+ dark:hover:!univer-text-gray-100+ `, iconClass)}+ style={iconStyle}>- {open ? <MoreLeftIcon aria-hidden="true" /> : <CatalogueIcon aria-hidden="true" />}- </button>+ {open+ ? <MoreLeftIcon aria-hidden="true" className="!univer-size-6" />+ : <CatalogueIcon aria-hidden="true" className="!univer-size-5" />}+ </Button>{open && (<navid={panelId}aria-label={label}className={clsx(`- univer-box-border univer-flex univer-w-full univer-flex-col univer-overflow-hidden- univer-rounded-lg univer-border univer-border-solid univer-border-gray-200 univer-bg-gray-0- univer-text-gray-700- dark:univer-border-gray-700 dark:univer-bg-gray-900 dark:univer-text-gray-200- `, mode === 'float' ? 'univer-shadow-md' : 'univer-shadow-sm', className)}+ univer-box-border univer-flex univer-w-full univer-flex-col univer-overflow-hidden univer-pt-10+ `, mode === 'float' && `+ univer-bg-gray-0+ dark:univer-bg-gray-900+ `, className)}style={{ maxHeight, ...style }}>- <div- className="- univer-flex univer-h-11 univer-shrink-0 univer-items-center univer-gap-2 univer-px-3- univer-pr-12 univer-text-xs univer-font-medium univer-text-gray-500- dark:univer-text-gray-400- "- >- <CatalogueIcon aria-hidden="true" className="univer-shrink-0 univer-text-sm" />- <span className="univer-truncate">{label}</span>- </div><divref={containerRef}className={clsx(`- univer-relative univer-min-h-0 univer-overflow-y-auto univer-overscroll-contain univer-px-2- univer-pb-2+ univer-relative univer-min-h-0 univer-overflow-y-auto univer-overscroll-contain univer-pb-2`, scrollbarClassName)}><ol className="univer-m-0 univer-list-none univer-p-0">{menus?.map((menu) => (- <li key={menu.id} className={menu.isTitle ? 'univer-mb-1 univer-pb-1' : undefined}>+ <li key={menu.id} className={menu.isTitle ? 'univer-mb-2' : undefined}><buttonref={(element) => {- if (element) itemsRef.current.set(menu.id, element);- else itemsRef.current.delete(menu.id);+ if (element) {+ itemsRef.current.set(menu.id, element);+ } else {+ itemsRef.current.delete(menu.id);+ }}}type="button"aria-current={menu.id === activeId ? 'location' : undefined}title={menu.text}className={clsx(`- univer-relative univer-box-border univer-flex univer-min-h-8 univer-w-full- univer-cursor-pointer univer-items-center univer-rounded univer-border-0- univer-bg-transparent univer-py-1.5 univer-pr-2 univer-text-left+ univer-box-border univer-flex univer-min-h-8 univer-w-full+ univer-cursor-pointer univer-items-center univer-border-0+ univer-bg-transparent univer-py-1.5 univer-pe-2 univer-text-startuniver-text-sm univer-leading-5 univer-transition-colors- hover:univer-bg-gray-100focus-visible:univer-outline focus-visible:univer-outline-2focus-visible:-univer-outline-offset-2focus-visible:univer-outline-primary-600- dark:hover:univer-bg-gray-800- `, menu.isTitle ? 'univer-font-semibold' : 'univer-font-normal', {- 'univer-bg-primary-50 univer-text-primary-700 hover:univer-bg-primary-50 dark:univer-bg-gray-700 dark:univer-text-primary-200 dark:hover:univer-bg-gray-700': menu.id === activeId,- 'univer-text-gray-900 dark:univer-text-gray-100': menu.isTitle && menu.id !== activeId,- 'univer-text-gray-600 dark:univer-text-gray-300': !menu.isTitle && menu.id !== activeId,+ `, menu.isTitle ? 'univer-font-medium' : 'univer-font-normal', {+ 'univer-text-primary-600 dark:univer-text-primary-400': menu.id === activeId,+ 'univer-text-gray-600 hover:univer-text-gray-900 dark:univer-text-gray-300 dark:hover:univer-text-gray-100': menu.isTitle && menu.id !== activeId,+ 'univer-text-gray-500 hover:univer-text-gray-900 dark:univer-text-gray-400 dark:hover:univer-text-gray-100': !menu.isTitle && menu.id !== activeId,})}- style={{ paddingLeft: 10 + Math.max(0, menu.level - 1) * 12 }}+ style={{ paddingInlineStart: menu.isTitle ? 0 : 12 + Math.max(0, menu.level - 1) * 12 }}onClick={() => {onClick?.(menu);if (mode === 'float') {- onOpenChange?.(false);+ handleOpenChange(false);toggleRef.current?.focus();}}}>- {menu.level > 1 && (- <span- aria-hidden="true"- className="- univer-absolute univer-bottom-0 univer-top-0 univer-w-px- univer-bg-gray-200- dark:univer-bg-gray-700- "- style={{ left: 14 + Math.max(0, menu.level - 2) * 12 }}- />- )}- {menu.id === activeId && (- <span- aria-hidden="true"- className="- univer-absolute univer-bottom-2 univer-left-0 univer-top-2- univer-w-0.5 univer-rounded-full univer-bg-primary-600- dark:univer-bg-primary-400- "- />- )}<spanclassName={menu.isTitle? 'univer-line-clamp-2 univer-break-words'diff --git a/packages/docs-ui/src/views/__tests__/DocSideMenu.spec.tsx b/packages/docs-ui/src/views/__tests__/DocSideMenu.spec.tsxnew file mode 100644index 0000000000..55d530fbf6--- /dev/null+++ b/packages/docs-ui/src/views/__tests__/DocSideMenu.spec.tsx@@ -0,0 +1,219 @@+/**+ * Copyright 2023-present DreamNum Co., Ltd.+ *+ * 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 { DocumentDataModel, IDocumentData } from '@univerjs/core';+import type { RenderUnit } from '@univerjs/engine-render';+import type { Root } from 'react-dom/client';+import {+ DocumentFlavor,+ IConfigService,+ IUniverInstanceService,+ LocaleService,+ LocaleType,+ Univer,+ UniverInstanceType,+} from '@univerjs/core';+import { DocLayoutExecutorService, DocSkeletonManagerService } from '@univerjs/docs';+import {+ CanvasColorService,+ Documents,+ ICanvasColorService,+ IRenderManagerService,+ RenderManagerService,+ setDocsTableRenderViewportProvider,+ Viewport,+} from '@univerjs/engine-render';+import { IWorkbenchService, RediContext, WorkbenchService } from '@univerjs/ui';+import { act } from 'react';+import { createRoot } from 'react-dom/client';+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';+import { VIEWPORT_KEY } from '../../basics/docs-view-key';+import { genEmptyTable, genTableSource } from '../../commands/commands/table/table';+import { defaultPluginConfig, DOCS_UI_PLUGIN_CONFIG_KEY } from '../../config/config';+import enUS from '../../locale/en-US';+import { DocEventManagerService } from '../../services/doc-event-manager.service';+import { DocSideMenu } from '../DocSideMenu';++(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;++function createDocument(id: string, title: string): IDocumentData {+ const table = genEmptyTable(1, 1);+ const dataStream = `${table.dataStream}\r\n`;+ return {+ id,+ title,+ body: {+ ...table,+ dataStream,+ paragraphs: [...table.paragraphs, { startIndex: dataStream.length - 2, paragraphId: `${id}-tail` }],+ sectionBreaks: [...table.sectionBreaks, { startIndex: dataStream.length - 1, sectionId: `${id}-section` }],+ tables: [{ startIndex: 0, endIndex: table.dataStream.length, tableId: `${id}-table` }],+ },+ tableSource: { [`${id}-table`]: { ...genTableSource(1, 1, 1200), tableId: `${id}-table` } },+ documentStyle: {+ pageSize: { width: 1400, height: 1600 },+ marginLeft: 0,+ marginRight: 0,+ marginTop: 0,+ marginBottom: 0,+ },+ };+}++// DOM measurement and notifications are supplied by the browser in production.+class TestResizeObserver {+ private _timer: ReturnType<typeof setTimeout> | undefined;++ constructor(private readonly _callback: () => void) {}++ observe() {+ this._timer = setTimeout(this._callback, 0);+ }++ disconnect() {+ clearTimeout(this._timer);+ }+}++describe('DocSideMenu', () => {+ let univer: Univer;+ let root: Root;+ let container: HTMLDivElement;++ beforeEach(() => {+ vi.useFakeTimers();+ vi.stubGlobal('ResizeObserver', TestResizeObserver);+ const context = new Proxy({+ font: '',+ webkitBackingStorePixelRatio: 1,+ measureText: (text: string) => ({+ width: text.length * 8,+ actualBoundingBoxAscent: 8,+ actualBoundingBoxDescent: 2,+ fontBoundingBoxAscent: 8,+ fontBoundingBoxDescent: 2,+ }),+ }, { get: (target, key) => key in target ? Reflect.get(target, key) : () => {} });+ vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockReturnValue(context as never);+ const getBoundingClientRect = HTMLElement.prototype.getBoundingClientRect;+ vi.spyOn(HTMLElement.prototype, 'getBoundingClientRect').mockImplementation(function (this: HTMLElement) {+ if (this.tagName === 'NAV') {+ return { ...getBoundingClientRect.call(this), height: this.textContent?.includes('Tall outline') ? 300 : 80 };+ }+ return getBoundingClientRect.call(this);+ });+ univer = new Univer();+ const injector = univer.__getInjector();+ injector.add([IRenderManagerService, { useClass: RenderManagerService }]);+ injector.add([ICanvasColorService, { useClass: CanvasColorService }]);+ injector.add([DocLayoutExecutorService]);+ injector.add([IWorkbenchService, { useClass: WorkbenchService }]);+ injector.get(IWorkbenchService);+ const localeService = injector.get(LocaleService);+ localeService.load({ [LocaleType.EN_US]: enUS });+ localeService.setLocale(LocaleType.EN_US);+ localeService.setDirection('ltr');+ container = document.createElement('div');+ document.body.appendChild(container);+ root = createRoot(container);+ });++ afterEach(() => {+ act(() => root.unmount());+ univer.dispose();+ container.remove();+ setDocsTableRenderViewportProvider(null);+ vi.restoreAllMocks();+ vi.unstubAllGlobals();+ vi.clearAllTimers();+ vi.useRealTimers();+ });++ it.each([+ [DocumentFlavor.MODERN, undefined, true],+ [DocumentFlavor.TRADITIONAL, undefined, false],+ [DocumentFlavor.MODERN, false, false],+ [DocumentFlavor.TRADITIONAL, true, true],+ [DocumentFlavor.MODERN, true, true],+ [DocumentFlavor.TRADITIONAL, false, false],+ ])('applies outline visibility for flavor %s and toc %s', (documentFlavor, toc, visible) => {+ const injector = univer.__getInjector();+ injector.get(IConfigService).setConfig(DOCS_UI_PLUGIN_CONFIG_KEY, { ...defaultPluginConfig, toc });+ const data = createDocument('doc', 'Document title');+ data.documentStyle.documentFlavor = documentFlavor;+ univer.createUnit(UniverInstanceType.UNIVER_DOC, data);++ act(() => root.render(<RediContext.Provider value={{ injector }}><DocSideMenu /></RediContext.Provider>));++ expect(container.querySelector('button[aria-expanded]') !== null).toBe(visible);+ });++ it('updates the default outline visibility when switching between document modes', () => {+ const injector = univer.__getInjector();+ injector.get(IConfigService).setConfig(DOCS_UI_PLUGIN_CONFIG_KEY, defaultPluginConfig);+ for (const documentFlavor of [DocumentFlavor.MODERN, DocumentFlavor.TRADITIONAL]) {+ const data = createDocument(String(documentFlavor), 'Document title');+ data.documentStyle.documentFlavor = documentFlavor;+ univer.createUnit(UniverInstanceType.UNIVER_DOC, data);+ }+ act(() => root.render(<RediContext.Provider value={{ injector }}><DocSideMenu /></RediContext.Provider>));+ const instanceService = injector.get(IUniverInstanceService);+ for (const [documentFlavor, visible] of [[DocumentFlavor.MODERN, true], [DocumentFlavor.TRADITIONAL, false], [DocumentFlavor.MODERN, true]] as const) {+ act(() => instanceService.focusUnit(String(documentFlavor)));+ expect(container.querySelector('button[aria-expanded]') !== null).toBe(visible);+ }+ });++ it('remeasures a shorter document instead of retaining the previous collapsed outline height', () => {+ const injector = univer.__getInjector();+ injector.get(IConfigService).setConfig(DOCS_UI_PLUGIN_CONFIG_KEY, { toc: true });+ setDocsTableRenderViewportProvider(() => ({+ contentWidth: 1200,+ leadingInsetLeft: 384,+ viewportLeft: 16,+ viewportWidth: 1400,+ scrollLeft: 300,+ }));+ for (const [id, title] of [['tall', 'Tall outline'], ['short', 'Short outline']]) {+ univer.createUnit<IDocumentData, DocumentDataModel>(UniverInstanceType.UNIVER_DOC, createDocument(id, title));+ const render = injector.get(IRenderManagerService).createRender(id) as RenderUnit;+ render.deactivate();+ render.engine.resizeBySize(1400, 800);+ render.addRenderDependencies([[DocSkeletonManagerService]]);+ const documents = new Documents(id, render.with(DocSkeletonManagerService).getSkeleton());+ documents.translate(400, 200);+ render.mainComponent = documents;+ render.scene.addObject(documents);+ render.components.set(id, documents);+ render.disposeWithMe(new Viewport(VIEWPORT_KEY.VIEW_MAIN, render.scene));+ render.addRenderDependencies([[DocEventManagerService]]);+ expect(render.with(DocEventManagerService).tableBounds.size).toBe(1);+ }+ const instanceService = injector.get(IUniverInstanceService);+ act(() => {+ instanceService.focusUnit('tall');+ root.render(<RediContext.Provider value={{ injector }}><DocSideMenu /></RediContext.Provider>);+ });+ act(() => vi.advanceTimersByTime(150));+ expect(container.querySelector('button[aria-expanded="false"]')).not.toBeNull();+ expect(container.querySelector('nav')).toBeNull();++ act(() => instanceService.focusUnit('short'));+ act(() => vi.advanceTimersByTime(150));+ expect(container.querySelector('button[aria-expanded="true"]')).not.toBeNull();+ expect(container.querySelector('nav')?.textContent).toContain('Short outline');+ });+});diff --git a/packages/docs-ui/src/views/__tests__/SideMenu.spec.tsx b/packages/docs-ui/src/views/__tests__/SideMenu.spec.tsxindex be55a4d916..8def34ff97 100644--- a/packages/docs-ui/src/views/__tests__/SideMenu.spec.tsx+++ b/packages/docs-ui/src/views/__tests__/SideMenu.spec.tsx@@ -19,7 +19,6 @@ import type { Root } from 'react-dom/client';import { act, useState } from 'react';import { createRoot } from 'react-dom/client';import { afterEach, describe, expect, it, vi } from 'vitest';-import { SideMenu } from '../SideMenu';(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;@@ -30,17 +29,17 @@ const menus = [{ id: 'details', level: 2, text: 'Details' },];+function SideMenuExample({ menuProps }: { menuProps: Partial<ComponentProps<typeof SideMenu>> }) {+ const [open, setOpen] = useState(menuProps.open ?? true);+ return <SideMenu label="Document outline" menus={menus} maxHeight={180} {...menuProps} open={open} onOpenChange={setOpen} />;+}+function renderSideMenu(props: Partial<ComponentProps<typeof SideMenu>> = {}) {const container = document.createElement('div');document.body.appendChild(container);const root = createRoot(container);- function Example() {- const [open, setOpen] = useState(props.open ?? true);- return <SideMenu label="Document outline" menus={menus} maxHeight={180} {...props} open={open} onOpenChange={setOpen} />;- }-- act(() => root.render(<Example />));+ act(() => root.render(<SideMenuExample menuProps={props} />));return { container, root };}@@ -102,4 +101,24 @@ describe('SideMenu', () => {act(() => document.body.dispatchEvent(new Event('pointerdown', { bubbles: true })));expect(container.querySelector('nav') !== null).toBe(mode === 'side-bar');});++ it('starts floating outlines collapsed and allows opening them temporarily to navigate', () => {+ container = document.createElement('div');+ document.body.appendChild(container);+ root = createRoot(container);+ const onClick = vi.fn();+ act(() => root!.render(+ <SideMenu label="Document outline" menus={menus} maxHeight={180} mode="float" onClick={onClick} />+ ));++ const toggle = container.querySelector<HTMLButtonElement>('button[aria-expanded]')!;+ expect(toggle.getAttribute('aria-expanded')).toBe('false');+ expect(container.querySelector('nav')).toBeNull();+ act(() => toggle.click());+ expect(toggle.getAttribute('aria-expanded')).toBe('true');+ act(() => container.querySelector<HTMLButtonElement>('button[title="Details"]')!.click());+ expect(onClick).toHaveBeenCalledWith(menus[2]);+ expect(container.querySelector('nav')).toBeNull();+ expect(document.activeElement).toBe(toggle);+ });});diff --git a/packages/docs-ui/src/views/__tests__/doc-side-menu-layout.spec.ts b/packages/docs-ui/src/views/__tests__/doc-side-menu-layout.spec.tsnew file mode 100644index 0000000000..7448b42deb--- /dev/null+++ b/packages/docs-ui/src/views/__tests__/doc-side-menu-layout.spec.ts@@ -0,0 +1,52 @@+/**+ * Copyright 2023-present DreamNum Co., Ltd.+ *+ * 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 { IDocsTableRenderViewport } from '@univerjs/engine-render';+import { describe, expect, it } from 'vitest';+import { isDocSideMenuTableOverlapping } from '../doc-side-menu-layout';++const outline = { left: 16, right: 272, top: 16, bottom: 200 };+const table = { left: 420, right: 2340, top: 100, bottom: 280 };+const viewport: IDocsTableRenderViewport = {+ contentWidth: 1920,+ leadingInsetLeft: 404,+ scrollLeft: 0,+ viewportLeft: 16,+ viewportWidth: 1408,+};++describe('document outline table overlap', () => {+ it('keeps the outline open while the table starts at the paragraph origin', () => {+ expect(isDocSideMenuTableOverlapping(outline, table, viewport)).toBe(false);+ });++ it('detects content scrolled into the outline instead of treating the empty leading inset as content', () => {+ expect(isDocSideMenuTableOverlapping(outline, table, { ...viewport, scrollLeft: 200 })).toBe(true);+ expect(isDocSideMenuTableOverlapping(outline, table, { ...viewport, scrollLeft: 148 })).toBe(false);+ });++ it('allows reopening after the table scrolls outside the outline vertically', () => {+ const scrolled = { ...viewport, scrollLeft: 400 };+ expect(isDocSideMenuTableOverlapping(outline, { ...table, top: 200, bottom: 380 }, scrolled)).toBe(false);+ expect(isDocSideMenuTableOverlapping(outline, { ...table, top: -180, bottom: 0 }, scrolled)).toBe(false);+ });++ it('honors clipping and handles tables without a horizontal viewport', () => {+ expect(isDocSideMenuTableOverlapping(outline, table, { ...viewport, scrollLeft: 400, viewportLeft: 300 })).toBe(false);+ expect(isDocSideMenuTableOverlapping(outline, table, null)).toBe(false);+ expect(isDocSideMenuTableOverlapping(outline, { ...table, left: 100 }, null)).toBe(true);+ });+});diff --git a/packages/docs-ui/src/views/doc-side-menu-layout.ts b/packages/docs-ui/src/views/doc-side-menu-layout.tsnew file mode 100644index 0000000000..7cd59fa8ab--- /dev/null+++ b/packages/docs-ui/src/views/doc-side-menu-layout.ts@@ -0,0 +1,37 @@+/**+ * Copyright 2023-present DreamNum Co., Ltd.+ *+ * 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 { IBoundRectNoAngle, IDocsTableRenderViewport } from '@univerjs/engine-render';++export function isDocSideMenuTableOverlapping(+ outline: IBoundRectNoAngle,+ table: IBoundRectNoAngle,+ viewport: IDocsTableRenderViewport | null+): boolean {+ if (table.bottom <= outline.top || table.top >= outline.bottom) {+ return false;+ }++ let left = table.left;+ let right = table.right;+ if (viewport && (viewport.leadingInsetLeft ?? 0) + viewport.contentWidth + (viewport.trailingInsetRight ?? 0) > viewport.viewportWidth) {+ const clipLeft = viewport.viewportLeft ?? table.left - (viewport.leadingInsetLeft ?? 0);+ left = Math.max(clipLeft, table.left - viewport.scrollLeft);+ right = Math.min(clipLeft + viewport.viewportWidth, table.left + viewport.contentWidth - viewport.scrollLeft);+ }++ return right > left && left < outline.right && right > outline.left;+}