@univerjs/ui 0.21.1 → 0.22.0

package/README.md

@@ -1,50 +1,47 @@
 # @univerjs/ui
 
+[![npm version](https://img.shields.io/npm/v/@univerjs/ui?style=flat-square)](https://npmjs.com/package/@univerjs/ui)
+[![license](https://img.shields.io/npm/l/@univerjs/ui?style=flat-square)](https://npmjs.com/package/@univerjs/ui)
+[![downloads](https://img.shields.io/npm/dm/@univerjs/ui?style=flat-square)](https://npmjs.com/package/@univerjs/ui)
+
+`@univerjs/ui` provides Univer's shared application UI framework, workbench services, menu infrastructure, dialogs, clipboard services, and Facade UI APIs.
+
 ## Package Overview
 
-| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
-| --- | --- | --- | --- | --- | :---: | :---: |
-| `@univerjs/ui` | `UniveUi` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ⭕️ | ⭕️ |
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs/ui` | `UniverUi` | Yes | Yes | Yes |
 
-## Introduction
+## Installation
 
-`@univerjs/ui` defines basic UI services and provides a set of desktop Workbench implementations based on React.
+```sh
+pnpm add @univerjs/ui
+# or
+npm install @univerjs/ui
+```
 
-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.
+Keep all `@univerjs/*` packages on the same version.
 
 ## Usage
 
-### Installation
+```ts
+import '@univerjs/ui/lib/index.css';
+import EnUS from '@univerjs/ui/locale/en-US';
+import { UniverUIPlugin } from '@univerjs/ui';
 
-```shell
-# Using npm
-npm install @univerjs/ui
+univer.registerPlugin(UniverUIPlugin);
 
-# Using pnpm
-pnpm add @univerjs/ui
+// Merge EnUS into your Univer locale map when this package contributes UI text.
 ```
 
-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:
+Exported plugin classes:
 
-- 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.
+- `UniverUIPlugin`
+- `UniverMobileUIPlugin`
 
-### Workbench
+## Resources
 
-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.
+- [Documentation](https://docs.univer.ai)
+- [NPM package](https://npmjs.com/package/@univerjs/ui)
+- [GitHub repository](https://github.com/dream-num/univer)
 
-<!-- Links -->
-[npm-version-shield]: https://img.shields.io/npm/v/@univerjs/ui?style=flat-square
-[npm-version-link]: https://npmjs.com/package/@univerjs/ui
-[npm-license-shield]: https://img.shields.io/npm/l/@univerjs/ui?style=flat-square
-[npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/ui?style=flat-square

package/lib/cjs/facade.js

@@ -3,7 +3,7 @@ let _univerjs_engine_render = require("@univerjs/engine-render");
 let _univerjs_ui = require("@univerjs/ui");
 let _univerjs_core = require("@univerjs/core");
 
-//#region \0@oxc-project+runtime@0.124.0/helpers/typeof.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -14,7 +14,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPrimitive.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -27,14 +27,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/defineProperty.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -45,7 +45,7 @@ function _defineProperty(e, r, t) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/decorateParam.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -53,7 +53,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/decorate.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);