Skip to content

Latest commit

 

History

History

docs-ui

README.md

@univerjs/docs-ui

npm version license downloads

@univerjs/docs-ui provides the editor UI layer for Univer Docs, including selection rendering, clipboard support, menus, and document interaction services.

Package Overview

Package UMD global CSS Locales Facade entry Worker entry
@univerjs/docs-ui UniverDocsUi Yes Yes Yes No

Installation

pnpm add @univerjs/docs-ui
# or
npm install @univerjs/docs-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/docs-ui/lib/index.css';
import EnUS from '@univerjs/docs-ui/locale/en-US';
import { UniverDocsUIPlugin } from '@univerjs/docs-ui';

univer.registerPlugin(UniverDocsUIPlugin);

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

Integration Notes

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

Resources