API Reference

@univerjs-pro/embed-unit-ui

Referenced Unit viewer UI for embedding and selecting Sheets, Docs, and Bases content in Web SDK.

TypeScript
import type { IUniverEmbedUnitUIPluginConfig } from '@univerjs-pro/embed-unit-ui'import { UniverEmbedUnitUIPlugin } from '@univerjs-pro/embed-unit-ui'univer.registerPlugin(UniverEmbedUnitUIPlugin, config)

Public exports

  • ReferencedUnitViewer
  • ReferencedDataSelector and IReferencedDataSelectorProps
  • IReferencedUnitViewerService
  • ReferencedUnitSelectionKind
  • ReferencedUnitViewerStatus
  • IReferencedUnitSelection, IReferencedUnitSelectionDecoration, IReferencedUnitViewerSession, and IReferencedUnitViewerState

ReferencedDataSelector accepts value: IResourceRef | null, onChange(value), and optional className and mobile props. Use it inside Univer's DI context to select referenced data for a custom host editor. Chart reference loading is provided separately by @univerjs-pro/chart-embed.

Entry points

  • Locale: @univerjs-pro/embed-unit-ui/locale/*

How is this guide?

© 2026 DreamNum Co., Ltd.