API Reference

@univerjs/ui

Shared application UI framework, workbench services, menus, dialogs, and Facade UI APIs for Univer.

TypeScript
import { UniverUIPlugin } from '@univerjs/ui'univer.registerPlugin(UniverUIPlugin, config)

Entry Points

  • Facade: @univerjs/ui/facade
  • Locale: @univerjs/ui/locale/*

Unit presence and undo/redo groups

The root entry exports IUnitPresenceUIAdapterRegistry, UnitPresenceUIAdapterRegistry, IUnitPresenceUIAdapter, local and remote presence-state types, IUnitPresencePoint, and UndoRedoGroupService.

Use HoverTrack with HOVER_TRACK_HOST_CLASS_NAME for themed hover tracking. preventBrowserZoomInContainers() blocks browser zoom only inside the supplied containers.

Mobile hosts can use MOBILE_UI_MODE, MobileDialogService, MobileDrawer, MobileDrawerSnap, and MobileMenu. The Facade also exposes setRibbonType() for changing between collapsed, simple, classic, and grid layouts at runtime.

IUniverUIConfig

TypeScript
import type { DependencyOverride } from '@univerjs/core'import type { IWorkbenchOptions } from '../controllers/ui/ui.controller'import type { MenuConfig } from '../services/menu/menu'export interface IUniverUIConfig extends IWorkbenchOptions {  /** Disable auto focus when Univer bootstraps. */  disableAutoFocus?: true  override?: DependencyOverride  menu?: MenuConfig  popupRootId?: string  /**   * The fallback avatar for user.   */  avatarFallback?: string}

How is this guide?

© 2026 DreamNum Co., Ltd.