@univerjs/ui

@univerjs/ui

Package Overview

Package Name	UMD Namespace	Version	License	Downloads	Contains CSS	Contains i18n locales
@univerjs/ui	UniveUi				⭕️	⭕️

Introduction

@univerjs/ui defines basic UI services and provides a set of desktop Workbench implementations based on React.

Please note that this implementation can only display only 1 unit in the workbench. If you would like to embed units into a rich text document, or a mind node, you should implement a new UI plugin for that. Refer to our uniui plugin for an example.

Usage

Installation

# Using npm
npm install @univerjs/ui

# Using pnpm
pnpm add @univerjs/ui

This package contains CSS and has the second highest priority. Please import it after @univerjs/design and before any other Univer style files.

UI service

UI services define a set of user interface services that run on the client side but are agnostic to the specific host environment (such as desktop browsers, mobile webviews, etc.). By injecting these services, business functionalities can invoke the same interfaces across different hosts without worrying about host disparities.

These UI services include:

• Menu service, used to register menu items and their associated commands.
• Shortcut service, for registering keyboard shortcuts and their corresponding commands.
• Clipboard service, to read from or write to the clipboard.
• Popup service, which includes confirmations, dialogs, and more.

Workbench

In addition to UI services, @univerjs/ui also implements a workspace based on React, which includes elements such as the title bar, toolbar, main content area, context menu, sidebar, and more. Businesses can customize the rendered content using the APIs provided by the Workbench.