@univerjs/ui 1.0.0-alpha.2 → 1.0.0-alpha.3

package/lib/types/facade/f-menu-builder.d.ts

@@ -133,6 +133,7 @@ export declare class FMenu extends FMenuBase {
     constructor(_item: IFacadeMenuItem, _injector: Injector, _commandService: ICommandService, _menuManagerService: IMenuManagerService);
     /**
      * @ignore
+     * @returns The generated menu schema.
      */
     __getSchema(): {
         [key: string]: MenuSchemaType;
@@ -223,6 +224,7 @@ export declare class FSubmenu extends FMenuBase {
     addSeparator(): this;
     /**
      * @ignore
+     * @returns The generated submenu schema.
      */
     __getSchema(): {
         [key: string]: MenuSchemaType;

package/lib/types/index.d.ts

@@ -41,8 +41,8 @@ export { ContextMenuService, IContextMenuService } from './services/contextmenu/
 export type { IContextMenuHandler } from './services/contextmenu/contextmenu.service';
 export { DesktopDialogService } from './services/dialog/desktop-dialog.service';
 export { IDialogService } from './services/dialog/dialog.service';
-export { CanvasFloatDomService } from './services/dom/canvas-dom-layer.service';
-export type { IFloatDom, IFloatDomLayout } from './services/dom/canvas-dom-layer.service';
+export { CanvasFloatDomPreviewService, CanvasFloatDomService } from './services/dom/canvas-dom-layer.service';
+export type { ICanvasFloatDomPreview, ICanvasFloatDomPreviewRequest, IFloatDom, IFloatDomLayout } from './services/dom/canvas-dom-layer.service';
 export { FontService, IFontService } from './services/font.service';
 export type { IFontConfig } from './services/font.service';
 export { DesktopGalleryService } from './services/gallery/desktop-gallery.service';
@@ -67,7 +67,11 @@ export { BuiltInUIPart, IUIPartsService, UIPartsService } from './services/parts
 export { IPlatformService, PlatformService } from './services/platform/platform.service';
 export { CanvasPopupService, ICanvasPopupService } from './services/popup/canvas-popup.service';
 export type { IPopup } from './services/popup/canvas-popup.service';
+export { IRibbonOverrideService, RibbonOverrideService } from './services/ribbon/ribbon-override.service';
+export type { IRibbonOverride } from './services/ribbon/ribbon-override.service';
 export { DesktopRibbonService, IRibbonService } from './services/ribbon/ribbon.service';
+export { IUIRuntimeScopeService, UIRuntimeScopeService } from './services/runtime-scope/ui-runtime-scope.service';
+export type { IUIRuntimeScope } from './services/runtime-scope/ui-runtime-scope.service';
 export { KeyCode, MetaKeys } from './services/shortcut/keycode';
 export { ShortcutPanelService } from './services/shortcut/shortcut-panel.service';
 export { IShortcutService, ShortcutService } from './services/shortcut/shortcut.service';

package/lib/types/services/contextmenu/contextmenu.service.d.ts

@@ -16,9 +16,12 @@
 import type { IDisposable } from '@univerjs/core';
 import type { IMouseEvent, IPointerEvent } from '@univerjs/engine-render';
 import { Disposable } from '@univerjs/core';
+export interface IContextMenuTriggerContext {
+    unitId?: string;
+}
 export interface IContextMenuHandler {
     /** A callback to open context menu with given position and menu type. */
-    handleContextMenu(event: IPointerEvent | IMouseEvent, menuType: string): void;
+    handleContextMenu(event: IPointerEvent | IMouseEvent, menuType: string, context?: IContextMenuTriggerContext): void;
     hideContextMenu(): void;
     get visible(): boolean;
 }
@@ -27,7 +30,7 @@ export interface IContextMenuService {
     get visible(): boolean;
     enable(): void;
     disable(): void;
-    triggerContextMenu(event: IPointerEvent | IMouseEvent, menuType: string): void;
+    triggerContextMenu(event: IPointerEvent | IMouseEvent, menuType: string, context?: IContextMenuTriggerContext): void;
     hideContextMenu(): void;
     registerContextMenuHandler(handler: IContextMenuHandler): IDisposable;
 }
@@ -38,7 +41,7 @@ export declare class ContextMenuService extends Disposable implements IContextMe
     get visible(): boolean;
     disable(): void;
     enable(): void;
-    triggerContextMenu(event: IPointerEvent | IMouseEvent, menuType: string): void;
+    triggerContextMenu(event: IPointerEvent | IMouseEvent, menuType: string, context?: IContextMenuTriggerContext): void;
     hideContextMenu(): void;
     registerContextMenuHandler(handler: IContextMenuHandler): IDisposable;
 }

package/lib/types/services/dom/canvas-dom-layer.service.d.ts

@@ -15,6 +15,8 @@
  */
 import type { IPosition, Serializable } from '@univerjs/core';
 import type { Observable } from 'rxjs';
+import { Disposable } from '@univerjs/core';
+import { Subject } from 'rxjs';
 export interface IFloatDomLayout extends IPosition {
     rotate: number;
     width: number;
@@ -25,11 +27,34 @@ export interface IFloatDomLayout extends IPosition {
     };
     opacity?: number;
 }
+export interface IFloatDomContentBoxConfig {
+    /** Amount subtracted from the visible wrapper width and height. @default 2 */
+    wrapperInset?: number;
+    /** Amount subtracted from the content width and height. @default 4 */
+    contentInset?: number;
+}
 export interface IFloatDom {
     position$: Observable<IFloatDomLayout>;
     id: string;
     domId?: string;
     componentKey: string | React.ComponentType;
+    /**
+     * Whether pointer and wheel events inside the floating DOM should be
+     * forwarded back to the host canvas. Existing canvas-owned float DOMs keep
+     * forwarding by default; interactive embed runtimes can opt out.
+     */
+    eventPassThrough?: boolean;
+    /**
+     * Keep rendering this host-owned layer even when focus temporarily moves
+     * into a child runtime unit. Interactive embed float blocks need this so
+     * their DOM portal is not filtered out when the child handles focus.
+     */
+    preserveOnFocusChange?: boolean;
+    /**
+     * Insets subtracted from FloatDom's wrapper and content dimensions.
+     * Omitted values preserve the historical wrapper/content insets of 2/4.
+     */
+    contentBox?: IFloatDomContentBoxConfig;
     onPointerMove: (evt: PointerEvent | MouseEvent) => void;
     onPointerDown: (evt: PointerEvent | MouseEvent) => void;
     onPointerUp: (evt: PointerEvent | MouseEvent) => void;
@@ -38,7 +63,9 @@ export interface IFloatDom {
     data?: Serializable;
     unitId: string;
 }
-export declare class CanvasFloatDomService {
+export declare function shouldForwardFloatDomEvents(layer: Pick<IFloatDom, 'eventPassThrough'>): boolean;
+export declare function shouldRenderFloatDomLayer(layer: Pick<IFloatDom, 'unitId' | 'preserveOnFocusChange'>, currentUnitId: string | null | undefined): boolean;
+export declare class CanvasFloatDomService extends Disposable {
     private _domLayerMap;
     private _domLayers$;
     domLayers$: Observable<[string, IFloatDom][]>;
@@ -48,4 +75,28 @@ export declare class CanvasFloatDomService {
     addFloatDom(item: IFloatDom): void;
     removeFloatDom(id: string): void;
     removeAll(): void;
+    dispose(): void;
+}
+export interface ICanvasFloatDomPreview {
+    id: string;
+    image: string;
+    updatedAt: number;
+}
+export interface ICanvasFloatDomPreviewRequest {
+    id: string;
+    width: number;
+    height: number;
+    data?: unknown;
+}
+export declare class CanvasFloatDomPreviewService extends Disposable {
+    readonly previewUpdated$: Subject<ICanvasFloatDomPreview>;
+    readonly previewRequested$: Subject<ICanvasFloatDomPreviewRequest>;
+    private readonly _previewMap;
+    private readonly _requestMap;
+    getPreview(id: string): ICanvasFloatDomPreview | undefined;
+    getPendingRequests(): ICanvasFloatDomPreviewRequest[];
+    setPreview(preview: ICanvasFloatDomPreview): void;
+    removePreview(id: string): void;
+    requestPreview(request: ICanvasFloatDomPreviewRequest): void;
+    dispose(): void;
 }

package/lib/types/services/menu/menu-manager.service.d.ts

@@ -69,6 +69,7 @@ export declare class MenuManagerService extends Disposable implements IMenuManag
      */
     mergeMenu(source: MenuSchemaType, target?: MenuSchemaType): void;
     appendRootMenu(source: MenuSchemaType): void;
+    createScoped(injector: Injector): IMenuManagerService;
     private _buildMenuSchema;
     /**
      * Get menu schema by position key

package/lib/types/services/popup/canvas-popup.service.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Nullable } from '@univerjs/core';
+import type { Injector, Nullable } from '@univerjs/core';
 import type { IBoundRectNoAngle } from '@univerjs/engine-render';
 import type { Observable } from 'rxjs';
 import type { IRectPopupProps } from '../../views/components/popup/RectPopup';
@@ -24,6 +24,7 @@ export interface IPopup<T = Record<string, unknown>> extends Omit<IRectPopupProp
     excludeRects$?: Observable<IBoundRectNoAngle[]>;
     excludeRects?: Nullable<IBoundRectNoAngle[]>;
     componentKey: string;
+    connectorInjector?: Injector;
     unitId: string;
     subUnitId: string;
     offset?: [number, number];

package/lib/types/services/ribbon/ribbon-override.service.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { Injector } from '@univerjs/core';
+import type { Observable } from 'rxjs';
+import type { IRibbonService } from './ribbon.service';
+import { Disposable } from '@univerjs/core';
+export interface IRibbonOverride {
+    id: string;
+    ribbonService: IRibbonService;
+    injector?: Pick<Injector, 'get' | 'has' | 'invoke'>;
+    portalContainer?: HTMLElement | null;
+    placeholderTitle?: string;
+    hideToolbar?: boolean;
+}
+export interface IRibbonOverrideService {
+    readonly override$: Observable<IRibbonOverride | null>;
+    getOverride(): IRibbonOverride | null;
+    activate(override: IRibbonOverride): void;
+    clear(id?: string): void;
+}
+export declare const IRibbonOverrideService: import("@wendellhu/redi").IdentifierDecorator<IRibbonOverrideService>;
+export declare class RibbonOverrideService extends Disposable implements IRibbonOverrideService {
+    private readonly _override$;
+    readonly override$: Observable<IRibbonOverride | null>;
+    getOverride(): IRibbonOverride | null;
+    activate(override: IRibbonOverride): void;
+    clear(id?: string): void;
+    dispose(): void;
+}

package/lib/types/services/runtime-scope/ui-runtime-scope.service.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { IDisposable } from '@univerjs/core';
+import { Disposable } from '@univerjs/core';
+export interface IUIRuntimeScope {
+    unitId: string;
+    has(identifier: unknown): boolean;
+    get<T = unknown>(identifier: unknown): T;
+}
+export interface IUIRuntimeScopeService {
+    register(scope: IUIRuntimeScope): IDisposable;
+    get(unitId: string | null | undefined): IUIRuntimeScope | undefined;
+}
+export declare const IUIRuntimeScopeService: import("@wendellhu/redi").IdentifierDecorator<IUIRuntimeScopeService>;
+export declare class UIRuntimeScopeService extends Disposable implements IUIRuntimeScopeService {
+    private readonly _scopes;
+    register(scope: IUIRuntimeScope): IDisposable;
+    get(unitId: string | null | undefined): IUIRuntimeScope | undefined;
+}

package/lib/types/services/shortcut/shortcut.service.d.ts

@@ -15,10 +15,10 @@
  */
 import type { IDisposable } from '@univerjs/core';
 import type { Observable } from 'rxjs';
-import type { KeyCode } from './keycode';
 import { Disposable, ICommandService, IContextService } from '@univerjs/core';
 import { ILayoutService } from '../layout/layout.service';
 import { IPlatformService } from '../platform/platform.service';
+import { KeyCode } from './keycode';
 /**
  * A shortcut item that could be registered to the {@link IShortcutService}.
  */
@@ -154,4 +154,5 @@ export declare class ShortcutService extends Disposable implements IShortcutServ
     dispatch(e: KeyboardEvent): IShortcutItem<object> | undefined;
     private _getBindingFromItem;
     private _deriveBindingFromEvent;
+    private _shouldLetEmbedTextEditorHandleNativeShortcut;
 }

package/lib/types/utils/embed-boundary.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+export declare const EMBED_INTERACTION_BOUNDARY_OWNER_ATTRIBUTE = "data-embed-interaction-boundary-owner";
+export declare function getEmbedBoundaryOwner(target: EventTarget | null): string | undefined;
+export declare function isEmbedBoundaryTarget(target: EventTarget | null): boolean;
+export declare function keepInteractionInsideSameEmbedBoundary(event: {
+    currentTarget: EventTarget | null;
+    target: EventTarget | null;
+    preventDefault: () => void;
+}): void;

package/lib/types/utils/index.d.ts

@@ -15,5 +15,6 @@
  */
 export * from './cell';
 export * from './di';
+export * from './embed-boundary';
 export * from './html';
 export * from './util';

package/lib/types/views/components/context-menu/AnchoredContextMenu.d.ts

@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { ILayoutService } from '../../../services/layout/layout.service';
 import type { IValueOption } from '../../../services/menu/menu';
+import type { IMenuManagerService } from '../../../services/menu/menu-manager.service';
 export interface IContextMenuAnchorRect {
     left: number;
     top: number;
@@ -26,6 +28,8 @@ export interface IAnchoredContextMenuProps {
     menuType: string;
     anchorVertical?: 'top' | 'bottom';
     menuOffset?: number;
+    menuManagerService?: IMenuManagerService;
+    layoutService?: ILayoutService;
     onRequestClose: () => void;
     onOptionSelect?: (option: IValueOption) => void;
 }

package/lib/types/views/components/context-menu/ContextMenuPanel.d.ts

@@ -15,10 +15,14 @@
  */
 import type { IValueOption } from '../../../services/menu/menu';
 import type { IMenuSchema } from '../../../services/menu/menu-manager.service';
+import { ILayoutService } from '../../../services/layout/layout.service';
+import { IMenuManagerService } from '../../../services/menu/menu-manager.service';
 type ContextMenuSizeVariant = 'default' | 'paragraph-t';
 type ContextMenuAutoFocusTarget = 'first-item' | 'container';
 interface IContextMenuPanelProps {
     menuType: string;
+    menuManagerService?: IMenuManagerService;
+    layoutService?: ILayoutService;
     menuSessionVersion?: number;
     className?: string;
     activeItemIds?: string[];

package/lib/types/views/components/dom/FloatDom.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { CSSProperties } from 'react';
 import type { IFloatDom } from '../../../services/dom/canvas-dom-layer.service';
 export declare const FloatDomSingle: import("react").MemoExoticComponent<(props: {
     layer: IFloatDom;
@@ -21,3 +22,13 @@ export declare const FloatDomSingle: import("react").MemoExoticComponent<(props:
 export declare const FloatDom: ({ unitId }: {
     unitId?: string;
 }) => import("react").JSX.Element[] | undefined;
+export declare function resolveFloatDomCurrentUnitId(unitId: string | undefined, focusedUnit: unknown): string | null;
+export declare function resolveFloatDomOverflow(props: {
+    customBlockRenderViewport?: {
+        bleedLeft?: number;
+        bleedWidth?: number;
+    };
+}): {
+    outerOverflow: CSSProperties['overflow'];
+    innerOverflow: CSSProperties['overflow'];
+};

package/lib/types/views/components/dom/float-dom-layout.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { IFloatDomContentBoxConfig, IFloatDomLayout } from '../../../services/dom/canvas-dom-layer.service';
+export interface IFloatDomLayoutStyle {
+    wrapper: {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+        transform: string;
+        opacity: number;
+    };
+    inner: {
+        width: number;
+        height: number;
+        left: number | 'auto';
+        top: number | 'auto';
+        right: number | 'auto';
+        bottom: number | 'auto';
+    };
+}
+export declare function resolveFloatDomLayout(position: IFloatDomLayout, contentBox?: IFloatDomContentBoxConfig): IFloatDomLayoutStyle;

package/lib/types/views/components/ribbon/Ribbon.d.ts

@@ -19,6 +19,8 @@ interface IRibbonProps {
     ribbonType: RibbonType;
     headerMenuComponents?: Set<ComponentType>;
     headerMenu?: boolean;
+    toolbarOnly?: boolean;
+    headerClassName?: string;
 }
 export declare function Ribbon(props: IRibbonProps): import("react").JSX.Element;
 export {};

package/lib/types/views/components/ribbon/TooltipButtonWrapper.d.ts

@@ -19,7 +19,12 @@ import type { IMenuItem, IValueOption } from '../../../services/menu/menu';
 export interface ITooltipWrapperRef {
     el: HTMLSpanElement | null;
 }
-export declare const TooltipWrapper: import("react").ForwardRefExoticComponent<ITooltipProps & import("react").RefAttributes<ITooltipWrapperRef>>;
+export declare function ToolbarDropdownProvider(props: {
+    children: ReactNode;
+}): import("react").JSX.Element;
+export declare const TooltipWrapper: import("react").ForwardRefExoticComponent<ITooltipProps & {
+    dropdownKey?: string;
+} & import("react").RefAttributes<ITooltipWrapperRef>>;
 export declare function DropdownWrapper(props: Omit<Partial<IDropdownProps>, 'overlay'> & {
     overlay: ReactNode;
     align?: 'start' | 'end' | 'center';

package/lib/types/views/emoji-picker/emoji-picker-utils.d.ts

@@ -27,7 +27,7 @@ export type EmojiCategory = Exclude<keyof typeof emojis, 'frequent'>;
 export declare const EMOJI_RECENT_LIMIT = 11;
 export declare const EMOJI_CATEGORIES: {
     key: EmojiCategory;
-    titleKey: string;
+    titleKey: "ui.shortcut-panel.title" | "ui.fontFamily.arial" | "ui.fontFamily.times-new-roman" | "ui.fontFamily.tahoma" | "ui.fontFamily.verdana" | "ui.fontFamily.microsoft-yahei" | "ui.fontFamily.simsun" | "ui.fontFamily.simhei" | "ui.fontFamily.kaiti" | "ui.fontFamily.fangsong" | "ui.fontFamily.nsimsun" | "ui.fontFamily.stxinwei" | "ui.fontFamily.stxingkai" | "ui.fontFamily.stliti" | "ui.shortcut.copy" | "ui.common-edit" | "ui.shortcut.cut" | "ui.shortcut.paste" | "ui.shortcut.undo" | "ui.shortcut.redo" | "ui.ribbon.start" | "ui.ribbon.insert" | "ui.ribbon.formulas" | "ui.ribbon.data" | "ui.ribbon.view" | "ui.ribbon.others" | "ui.shortcut.shortcut-panel" | "ui.global-shortcut" | "ui.row" | "ui.column" | "ui.toggle-shortcut-panel" | "ui.fontFamily.not-supported" | "ui.toolbar.heading.title" | "ui.toolbar.heading.normal" | "ui.toolbar.heading.tooltip" | "ui.toolbar.heading.subTitle" | "ui.ribbon.startDesc" | "ui.ribbon.insertDesc" | "ui.ribbon.formulasDesc" | "ui.ribbon.dataDesc" | "ui.ribbon.viewDesc" | "ui.ribbon.othersDesc" | "ui.ribbon.more" | "ui.clipboard.authentication.title" | "ui.clipboard.authentication.content" | "ui.emojiPicker.search" | "ui.emojiPicker.objects" | "ui.emojiPicker.random" | "ui.emojiPicker.recents" | "ui.emojiPicker.emojis" | "ui.emojiPicker.animals" | "ui.emojiPicker.food" | "ui.emojiPicker.activities" | "ui.emojiPicker.places" | "ui.emojiPicker.symbols" | "ui.emojiPicker.searchResults" | "ui.emojiPicker.noResults" | `ui.emojiPicker.emojiSearchIndex.${string}` | `ui.emojiPicker.emojiTitles.${string}` | "ui.textEditor.formulaError" | "ui.textEditor.rangeError" | "ui.rangeSelector.title" | "ui.rangeSelector.cancel" | "ui.rangeSelector.addAnotherRange" | "ui.rangeSelector.buttonTooltip" | "ui.rangeSelector.placeHolder" | "ui.rangeSelector.confirm" | "ui.zoom-slider.resetTo";
 }[];
 export declare function getDefaultRecentEmojis(): IEmojiItem[];
 export declare function getAllEmojis(): IEmojiItem[];

package/lib/types/views/menu/mobile/MobileMenu.d.ts

@@ -15,8 +15,10 @@
  */
 import type { IMenuSchema } from '../../../services/menu/menu-manager.service';
 import type { IBaseMenuProps } from '../types';
+import { IMenuManagerService } from '../../../services/menu/menu-manager.service';
 interface IMobileMenuProps extends IBaseMenuProps {
     schemas?: IMenuSchema[];
+    menuManagerService?: IMenuManagerService;
 }
 export declare function MobileMenu(props: IMobileMenuProps): import("react").JSX.Element | null;
 export {};