Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

1.6 KB
Raw Blame

@univerjs/ui

npm version license downloads

@univerjs/ui provides Univer's shared application UI framework, workbench services, menu infrastructure, dialogs, clipboard services, and Facade UI APIs.

Package Overview

Package UMD global CSS Locales Facade entry Worker entry
@univerjs/ui UniverUi Yes Yes Yes No

Installation

pnpm add @univerjs/ui
# or
npm install @univerjs/ui

Usage

Start with the integration setup for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

import '@univerjs/ui/lib/index.css';
import EnUS from '@univerjs/ui/locale/en-US';
import { UniverUIPlugin } from '@univerjs/ui';

univer.registerPlugin(UniverUIPlugin);

// Merge EnUS into your Univer locale map when this package contributes UI text.

Exported plugin classes:

  • UniverUIPlugin
  • UniverMobileUIPlugin

Integration Notes

  • Import @univerjs/ui/facade when using this package through Univer Facade APIs.

Resources