# @univerjs/docs-ui

- Human documentation: [https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui](https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui)

- Agent Markdown: [https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui.md](https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [packages/plugins/univerjs/docs-ui.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/packages/plugins/univerjs/docs-ui.mdx)

---

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
// [!code word:UniverDocsUIPlugin]
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

```ts
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
}
```