API 参考

@univerjs/docs-ui

本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。

UI layer for full Univer Docs applications.

Use this package together with @univerjs/docs to render and interact with a document instance. For rich text data in cells, comments, or custom integrations, prefer the Facade rich text APIs such as newRichText and newRichTextValue.

TypeScript
import { UniverDocsUIPlugin } from '@univerjs/docs-ui'univer.registerPlugin(UniverDocsUIPlugin, {  container: 'app',})

Entry Points

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

The root entry also exports:

  • BulletListTypePicker and OrderListTypePicker for list-style controls.
  • MobileRichTextToolbar and IMobileRichTextToolbarProps for embedded mobile rich-text editors.
  • SetDocInputStyleCommand for document input-style updates.
  • IDocPrintPreparationContext for print preparation integrations.
  • convertClipboardHtmlToDocumentData, removeClipboardHtmlImages, and convertClipboardRtfToPlainText for importing external rich-text clipboard content.

IUniverDocsUIConfig

TypeScript
import type { DependencyOverride } from '@univerjs/core'import type { MenuConfig } from '@univerjs/ui'export interface IUniverDocsUIConfig {  menu?: MenuConfig  container?: HTMLElement | string  toc?: boolean  footer?: boolean  override?: DependencyOverride}

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.