mirror of
https://github.com/dream-num/univer.git
synced 2026-10-02 04:24:34 +08:00
docs: update README banner assets (#7599)
This commit is contained in:
白熱
+44
-4
@@ -1,5 +1,45 @@
|
||||
# Changelog
|
||||
|
||||
## [1.0.0-beta.2](https://github.com/dream-num/univer/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2026-08-22)
|
||||
|
||||
### Features
|
||||
|
||||
* **core:** add fluent rich-text link APIs ([bc72e1f](https://github.com/dream-num/univer/commit/bc72e1f1f)) and export the lodash `setWith` helper ([f37937c](https://github.com/dream-num/univer/commit/f37937c4e))
|
||||
|
||||
### Performance Improvements
|
||||
|
||||
* **engine-formula:** optimize shared-formula lookup ([9251e0d](https://github.com/dream-num/univer/commit/9251e0d30))
|
||||
* **sheets:** deduplicate floating-DOM zoom updates ([d3114d8](https://github.com/dream-num/univer/commit/d3114d89f))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **docs:** preserve list marker styling, image crops, hyperlink interactions, floating drawings, text layout, and print preparation ([a66bbae](https://github.com/dream-num/univer/commit/a66bbae18), [f24306c](https://github.com/dream-num/univer/commit/f24306c35), [07d42e3](https://github.com/dream-num/univer/commit/07d42e36e), [e84e978](https://github.com/dream-num/univer/commit/e84e978ef), [7248730](https://github.com/dream-num/univer/commit/72487307c), [9954e52](https://github.com/dream-num/univer/commit/9954e5274))
|
||||
* **sheets:** preserve cell styles, normalize freeze data, validate pasted number formats, and stabilize conditional formatting and editor history ([5585cff](https://github.com/dream-num/univer/commit/5585cfff1), [e635af8](https://github.com/dream-num/univer/commit/e635af8a7), [7b9b8fb](https://github.com/dream-num/univer/commit/7b9b8fb0e), [5410a1a](https://github.com/dream-num/univer/commit/5410a1a75), [45377b1](https://github.com/dream-num/univer/commit/45377b158), [1d4112c](https://github.com/dream-num/univer/commit/1d4112c46))
|
||||
* **ui/embed:** stabilize runtime ownership, print preparation, mobile service registration, and root-workbench surface scoping ([dc06ed8](https://github.com/dream-num/univer/commit/dc06ed889), [bbad43f](https://github.com/dream-num/univer/commit/bbad43f70), [8c856a5](https://github.com/dream-num/univer/commit/8c856a5bc), [ee000ad](https://github.com/dream-num/univer/commit/ee000ad14))
|
||||
* **render/drawing:** resolve theme colors for print and canvas rendering, repaint and clip scrolling copies, and preserve drawing z-order and selection behavior ([603016f](https://github.com/dream-num/univer/commit/603016f6a), [4933359](https://github.com/dream-num/univer/commit/49333595c), [5885b67](https://github.com/dream-num/univer/commit/5885b675b), [8a70e42](https://github.com/dream-num/univer/commit/8a70e42b1), [7f671e4](https://github.com/dream-num/univer/commit/7f671e4db), [60890d7](https://github.com/dream-num/univer/commit/60890d786))
|
||||
* **accessibility/RTL/comments:** improve gallery and pager accessibility, formula range-selection RTL layout, and thread selection and localization ([c40c116](https://github.com/dream-num/univer/commit/c40c1165e), [b2cd404](https://github.com/dream-num/univer/commit/b2cd4049f), [fd88260](https://github.com/dream-num/univer/commit/fd88260ce), [c0906a3](https://github.com/dream-num/univer/commit/c0906a3a4))
|
||||
|
||||
## [1.0.0-beta.1](https://github.com/dream-num/univer/compare/v1.0.0-beta.0...v1.0.0-beta.1) (2026-08-15)
|
||||
|
||||
### Features
|
||||
|
||||
* **theme/core:** add dark-theme support, expose theme controls through the Facade, and add generic unit-presence adapters ([b838449](https://github.com/dream-num/univer/commit/b83844961), [dae6d8f](https://github.com/dream-num/univer/commit/dae6d8f40), [e47c8fa](https://github.com/dream-num/univer/commit/e47c8faf3))
|
||||
* **docs:** add document statistics, a document-name setter, pre-text background extensions, and exported list-type pickers ([60c9628](https://github.com/dream-num/univer/commit/60c9628dd), [0b9c6f1](https://github.com/dream-num/univer/commit/0b9c6f173), [4636f66](https://github.com/dream-num/univer/commit/4636f66a0), [783638c](https://github.com/dream-num/univer/commit/783638c3d))
|
||||
* **sheets/ui:** add text-to-number alerts, embedded presentation tabs, concurrent runtime-scope resolution, adaptive toolbar popups, and grouped emoji skin-tone variants ([7c20c35](https://github.com/dream-num/univer/commit/7c20c355b), [fa702ad](https://github.com/dream-num/univer/commit/fa702adaa), [36575dd](https://github.com/dream-num/univer/commit/36575dd71), [83e48d9](https://github.com/dream-num/univer/commit/83e48d927), [95320cc](https://github.com/dream-num/univer/commit/95320cc27))
|
||||
* **render/drawing/core:** support transformer control layers, absolute drawing z-order, Base text-preview hit testing, and improved undo/redo history handling ([0d524ee](https://github.com/dream-num/univer/commit/0d524ee46), [2693cdf](https://github.com/dream-num/univer/commit/2693cdf4e), [f178881](https://github.com/dream-num/univer/commit/f17888196), [9f0cad6](https://github.com/dream-num/univer/commit/9f0cad68f))
|
||||
|
||||
### Performance Improvements
|
||||
|
||||
* **engine-render:** cache complex SVG rasters, reuse shape caches during transforms, and adapt scrollbar seek rendering ([a49557e](https://github.com/dream-num/univer/commit/a49557e08), [09a0772](https://github.com/dream-num/univer/commit/09a077211), [823663e](https://github.com/dream-num/univer/commit/823663e32))
|
||||
* **sheets/docs:** skip invisible text work, replace object-matrix queries with range operations, optimize large-sheet scrolling, and coalesce document refreshes ([bf9940c](https://github.com/dream-num/univer/commit/bf9940c2a), [2423350](https://github.com/dream-num/univer/commit/24233500a), [4f74db6](https://github.com/dream-num/univer/commit/4f74db67a), [0a8432f](https://github.com/dream-num/univer/commit/0a8432f81))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **formula:** align lookup, table, implicit-intersection, and `PERCENTOF` semantics with Excel while preserving Base and external-table references ([bcf059a](https://github.com/dream-num/univer/commit/bcf059aa8), [9940766](https://github.com/dream-num/univer/commit/994076619), [f974894](https://github.com/dream-num/univer/commit/f9748943d), [ef49abd](https://github.com/dream-num/univer/commit/ef49abd9c))
|
||||
* **docs:** improve traditional layout, list-marker styling, atomic structure deletion, table selection, document-flavor backgrounds, overlays, and scrolling ([b930f76](https://github.com/dream-num/univer/commit/b930f76e6), [dad0ab7](https://github.com/dream-num/univer/commit/dad0ab75b), [7bc5fc4](https://github.com/dream-num/univer/commit/7bc5fc421), [2bdddf6](https://github.com/dream-num/univer/commit/2bdddf669), [770642a](https://github.com/dream-num/univer/commit/770642a03), [f2aa09b](https://github.com/dream-num/univer/commit/f2aa09b61), [889d109](https://github.com/dream-num/univer/commit/889d10961))
|
||||
* **ui/embed:** improve RTL layout, constrain canvas popups, prevent browser zoom, preserve embed editing state and hosts, and defer Facade pointer events until a workbook exists ([185b916](https://github.com/dream-num/univer/commit/185b9169a), [fc73e51](https://github.com/dream-num/univer/commit/fc73e5179), [5a8680f](https://github.com/dream-num/univer/commit/5a8680fba), [fe5cc4d](https://github.com/dream-num/univer/commit/fe5cc4d07), [151f828](https://github.com/dream-num/univer/commit/151f8283a), [765afaf](https://github.com/dream-num/univer/commit/765afaf76))
|
||||
* **sheets/drawing:** write Excel-compatible clipboard HTML, correct gridline and scrollbar themes, preview cell images, render chart option icons, and stabilize drawing interactions and popup bounds ([04a7e8e](https://github.com/dream-num/univer/commit/04a7e8ee6), [2cfea02](https://github.com/dream-num/univer/commit/2cfea02f7), [cca8d19](https://github.com/dream-num/univer/commit/cca8d1918), [ca07bd9](https://github.com/dream-num/univer/commit/ca07bd938), [41f3d4d](https://github.com/dream-num/univer/commit/41f3d4d02), [26404c5](https://github.com/dream-num/univer/commit/26404c5fb))
|
||||
|
||||
## [1.0.0-beta.0](https://github.com/dream-num/univer/compare/v1.0.0-alpha.8...v1.0.0-beta.0) (2026-08-05)
|
||||
|
||||
### Bug Fixes
|
||||
@@ -963,7 +1003,7 @@ No classifiable changes.
|
||||
* **shape:** add option handle in interface ([#6369](https://github.com/dream-num/univer/issues/6369)) ([603da2d](https://github.com/dream-num/univer/commit/603da2d751101ff93cc6dadd669600c5d32724cc))
|
||||
* **ui:** allow overriding custom fonts in configuration ([#6375](https://github.com/dream-num/univer/issues/6375)) ([c3d75e3](https://github.com/dream-num/univer/commit/c3d75e36f5962e860843f1521f45356e18db1fc6))
|
||||
|
||||
# [0.14.0](/compare/v0.13.0...v0.14.0) (2025-12-20)
|
||||
# [0.14.0](https://github.com/dream-num/univer/compare/v0.13.0...v0.14.0) (2025-12-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
@@ -996,7 +1036,7 @@ No classifiable changes.
|
||||
* **sheets-conditional-formatting:** use other-formula-service on conditional-formatting (#6322) a1b7d95, closes #6322
|
||||
* **sheets:** add biz info on other formula (#6296) 23f6ae2, closes #6296
|
||||
|
||||
# [0.13.0](/compare/v0.12.4...v0.13.0) (2025-12-13)
|
||||
# [0.13.0](https://github.com/dream-num/univer/compare/v0.12.4...v0.13.0) (2025-12-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
@@ -1031,7 +1071,7 @@ No classifiable changes.
|
||||
* **formula:** dependency tree and calculation api (#6258) e67908f, closes #6258
|
||||
* set active selections by defined name input (#6138) 972097c, closes #6138
|
||||
|
||||
## [0.12.4](/compare/v0.12.3...v0.12.4) (2025-12-06)
|
||||
## [0.12.4](https://github.com/dream-num/univer/compare/v0.12.3...v0.12.4) (2025-12-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
@@ -1052,7 +1092,7 @@ No classifiable changes.
|
||||
* **sheets:** split insert sheet command on large data (#6214) 09cc69a, closes #6214
|
||||
* **ui:** add font management service & support appending custom font family (#6237) 7c1c2c9, closes #6237
|
||||
|
||||
## [0.12.3](/compare/v0.12.2...v0.12.3) (2025-11-29)
|
||||
## [0.12.3](https://github.com/dream-num/univer/compare/v0.12.2...v0.12.3) (2025-11-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
+7
-5
@@ -61,10 +61,12 @@ The structure of the repository is as follows:
|
||||
|
||||
```txt
|
||||
.
|
||||
├── common/ shared configuration and utilities
|
||||
├── common/ shared configuration, mock data, Storybook, and utilities
|
||||
├── docs/ documentation
|
||||
├── examples/ all-in-one Vite workbench for browser development
|
||||
├── packages/ Univer core and plugins
|
||||
├── presets/ curated plugin collections
|
||||
└── tests/ additional integration test projects
|
||||
```
|
||||
|
||||
The file structure of a plugin should be organized as follows:
|
||||
@@ -135,7 +137,7 @@ Please refer to [Univer Naming Convention](./docs/NAMING_CONVENTION.md).
|
||||
|
||||
Before merging a pull request, please make sure the following requirements are met:
|
||||
|
||||
- All tests are passed. ESLint and Prettier errors are fixed.
|
||||
- All tests pass. ESLint, including its formatting checks, passes.
|
||||
- Test coverage is not decreased.
|
||||
|
||||
We provide preview deployments for pull requests. You can view the preview deployment by clicking the "Preview" link in the "View Deployment" section.
|
||||
@@ -166,7 +168,7 @@ To ensure the quality of the code and move with confidence, we require that all
|
||||
pnpm test
|
||||
```
|
||||
|
||||
Also, with the help of vscode and its rich ecosystem, you could directly debug unit tests in vscode. Please install the extension we recommend, and you will see the debug button in the side bar. In addition, if you add a new plugin, you should update `vitest.workspace.js` to include the new plugin.
|
||||
Also, with the help of vscode and its rich ecosystem, you could directly debug unit tests in vscode. Please install the extension we recommend, and you will see the debug button in the side bar. The `packages/*` glob in `vitest.workspace.ts` automatically includes new plugins created under `packages/`.
|
||||
|
||||
|
||||
|
||||
@@ -176,11 +178,11 @@ Also, with the help of vscode and its rich ecosystem, you could directly debug u
|
||||
|
||||
### Build Preview
|
||||
|
||||
After building, the output may differ from the source code. To test for any differences, you can link to the built artifacts using:
|
||||
Build the production artifacts to check for differences between the source and compiled output:
|
||||
|
||||
```shell
|
||||
pnpm build
|
||||
pnpm dev:libs
|
||||
pnpm dev:umd
|
||||
```
|
||||
|
||||
### Clean code
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="./docs/img/banner-light.png">
|
||||
<img src="./docs/img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="./docs/img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**A full-stack, isomorphic office SDK for building spreadsheets, documents, and presentations.**
|
||||
|
||||
@@ -23,7 +20,7 @@ English | [简体中文](./docs/readme/zh-CN.md) | [繁體中文](./docs/readme/
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -228,7 +225,7 @@ Learn more in the [Installation & Basic Usage guide](https://docs.univer.ai/guid
|
||||
| **Preset Mode** | You want a working Sheets, Docs, or Node setup with minimal configuration. | This repository's [`presets/`](./presets) and the [getting started guide](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | You need server-side workbook/document processing, formula calculation, or automation without UI. | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
Keep all `@univerjs/*` packages on the same version. If you use Univer Pro packages, keep `@univerjs-pro/*` versions aligned as well.
|
||||
Keep the `@univerjs/*` SDK packages in the same coordinated Univer release line on the same version. Independently released packages, including `@univerjs/icons` and `@univerjs/icons-svg`, use the compatible versions declared by package manifests instead of the SDK version. If you use Univer Pro packages, keep `@univerjs-pro/*` aligned with the matching coordinated release line.
|
||||
|
||||
For API compatibility expectations, experimental APIs, internal APIs, and deprecation rules, see the [API Stability Policy](./docs/API_STABILITY.md).
|
||||
|
||||
|
||||
@@ -72,9 +72,9 @@ Pull requests that introduce breaking changes should include a `BREAKING CHANGE:
|
||||
|
||||
## Package Version Alignment
|
||||
|
||||
Keep all `@univerjs/*` packages on the same version. If an application uses Univer Pro packages, keep all `@univerjs-pro/*` packages aligned with the matching Univer release line as well.
|
||||
Keep the `@univerjs/*` SDK packages that participate in the same coordinated Univer release line on the same version. Independently released packages, including `@univerjs/icons` and `@univerjs/icons-svg`, follow the compatible versions declared by package manifests rather than the SDK version. If an application uses Univer Pro packages, keep `@univerjs-pro/*` aligned with the matching coordinated Univer release line.
|
||||
|
||||
Mixing package versions can bypass compatibility checks and produce runtime failures, especially around plugin registration, Facade API composition, locales, commands, and shared data models.
|
||||
Mixing versions within a coordinated SDK release line can bypass compatibility checks and produce runtime failures, especially around plugin registration, Facade API composition, locales, commands, and shared data models.
|
||||
|
||||
## Public API Checklist
|
||||
|
||||
|
||||
@@ -48,5 +48,4 @@ All APIs/constants/enums should be accessible from the `univerAPI` variable.
|
||||
|
||||
## Documentation
|
||||
|
||||
It is strongly suggested to add documentation for your code [here](https://github.com/dream-num/univer.ai/tree/dev/packages/community/src/content/docs/guides/sheet/facade). Please refer to our [documentation repo](https://github.com/dream-num/docs) for more guidance.
|
||||
|
||||
It is strongly suggested to add documentation for your code alongside the current [Sheets Facade guide](https://github.com/dream-num/documentation/blob/dev/content/guides/sheets/getting-started/facade.mdx). Please refer to the [documentation repository](https://github.com/dream-num/documentation) for more guidance.
|
||||
|
||||
@@ -31,7 +31,7 @@ For example: dream-num/univer@6423ff8/packages/sheets-drawing-ui/src/controllers
|
||||
|
||||
It is very common to cause memory leak if you get the current unit in singleton modules and subscribe to it. Singleton modules are defined as modules that are registered in the Univer root injector instead of injectors held by render units.
|
||||
|
||||
For example: https://github.com/dream-num/univer/blob/dev/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts#L433.
|
||||
For example, see the [historical implementation before the leak was fixed](https://github.com/dream-num/univer/blob/7550f1cef8c7ff17caecba7ac3305dd56b30b62e/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts#L433-L468).
|
||||
|
||||
**HOW TO FIX**: Please consider extracting the related logic to an `IRenderModule` instead.
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ export interface ISomeCommandParams {
|
||||
// Define the parameters here
|
||||
}
|
||||
|
||||
export const SomeCommand = ICommand<ISomeCommandParams> = {
|
||||
export const SomeCommand: ICommand<ISomeCommandParams> = {
|
||||
id: '<business-type>.<command-type>.<command-name>',
|
||||
};
|
||||
```
|
||||
@@ -153,7 +153,7 @@ export const ResolveCommentCommand: ICommand<IResolveCommentCommandParams> = {
|
||||
|
||||
## Id
|
||||
|
||||
All IDs should be in pascal case: `id` or `Id`.
|
||||
Within camelCase or PascalCase identifiers, use `Id` instead of `ID` (for example, `unitId` and `getUnitId`). Keep the standalone property name `id` lowercase.
|
||||
|
||||
## Locale Keys
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../img/banner-light.png">
|
||||
<img src="../img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="../img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**Un SDK ofimático full-stack e isomórfico para crear hojas de cálculo, documentos y presentaciones.**
|
||||
|
||||
@@ -23,7 +20,7 @@ renderizado basado en Canvas, un motor de fórmulas y una Facade API que funcion
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -228,7 +225,7 @@ Consulta más detalles en la [guía de instalación y uso básico](https://docs.
|
||||
| **Preset Mode** | Quieres una configuración funcional de Sheets, Docs o Node con mínima configuración. | Los [`presets/`](../../presets) de este repositorio y la [guía de inicio](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | Necesitas procesamiento de libros/documentos en servidor, cálculo de fórmulas o automatización sin UI. | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
Mantén todos los paquetes `@univerjs/*` en la misma versión. Si usas paquetes de Univer Pro, mantén también alineadas las versiones de `@univerjs-pro/*`.
|
||||
Mantén en la misma versión los paquetes del SDK `@univerjs/*` que formen parte de una misma línea de lanzamiento coordinada de Univer. Los paquetes con un ciclo de publicación independiente, como `@univerjs/icons` y `@univerjs/icons-svg`, deben usar las versiones compatibles declaradas en los manifiestos de los paquetes, no la versión del SDK. Si usas paquetes de Univer Pro, mantén `@univerjs-pro/*` alineados con la línea de lanzamiento coordinada correspondiente.
|
||||
|
||||
Para expectativas de compatibilidad de API, APIs experimentales, APIs internas y reglas de deprecación, consulta la [política de estabilidad de API](../API_STABILITY.md).
|
||||
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../img/banner-light.png">
|
||||
<img src="../img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="../img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**スプレッドシート、ドキュメント、プレゼンテーションを構築するためのフルスタックでアイソモーフィックなオフィス SDK。**
|
||||
|
||||
@@ -24,7 +21,7 @@ Univer は、プラグインアーキテクチャ、Canvas ベースのレンダ
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -229,7 +226,7 @@ univerAPI.createWorkbook({})
|
||||
| **Preset Mode** | 最小限の設定で Sheets、Docs、Node の動作環境を作りたい場合。 | このリポジトリの [`presets/`](../../presets) と [getting started guide](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | UI なしでサーバー側のワークブック/ドキュメント処理、数式計算、自動化を行いたい場合。 | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
すべての `@univerjs/*` パッケージは同じバージョンに揃えてください。Univer Pro パッケージを使う場合も、`@univerjs-pro/*` のバージョンを揃えてください。
|
||||
同じ Univer の協調リリースラインに含まれる `@univerjs/*` SDK パッケージは、同一バージョンに揃えてください。`@univerjs/icons` や `@univerjs/icons-svg` など独立してリリースされるパッケージは、SDK のバージョンではなく、各パッケージマニフェストに宣言された互換バージョンを使用します。Univer Pro を使用する場合は、`@univerjs-pro/*` も対応する協調リリースラインに揃えてください。
|
||||
|
||||
API 互換性、experimental API、internal API、deprecation rules については [API Stability Policy](../API_STABILITY.md) を参照してください。
|
||||
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../img/banner-light.png">
|
||||
<img src="../img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="../img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**스프레드시트, 문서, 프레젠테이션을 만들기 위한 풀스택 동형 오피스 SDK.**
|
||||
|
||||
@@ -24,7 +21,7 @@ Univer는 플러그인 아키텍처, Canvas 기반 렌더링, 수식 엔진,
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -229,7 +226,7 @@ univerAPI.createWorkbook({})
|
||||
| **Preset Mode** | 최소 설정으로 동작하는 Sheets, Docs, Node 구성이 필요할 때. | 이 저장소의 [`presets/`](../../presets) 및 [getting started guide](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | UI 없이 서버 측 워크북/문서 처리, 수식 계산, 자동화가 필요할 때. | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
모든 `@univerjs/*` 패키지는 같은 버전으로 유지하세요. Univer Pro 패키지를 사용하는 경우 `@univerjs-pro/*` 버전도 맞춰야 합니다.
|
||||
동일한 Univer 통합 릴리스 라인에 포함되는 `@univerjs/*` SDK 패키지는 같은 버전으로 맞추세요. `@univerjs/icons`, `@univerjs/icons-svg`처럼 독립적으로 릴리스되는 패키지는 SDK 버전이 아니라 각 패키지 매니페스트에 선언된 호환 버전을 사용합니다. Univer Pro 패키지를 사용한다면 `@univerjs-pro/*`도 해당 통합 릴리스 라인에 맞추세요.
|
||||
|
||||
API 호환성 기대치, experimental APIs, internal APIs, deprecation rules는 [API Stability Policy](../API_STABILITY.md)를 참고하세요.
|
||||
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../img/banner-light.png">
|
||||
<img src="../img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="../img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**用于构建电子表格、文档和演示文稿的全栈、同构办公 SDK。**
|
||||
|
||||
@@ -23,7 +20,7 @@ Univer 以插件化架构、Canvas 渲染引擎、公式引擎和统一的 Facad
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -228,7 +225,7 @@ univerAPI.createWorkbook({})
|
||||
| **Preset Mode** | 你希望用最少配置获得可运行的 Sheets、Docs 或 Node 设置。 | 本仓库的 [`presets/`](../../presets) 和 [快速入门指南](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | 你需要在没有 UI 的情况下进行服务端工作簿/文档处理、公式计算或自动化。 | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
请保持所有 `@univerjs/*` 包版本一致。如果使用 Univer Pro 包，也请保持 `@univerjs-pro/*` 版本一致。
|
||||
同一 Univer 协调发布线中的 `@univerjs/*` SDK 包应保持版本一致。`@univerjs/icons`、`@univerjs/icons-svg` 等独立发布的包应使用各包清单声明的兼容版本，而不是跟随 SDK 版本。使用 Univer Pro 时，也请让 `@univerjs-pro/*` 与对应的协调发布线保持一致。
|
||||
|
||||
关于 API 兼容性预期、实验性 API、内部 API 和废弃规则，请阅读 [API 稳定性政策](../API_STABILITY.md)。
|
||||
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../img/banner-light.png">
|
||||
<img src="../img/banner-dark.png" alt="Univer" width="420" />
|
||||
</picture>
|
||||
<img src="../img/banner.png" alt="Univer SDK" width="800" />
|
||||
|
||||
**用於構建試算表、文件和簡報的全端、同構辦公 SDK。**
|
||||
|
||||
@@ -23,7 +20,7 @@ Univer 以外掛化架構、Canvas 渲染引擎、公式引擎和統一的 Facad
|
||||
[](https://github.com/dream-num/univer/stargazers)
|
||||
[](https://github.com/dream-num/univer/graphs/contributors)
|
||||
[](https://github.com/dream-num/univer/issues)
|
||||
[](https://github.com/dream-num/univer/commits/main/)
|
||||
[](https://github.com/dream-num/univer/commits/dev/)
|
||||
|
||||
[](https://discord.gg/z3NKNT6D2f)
|
||||
[](https://twitter.com/univerhq)
|
||||
@@ -228,7 +225,7 @@ univerAPI.createWorkbook({})
|
||||
| **Preset Mode** | 你希望用最少配置取得可執行的 Sheets、Docs 或 Node 設定。 | 本倉庫的 [`presets/`](../../presets) 和 [快速入門指南](https://docs.univer.ai/guides/sheets/getting-started/installation) |
|
||||
| **Headless Mode** | 你需要在沒有 UI 的情況下進行伺服器端活頁簿/文件處理、公式計算或自動化。 | [Headless Univer](https://docs.univer.ai/guides/sheets/getting-started/node) |
|
||||
|
||||
請保持所有 `@univerjs/*` 套件版本一致。如果使用 Univer Pro 套件，也請保持 `@univerjs-pro/*` 版本一致。
|
||||
同一 Univer 協調發布線中的 `@univerjs/*` SDK 套件應保持版本一致。`@univerjs/icons`、`@univerjs/icons-svg` 等獨立發布的套件應使用各套件資訊清單所宣告的相容版本，而不是跟隨 SDK 版本。使用 Univer Pro 時，也請讓 `@univerjs-pro/*` 與對應的協調發布線保持一致。
|
||||
|
||||
關於 API 相容性預期、實驗性 API、內部 API 和棄用規則，請閱讀 [API 穩定性政策](../API_STABILITY.md)。
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverActionRecorderPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/action-recorder)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -37,4 +37,3 @@ const univer = new Univer({
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/core)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/data-validation` | `UniverDataValidation` | No | No | No |
|
||||
| `@univerjs/data-validation` | `UniverDataValidation` | No | Yes | No |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverDataValidationPlugin } from '@univerjs/data-validation';
|
||||
import DataValidationEnUS from '@univerjs/data-validation/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(DataValidationEnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverDataValidationPlugin);
|
||||
```
|
||||
@@ -35,4 +44,3 @@ univer.registerPlugin(UniverDataValidationPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/data-validation)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -34,4 +34,3 @@ import DesignEnUS from '@univerjs/design/locale/en-US';
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/design)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverDocsDrawingUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-drawing-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/docs-drawing` | `UniverDocsDrawing` | No | No | No |
|
||||
| `@univerjs/docs-drawing` | `UniverDocsDrawing` | No | No | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverDocsDrawingPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-drawing)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -1,13 +1,27 @@
|
||||
# @univerjs/docs-find-replace
|
||||
|
||||
```bash
|
||||
pnpm add @univerjs/docs-find-replace
|
||||
pnpm add @univerjs/docs-find-replace @univerjs/find-replace
|
||||
```
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverDocsFindReplacePlugin } from '@univerjs/docs-find-replace';
|
||||
import { UniverFindReplacePlugin } from '@univerjs/find-replace';
|
||||
import FindReplaceEnUS from '@univerjs/find-replace/locale/en-US';
|
||||
import '@univerjs/find-replace/lib/index.css';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(FindReplaceEnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverFindReplacePlugin);
|
||||
univer.registerPlugin(UniverDocsFindReplacePlugin);
|
||||
```
|
||||
|
||||
Register the shared find-and-replace plugin before the Docs adapter so it can provide the common UI, locale strings, and services. Configure the rest of the Docs plugin stack before adding these two plugins.
|
||||
|
||||
Phase one searches and replaces literal text in the current document body, including tables. It excludes headers, footers, comments, drawings, regular expressions, formatting search, special characters, result sidebars, presets, and Facade APIs.
|
||||
|
||||
@@ -43,4 +43,3 @@ Register this package after the Docs, Docs UI, and Docs hyperlink core packages.
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-hyper-link-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ Use this package with `@univerjs/docs-hyper-link-ui` when users need hyperlink e
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-hyper-link)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverDocsQuickInsertUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-quick-insert-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,14 +10,14 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/docs-thread-comment-ui` | `UniverDocsThreadCommentUi` | Yes | No | No |
|
||||
| `@univerjs/docs-thread-comment-ui` | `UniverDocsThreadCommentUi` | Yes | Yes | No |
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
pnpm add @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui
|
||||
pnpm add @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui @univerjs/thread-comment-ui
|
||||
# or
|
||||
npm install @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui
|
||||
npm install @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui @univerjs/thread-comment-ui
|
||||
```
|
||||
|
||||
Keep all `@univerjs/*` packages on the same version.
|
||||
@@ -25,10 +25,23 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import '@univerjs/docs-thread-comment-ui/lib/index.css';
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import '@univerjs/docs-thread-comment/facade';
|
||||
import { UniverDocsThreadCommentUIPlugin } from '@univerjs/docs-thread-comment-ui';
|
||||
import DocsThreadCommentUIEnUS from '@univerjs/docs-thread-comment-ui/locale/en-US';
|
||||
import { UniverThreadCommentUIPlugin } from '@univerjs/thread-comment-ui';
|
||||
import ThreadCommentUIEnUS from '@univerjs/thread-comment-ui/locale/en-US';
|
||||
import '@univerjs/docs-thread-comment-ui/lib/index.css';
|
||||
import '@univerjs/thread-comment-ui/lib/index.css';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(DocsThreadCommentUIEnUS, ThreadCommentUIEnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverThreadCommentUIPlugin);
|
||||
univer.registerPlugin(UniverDocsThreadCommentUIPlugin);
|
||||
|
||||
const range = univerAPI.getActiveDocument()?.getTextRange(0, 12);
|
||||
@@ -37,11 +50,10 @@ await range?.createCommentAsync('Verify this introduction.', { id: 'review-intro
|
||||
|
||||
## Integration Notes
|
||||
|
||||
Use `@univerjs/docs-thread-comment` for headless model commands and Facade APIs. This UI package adds menus, rendering, and the shared side panel.
|
||||
Register the shared thread-comment UI plugin before the Docs adapter. Use `@univerjs/docs-thread-comment` for headless model commands and Facade APIs; this UI package adds menus, rendering, and the shared side panel. The underlying `@univerjs/thread-comment` plugin is registered automatically as a dependency.
|
||||
|
||||
## Resources
|
||||
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-thread-comment-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverDocsUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverDocsPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/docs)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverDrawingUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/drawing-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverDrawingPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/drawing)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverRenderEnginePlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/engine-render)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverFindReplacePlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/find-replace)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverNetworkPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/network)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -33,4 +33,3 @@ import type { IWorkbookMeta } from '@univerjs/protocol';
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/protocol)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -25,11 +25,15 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { UniverRPCNodeMainPlugin } from '@univerjs/rpc-node';
|
||||
|
||||
univer.registerPlugin(UniverRPCNodeMainPlugin);
|
||||
const workerSrc = fileURLToPath(new URL('./worker.js', import.meta.url));
|
||||
univer.registerPlugin(UniverRPCNodeMainPlugin, { workerSrc });
|
||||
```
|
||||
|
||||
The referenced worker module must create its own Univer instance and register `UniverRPCNodeWorkerPlugin`; see the [Node.js worker example](../../examples/src/node/sdk/worker.ts).
|
||||
|
||||
Exported plugin classes:
|
||||
|
||||
- `UniverRPCNodeMainPlugin`
|
||||
@@ -40,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/rpc-node)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -27,9 +27,13 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
```ts
|
||||
import { UniverRPCMainThreadPlugin } from '@univerjs/rpc';
|
||||
|
||||
univer.registerPlugin(UniverRPCMainThreadPlugin);
|
||||
const worker = new Worker(new URL('./worker.js', import.meta.url), { type: 'module' });
|
||||
univer.registerPlugin(UniverRPCMainThreadPlugin, { workerURL: worker });
|
||||
univer.onDispose(() => worker.terminate());
|
||||
```
|
||||
|
||||
The referenced worker module must create its own Univer instance and register `UniverRPCWorkerThreadPlugin`; see the [browser worker example](../../examples/src/sheets-mobile/worker.ts).
|
||||
|
||||
Exported plugin classes:
|
||||
|
||||
- `UniverRPCMainThreadPlugin`
|
||||
@@ -40,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/rpc)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -44,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-conditional-formatting-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-conditional-formatting` | `UniverSheetsConditionalFormatting` | No | No | Yes |
|
||||
| `@univerjs/sheets-conditional-formatting` | `UniverSheetsConditionalFormatting` | No | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';
|
||||
import EnUS from '@univerjs/sheets-conditional-formatting/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(EnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsConditionalFormattingPlugin);
|
||||
```
|
||||
@@ -39,4 +48,3 @@ Use this package with `@univerjs/sheets-conditional-formatting-ui` when users ne
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-conditional-formatting)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsCrosshairHighlightPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-crosshair-highlight)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -44,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-data-validation-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-data-validation` | `UniverSheetsDataValidation` | No | No | Yes |
|
||||
| `@univerjs/sheets-data-validation` | `UniverSheetsDataValidation` | No | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsDataValidationPlugin } from '@univerjs/sheets-data-validation';
|
||||
import EnUS from '@univerjs/sheets-data-validation/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(EnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsDataValidationPlugin);
|
||||
```
|
||||
@@ -39,4 +48,3 @@ Use this package with `@univerjs/sheets-data-validation-ui` when users need vali
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-data-validation)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsDrawingUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-drawing-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ Use this package with `@univerjs/sheets-drawing-ui` when users need drawing inte
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-drawing)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -45,4 +45,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-filter-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-filter` | `UniverSheetsFilter` | No | No | Yes |
|
||||
| `@univerjs/sheets-filter` | `UniverSheetsFilter` | No | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter';
|
||||
import EnUS from '@univerjs/sheets-filter/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(EnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsFilterPlugin);
|
||||
```
|
||||
@@ -39,4 +48,3 @@ Use this package with `@univerjs/sheets-filter-ui` when users need filter menus
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-filter)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-find-replace` | `UniverSheetsFindReplace` | No | Yes | Yes |
|
||||
| `@univerjs/sheets-find-replace` | `UniverSheetsFindReplace` | No | No | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,12 +25,9 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import EnUS from '@univerjs/sheets-find-replace/locale/en-US';
|
||||
import { UniverSheetsFindReplacePlugin } from '@univerjs/sheets-find-replace';
|
||||
|
||||
univer.registerPlugin(UniverSheetsFindReplacePlugin);
|
||||
|
||||
// Merge EnUS into your Univer locale map when this package contributes UI text.
|
||||
```
|
||||
|
||||
## Integration Notes
|
||||
@@ -42,4 +39,3 @@ Use this package with `@univerjs/find-replace` to share find and replace infrast
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-find-replace)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsFormulaUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-formula-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -47,4 +47,3 @@ Register this package with `@univerjs/engine-formula` and `@univerjs/sheets` bef
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-formula)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-hyper-link-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-hyper-link` | `UniverSheetsHyperLink` | No | No | Yes |
|
||||
| `@univerjs/sheets-hyper-link` | `UniverSheetsHyperLink` | No | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsHyperLinkPlugin } from '@univerjs/sheets-hyper-link';
|
||||
import EnUS from '@univerjs/sheets-hyper-link/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(EnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsHyperLinkPlugin);
|
||||
```
|
||||
@@ -39,4 +48,3 @@ Use this package with `@univerjs/sheets-hyper-link-ui` when users need hyperlink
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-hyper-link)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsNoteUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-note-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ Use this package with `@univerjs/sheets-note-ui` when users need note editing UI
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-note)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsNumfmtUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-numfmt-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ Use this package with `@univerjs/sheets-numfmt-ui` when users need number-format
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-numfmt)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsSortUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-sort-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-sort` | `UniverSheetsSort` | No | Yes | Yes |
|
||||
| `@univerjs/sheets-sort` | `UniverSheetsSort` | No | No | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,12 +25,9 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import EnUS from '@univerjs/sheets-sort/locale/en-US';
|
||||
import { UniverSheetsSortPlugin } from '@univerjs/sheets-sort';
|
||||
|
||||
univer.registerPlugin(UniverSheetsSortPlugin);
|
||||
|
||||
// Merge EnUS into your Univer locale map when this package contributes UI text.
|
||||
```
|
||||
|
||||
## Integration Notes
|
||||
@@ -42,4 +39,3 @@ Use this package with `@univerjs/sheets-sort-ui` when users need sorting menus a
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-sort)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSheetsTableUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-table-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | UMD global | CSS | Locales | Facade entry |
|
||||
| --- | --- | :---: | :---: | :---: |
|
||||
| `@univerjs/sheets-table` | `UniverSheetsTable` | No | No | Yes |
|
||||
| `@univerjs/sheets-table` | `UniverSheetsTable` | No | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -25,7 +25,16 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsTablePlugin } from '@univerjs/sheets-table';
|
||||
import EnUS from '@univerjs/sheets-table/locale/en-US';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(EnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsTablePlugin);
|
||||
```
|
||||
@@ -39,4 +48,3 @@ Use this package with `@univerjs/sheets-table-ui` when users need table controls
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-table)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -15,9 +15,9 @@
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
pnpm add @univerjs/sheets-thread-comment-ui
|
||||
pnpm add @univerjs/sheets-thread-comment-ui @univerjs/thread-comment-ui
|
||||
# or
|
||||
npm install @univerjs/sheets-thread-comment-ui
|
||||
npm install @univerjs/sheets-thread-comment-ui @univerjs/thread-comment-ui
|
||||
```
|
||||
|
||||
Keep all `@univerjs/*` packages on the same version.
|
||||
@@ -25,14 +25,23 @@ Keep all `@univerjs/*` packages on the same version.
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
|
||||
import { UniverSheetsThreadCommentUIPlugin } from '@univerjs/sheets-thread-comment-ui';
|
||||
import SheetsThreadCommentUIEnUS from '@univerjs/sheets-thread-comment-ui/locale/en-US';
|
||||
import { UniverThreadCommentUIPlugin } from '@univerjs/thread-comment-ui';
|
||||
import ThreadCommentUIEnUS from '@univerjs/thread-comment-ui/locale/en-US';
|
||||
import '@univerjs/sheets-thread-comment-ui/lib/index.css';
|
||||
import EnUS from '@univerjs/sheets-thread-comment-ui/locale/en-US';
|
||||
import { UniverSheetsThreadCommentUIPlugin, UniverThreadCommentUIPlugin } from '@univerjs/sheets-thread-comment-ui';
|
||||
import '@univerjs/thread-comment-ui/lib/index.css';
|
||||
|
||||
const univer = new Univer({
|
||||
locale: LocaleType.EN_US,
|
||||
locales: {
|
||||
[LocaleType.EN_US]: mergeLocales(SheetsThreadCommentUIEnUS, ThreadCommentUIEnUS),
|
||||
},
|
||||
});
|
||||
|
||||
univer.registerPlugin(UniverSheetsThreadCommentUIPlugin);
|
||||
univer.registerPlugin(UniverThreadCommentUIPlugin);
|
||||
|
||||
// Merge EnUS into your Univer locale map when this package contributes UI text.
|
||||
univer.registerPlugin(UniverSheetsThreadCommentUIPlugin);
|
||||
```
|
||||
|
||||
## Resources
|
||||
@@ -40,4 +49,3 @@ univer.registerPlugin(UniverThreadCommentUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-thread-comment-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ Use this package with `@univerjs/sheets-thread-comment-ui` when users need comme
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-thread-comment)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -44,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -38,4 +38,3 @@ univer.registerPlugin(UniverSheetsPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/sheets)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -39,4 +39,3 @@ univer.registerPlugin(UniverSlidesUIPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/slides-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverSlidesPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/slides)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -33,4 +33,3 @@ import { ITelemetryService } from '@univerjs/telemetry';
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/telemetry)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -43,4 +43,3 @@ Product-specific packages such as `@univerjs/sheets-thread-comment-ui` and `@uni
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/thread-comment-ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -83,4 +83,3 @@ Product-specific packages such as `@univerjs/sheets-thread-comment` and `@univer
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/thread-comment)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverVue3AdapterPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/ui-adapter-vue3)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Register custom elements with the `web-component` framework option. Runtime prop
|
||||
|
||||
```ts
|
||||
class MyPopup extends HTMLElement {
|
||||
set data(value) {
|
||||
set data(value: { label?: string } | undefined) {
|
||||
this.textContent = value?.label ?? '';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -44,4 +44,3 @@ Exported plugin classes:
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/ui)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -35,4 +35,3 @@ univer.registerPlugin(UniverWatermarkPlugin);
|
||||
- [Documentation](https://docs.univer.ai)
|
||||
- [NPM package](https://npmjs.com/package/@univerjs/watermark)
|
||||
- [GitHub repository](https://github.com/dream-num/univer)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
| Package | CSS | Locales | Facade entry |
|
||||
| ------------------------------- | :-: | :-----: | :----------: |
|
||||
| `@univerjs/preset-docs-drawing` | Yes | Yes | No |
|
||||
| `@univerjs/preset-docs-drawing` | Yes | Yes | Yes |
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user