@univerjs/sheets 0.21.0 → 0.21.1-insiders.20260509-bf98cad

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 (23) hide show
  1. package/README.md +24 -36
  2. package/lib/cjs/facade.js +196 -174
  3. package/lib/cjs/index.js +796 -583
  4. package/lib/es/facade.js +199 -177
  5. package/lib/es/index.js +797 -585
  6. package/lib/facade.js +199 -177
  7. package/lib/index.js +797 -585
  8. package/lib/types/basics/defined-name-utils.d.ts +28 -0
  9. package/lib/types/commands/commands/clear-selection-all.command.d.ts +1 -1
  10. package/lib/types/commands/commands/clear-selection-content.command.d.ts +1 -1
  11. package/lib/types/commands/commands/clear-selection-format.command.d.ts +1 -1
  12. package/lib/types/commands/commands/set-defined-name.command.d.ts +2 -4
  13. package/lib/types/facade/f-defined-name.d.ts +30 -30
  14. package/lib/types/facade/f-univer.d.ts +0 -17
  15. package/lib/types/facade/f-workbook.d.ts +38 -26
  16. package/lib/types/facade/permission/f-range-protection-rule.d.ts +2 -2
  17. package/lib/types/index.d.ts +1 -0
  18. package/lib/types/services/auto-fill/tools.d.ts +4 -6
  19. package/lib/types/skeleton/skeleton.service.d.ts +3 -0
  20. package/lib/umd/facade.js +1 -1
  21. package/lib/umd/index.js +2 -2
  22. package/package.json +17 -13
  23. package/LICENSE +0 -176
package/README.md CHANGED
@@ -1,53 +1,41 @@
1
1
  # @univerjs/sheets
2
2
 
3
- ## Package Overview
4
-
5
- | Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
6
- | --- | --- | --- | --- | --- | :---: | :---: |
7
- | `@univerjs/sheets` | `UniverSheets` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ❌ | ⭕️ |
8
-
9
- ## Introduction
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
4
+ [![license](https://img.shields.io/npm/l/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
10
6
 
11
- `@univerjs/sheets` serves as the foundation for the core business logic of spreadsheets, with base-sheets designed to be UI-agnostic, allowing for functionality such as collaborative editing to be implemented in a Node.js environment.
7
+ `@univerjs/sheets` provides the core spreadsheet data model and business logic for Univer Sheets, independent of the UI layer.
12
8
 
13
- `@univerjs/sheets` provides the following capabilities for Univer Sheet:
14
-
15
- * Core functionality, including numerical formatting, selection management, permissions, etc.
16
- * Commands/mutations for modifying spreadsheet data
17
- * Formula core functionality
18
- * Core numerical formatting functionality
19
-
20
- ## Usage
9
+ ## Package Overview
21
10
 
22
- ### Installation
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | --- | --- | :---: | :---: | :---: |
13
+ | `@univerjs/sheets` | `UniverSheets` | No | Yes | Yes |
23
14
 
24
- ```shell
25
- # Using npm
26
- npm install @univerjs/sheets
15
+ ## Installation
27
16
 
28
- # Using pnpm
17
+ ```sh
29
18
  pnpm add @univerjs/sheets
19
+ # or
20
+ npm install @univerjs/sheets
30
21
  ```
31
22
 
32
- ### `SheetInterceptorService`
23
+ Keep all `@univerjs/*` packages on the same version.
33
24
 
34
- `SheetInterceptorService` is a more specialized service provided by `@univerjs/sheets` that allows higher-level business to modify the results of operations such as obtaining cell data, retrieving row/column hiding information from a Worksheet, and supplementing mutations or operations at specific command executions. This service's primary goal is to enable specific functionalities, including:
25
+ ## Usage
35
26
 
36
- 1. Sheet formulas
37
- 2. Sheet conditional formatting
38
- 3. Sheet data validation
39
- 4. Sheet pivot tables
27
+ ```ts
28
+ import EnUS from '@univerjs/sheets/locale/en-US';
29
+ import { UniverSheetsPlugin } from '@univerjs/sheets';
40
30
 
41
- For detailed usage, please refer to the API documentation.
31
+ univer.registerPlugin(UniverSheetsPlugin);
42
32
 
43
- #### When to use `SheetInterceptorService` and when not to?
33
+ // Merge EnUS into your Univer locale map when this package contributes UI text.
34
+ ```
44
35
 
45
- Use `SheetInterceptorService` when multiple features need to operate on the same data or state, but do not have a clear dependency relationship. For example: pivot tables, formulas, conditional formatting, data validation, and raw cell data can all affect how other features retrieve a cell's value, but they do not depend on each other. In this case, using `SheetInterceptorService` to implement these features is appropriate.
36
+ ## Resources
46
37
 
47
- However, if one feature relies explicitly on another feature, such as a formula needing to perform certain actions when the fill down or copy-paste functions are called, the formula module should directly depend on the fill down and copy-paste modules, instead of using `SheetInterceptorService` for implementation.
38
+ - [Documentation](https://docs.univer.ai)
39
+ - [NPM package](https://npmjs.com/package/@univerjs/sheets)
40
+ - [GitHub repository](https://github.com/dream-num/univer)
48
41
 
49
- <!-- Links -->
50
- [npm-version-shield]: https://img.shields.io/npm/v/@univerjs/sheets?style=flat-square
51
- [npm-version-link]: https://npmjs.com/package/@univerjs/sheets
52
- [npm-license-shield]: https://img.shields.io/npm/l/@univerjs/sheets?style=flat-square
53
- [npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/sheets?style=flat-square