@univerjs-pro/sheets-shape-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.
Files changed (54) hide show
  1. package/README.md +29 -15
  2. package/lib/cjs/index.js +1 -1
  3. package/lib/cjs/locale/ca-ES.js +1 -1
  4. package/lib/cjs/locale/en-US.js +1 -1
  5. package/lib/cjs/locale/es-ES.js +1 -1
  6. package/lib/cjs/locale/fa-IR.js +1 -1
  7. package/lib/cjs/locale/fr-FR.js +1 -1
  8. package/lib/cjs/locale/ja-JP.js +1 -1
  9. package/lib/cjs/locale/ko-KR.js +1 -1
  10. package/lib/cjs/locale/ru-RU.js +1 -1
  11. package/lib/cjs/locale/sk-SK.js +1 -1
  12. package/lib/cjs/locale/vi-VN.js +1 -1
  13. package/lib/cjs/locale/zh-CN.js +1 -1
  14. package/lib/cjs/locale/zh-TW.js +1 -1
  15. package/lib/es/index.js +1 -1
  16. package/lib/es/locale/ca-ES.js +1 -1
  17. package/lib/es/locale/en-US.js +1 -1
  18. package/lib/es/locale/es-ES.js +1 -1
  19. package/lib/es/locale/fa-IR.js +1 -1
  20. package/lib/es/locale/fr-FR.js +1 -1
  21. package/lib/es/locale/ja-JP.js +1 -1
  22. package/lib/es/locale/ko-KR.js +1 -1
  23. package/lib/es/locale/ru-RU.js +1 -1
  24. package/lib/es/locale/sk-SK.js +1 -1
  25. package/lib/es/locale/vi-VN.js +1 -1
  26. package/lib/es/locale/zh-CN.js +1 -1
  27. package/lib/es/locale/zh-TW.js +1 -1
  28. package/lib/index.js +1 -1
  29. package/lib/locale/ca-ES.js +1 -1
  30. package/lib/locale/en-US.js +1 -1
  31. package/lib/locale/es-ES.js +1 -1
  32. package/lib/locale/fa-IR.js +1 -1
  33. package/lib/locale/fr-FR.js +1 -1
  34. package/lib/locale/ja-JP.js +1 -1
  35. package/lib/locale/ko-KR.js +1 -1
  36. package/lib/locale/ru-RU.js +1 -1
  37. package/lib/locale/sk-SK.js +1 -1
  38. package/lib/locale/vi-VN.js +1 -1
  39. package/lib/locale/zh-CN.js +1 -1
  40. package/lib/locale/zh-TW.js +1 -1
  41. package/lib/umd/index.js +1 -1
  42. package/lib/umd/locale/ca-ES.js +1 -1
  43. package/lib/umd/locale/en-US.js +1 -1
  44. package/lib/umd/locale/es-ES.js +1 -1
  45. package/lib/umd/locale/fa-IR.js +1 -1
  46. package/lib/umd/locale/fr-FR.js +1 -1
  47. package/lib/umd/locale/ja-JP.js +1 -1
  48. package/lib/umd/locale/ko-KR.js +1 -1
  49. package/lib/umd/locale/ru-RU.js +1 -1
  50. package/lib/umd/locale/sk-SK.js +1 -1
  51. package/lib/umd/locale/vi-VN.js +1 -1
  52. package/lib/umd/locale/zh-CN.js +1 -1
  53. package/lib/umd/locale/zh-TW.js +1 -1
  54. package/package.json +21 -22
package/README.md CHANGED
@@ -1,30 +1,44 @@
1
1
  # @univerjs-pro/sheets-shape-ui
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-shape)](https://npmjs.org/packages/@univerjs-pro/sheets-shape)
4
- [![license](https://img.shields.io/npm/l/@univerjs-pro/sheets-shape)](https://img.shields.io/npm/l/@univerjs-pro/sheets-shape)
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-shape-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-shape-ui)
4
+ [![downloads](https://img.shields.io/npm/dm/@univerjs-pro/sheets-shape-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-shape-ui)
5
5
 
6
- ## Introduction
6
+ `@univerjs-pro/sheets-shape-ui` provides shape and drawing UI integration for Univer Sheets.
7
7
 
8
- Sheets Shape provides the core shape/drawing model and services for Univer Sheets. It allows users to insert, update, and remove various shapes (rectangles, circles, connectors, etc.) on spreadsheet worksheets. This package handles shape data management, mutations, and the underlying shape model logic. It is typically used together with `@univerjs-pro/sheets-shape-ui`, which provides the UI interactions for shapes.
8
+ ## Package Overview
9
9
 
10
- ## Usage
11
-
12
- ### Installation
10
+ | Package | UMD global | CSS | Locales | Facade entry |
11
+ | --- | --- | :---: | :---: | :---: |
12
+ | `@univerjs-pro/sheets-shape-ui` | `UniverProSheetsShapeUi` | Yes | Yes | No |
13
13
 
14
- ```shell
15
- # Using npm
16
- npm install @univerjs-pro/sheets-shape-ui @univerjs-pro/sheets-shape
14
+ ## Installation
17
15
 
18
- # Using pnpm
19
- pnpm add @univerjs-pro/sheets-shape-ui @univerjs-pro/sheets-shape
16
+ ```sh
17
+ pnpm add @univerjs-pro/sheets-shape-ui
18
+ # or
19
+ npm install @univerjs-pro/sheets-shape-ui
20
20
  ```
21
21
 
22
- ### Import
22
+ Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
23
+
24
+ ## Usage
23
25
 
24
26
  ```ts
25
- import { UniverSheetsShapePlugin } from '@univerjs-pro/sheets-shape';
27
+ import '@univerjs-pro/sheets-shape-ui/lib/index.css';
28
+ import EnUS from '@univerjs-pro/sheets-shape-ui/locale/en-US';
26
29
  import { UniverSheetsShapeUIPlugin } from '@univerjs-pro/sheets-shape-ui';
27
30
 
28
- univer.registerPlugin(UniverSheetsShapePlugin);
29
31
  univer.registerPlugin(UniverSheetsShapeUIPlugin);
32
+
33
+ // Merge EnUS into your Univer locale map when this package contributes UI text.
30
34
  ```
35
+
36
+ ## Integration Notes
37
+
38
+ Use this package with `@univerjs-pro/sheets-shape` when users need shape editing UI.
39
+
40
+ ## Resources
41
+
42
+ - [Documentation](https://docs.univer.ai/guides/pro)
43
+ - [NPM package](https://npmjs.com/package/@univerjs-pro/sheets-shape-ui)
44
+