@univerjs/sheets-ui 0.21.1 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,35 +1,47 @@
1
1
  # @univerjs/sheets-ui
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs/sheets-ui?style=flat-square)](https://npmjs.com/package/@univerjs/sheets-ui)
4
+ [![license](https://img.shields.io/npm/l/@univerjs/sheets-ui?style=flat-square)](https://npmjs.com/package/@univerjs/sheets-ui)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs/sheets-ui?style=flat-square)](https://npmjs.com/package/@univerjs/sheets-ui)
6
+
7
+ `@univerjs/sheets-ui` provides the main spreadsheet UI layer for Univer Sheets, including selection, menus, clipboard, formula bar integration, and rendering interaction services.
8
+
3
9
  ## Package Overview
4
10
 
5
- | Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
6
- | --- | --- | --- | --- | --- | :---: | :---: |
7
- | `@univerjs/sheets-ui` | `UniverSheetsUi` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ⭕️ | ⭕️ |
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | --- | --- | :---: | :---: | :---: |
13
+ | `@univerjs/sheets-ui` | `UniverSheetsUi` | Yes | Yes | Yes |
8
14
 
9
- ## Introduction
15
+ ## Installation
10
16
 
11
- The `@univerjs/sheets-ui` library provides the user interface (UI) for sheets, including:
17
+ ```sh
18
+ pnpm add @univerjs/sheets-ui
19
+ # or
20
+ npm install @univerjs/sheets-ui
21
+ ```
12
22
 
13
- * Keyboard shortcuts and menu items for basic sheet functions
14
- * Copy-paste service, allowing customization of copy-paste behavior for specific features via the provided methods
15
- * Autofill service, enabling customization of autofill behavior for specific features via the provided methods
16
- * Cell editor and formula editor
17
- * Rendering spreadsheets in canvas
23
+ Keep all `@univerjs/*` packages on the same version.
18
24
 
19
25
  ## Usage
20
26
 
21
- ### Installation
27
+ ```ts
28
+ import '@univerjs/sheets-ui/lib/index.css';
29
+ import EnUS from '@univerjs/sheets-ui/locale/en-US';
30
+ import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui';
22
31
 
23
- ```shell
24
- # Using npm
25
- npm install @univerjs/sheets-ui
32
+ univer.registerPlugin(UniverSheetsUIPlugin);
26
33
 
27
- # Using pnpm
28
- pnpm add @univerjs/sheets-ui
34
+ // Merge EnUS into your Univer locale map when this package contributes UI text.
29
35
  ```
30
36
 
31
- <!-- Links -->
32
- [npm-version-shield]: https://img.shields.io/npm/v/@univerjs/sheets-ui?style=flat-square
33
- [npm-version-link]: https://npmjs.com/package/@univerjs/sheets-ui
34
- [npm-license-shield]: https://img.shields.io/npm/l/@univerjs/sheets-ui?style=flat-square
35
- [npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/sheets-ui?style=flat-square
37
+ Exported plugin classes:
38
+
39
+ - `UniverSheetsUIPlugin`
40
+ - `UniverSheetsMobileUIPlugin`
41
+
42
+ ## Resources
43
+
44
+ - [Documentation](https://docs.univer.ai)
45
+ - [NPM package](https://npmjs.com/package/@univerjs/sheets-ui)
46
+ - [GitHub repository](https://github.com/dream-num/univer)
47
+