Skip to content

Commit 56f6b1f

Browse files
committed
docs: update release notes and package guidance
1 parent 00dc952 commit 56f6b1f

88 files changed

Lines changed: 268 additions & 189 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,45 @@
11
# Changelog
22

3+
## [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)
4+
5+
### Features
6+
7+
* **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))
8+
9+
### Performance Improvements
10+
11+
* **engine-formula:** optimize shared-formula lookup ([9251e0d](https://github.com/dream-num/univer/commit/9251e0d30))
12+
* **sheets:** deduplicate floating-DOM zoom updates ([d3114d8](https://github.com/dream-num/univer/commit/d3114d89f))
13+
14+
### Bug Fixes
15+
16+
* **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))
17+
* **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))
18+
* **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))
19+
* **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))
20+
* **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))
21+
22+
## [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)
23+
24+
### Features
25+
26+
* **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))
27+
* **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))
28+
* **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))
29+
* **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))
30+
31+
### Performance Improvements
32+
33+
* **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))
34+
* **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))
35+
36+
### Bug Fixes
37+
38+
* **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))
39+
* **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))
40+
* **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))
41+
* **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))
42+
343
## [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)
444

545
### Bug Fixes
@@ -963,7 +1003,7 @@ No classifiable changes.
9631003
* **shape:** add option handle in interface ([#6369](https://github.com/dream-num/univer/issues/6369)) ([603da2d](https://github.com/dream-num/univer/commit/603da2d751101ff93cc6dadd669600c5d32724cc))
9641004
* **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))
9651005

966-
# [0.14.0](/compare/v0.13.0...v0.14.0) (2025-12-20)
1006+
# [0.14.0](https://github.com/dream-num/univer/compare/v0.13.0...v0.14.0) (2025-12-20)
9671007

9681008

9691009
### Bug Fixes
@@ -996,7 +1036,7 @@ No classifiable changes.
9961036
* **sheets-conditional-formatting:** use other-formula-service on conditional-formatting (#6322) a1b7d95, closes #6322
9971037
* **sheets:** add biz info on other formula (#6296) 23f6ae2, closes #6296
9981038

999-
# [0.13.0](/compare/v0.12.4...v0.13.0) (2025-12-13)
1039+
# [0.13.0](https://github.com/dream-num/univer/compare/v0.12.4...v0.13.0) (2025-12-13)
10001040

10011041

10021042
### Bug Fixes
@@ -1031,7 +1071,7 @@ No classifiable changes.
10311071
* **formula:** dependency tree and calculation api (#6258) e67908f, closes #6258
10321072
* set active selections by defined name input (#6138) 972097c, closes #6138
10331073

1034-
## [0.12.4](/compare/v0.12.3...v0.12.4) (2025-12-06)
1074+
## [0.12.4](https://github.com/dream-num/univer/compare/v0.12.3...v0.12.4) (2025-12-06)
10351075

10361076

10371077
### Bug Fixes
@@ -1052,7 +1092,7 @@ No classifiable changes.
10521092
* **sheets:** split insert sheet command on large data (#6214) 09cc69a, closes #6214
10531093
* **ui:** add font management service & support appending custom font family (#6237) 7c1c2c9, closes #6237
10541094

1055-
## [0.12.3](/compare/v0.12.2...v0.12.3) (2025-11-29)
1095+
## [0.12.3](https://github.com/dream-num/univer/compare/v0.12.2...v0.12.3) (2025-11-29)
10561096

10571097

10581098
### Bug Fixes

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,12 @@ The structure of the repository is as follows:
6161

6262
```txt
6363
.
64-
├── common/ shared configuration and utilities
64+
├── common/ shared configuration, mock data, Storybook, and utilities
6565
├── docs/ documentation
6666
├── examples/ all-in-one Vite workbench for browser development
6767
├── packages/ Univer core and plugins
68+
├── presets/ curated plugin collections
69+
└── tests/ additional integration test projects
6870
```
6971

7072
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).
135137

136138
Before merging a pull request, please make sure the following requirements are met:
137139

138-
- All tests are passed. ESLint and Prettier errors are fixed.
140+
- All tests pass. ESLint, including its formatting checks, passes.
139141
- Test coverage is not decreased.
140142

141143
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
166168
pnpm test
167169
```
168170

169-
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.
171+
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/`.
170172

171173
![vitest](./docs/img/vitest.png)
172174

@@ -176,11 +178,11 @@ Also, with the help of vscode and its rich ecosystem, you could directly debug u
176178

177179
### Build Preview
178180

179-
After building, the output may differ from the source code. To test for any differences, you can link to the built artifacts using:
181+
Build the production artifacts to check for differences between the source and compiled output:
180182

181183
```shell
182184
pnpm build
183-
pnpm dev:libs
185+
pnpm dev:umd
184186
```
185187

186188
### Clean code

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ English | [简体中文](./docs/readme/zh-CN.md) | [繁體中文](./docs/readme/
2020
[![Stars](https://img.shields.io/github/stars/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/stargazers)
2121
[![Contributors](https://img.shields.io/github/contributors/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/graphs/contributors)
2222
[![Issues](https://img.shields.io/github/issues/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/issues)
23-
[![Last Commit](https://img.shields.io/github/last-commit/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/commits/main/)
23+
[![Last Commit](https://img.shields.io/github/last-commit/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/commits/dev/)
2424

2525
[![Discord](https://img.shields.io/discord/1136129819961217077?logo=discord&logoColor=FFFFFF&label=discord&color=5865F2&style=flat-square)](https://discord.gg/z3NKNT6D2f)
2626
[![Twitter](https://img.shields.io/twitter/follow/univerhq?style=flat-square&logo=x)](https://twitter.com/univerhq)
@@ -225,7 +225,7 @@ Learn more in the [Installation & Basic Usage guide](https://docs.univer.ai/guid
225225
| **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) |
226226
| **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) |
227227

228-
Keep all `@univerjs/*` packages on the same version. If you use Univer Pro packages, keep `@univerjs-pro/*` versions aligned as well.
228+
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.
229229

230230
For API compatibility expectations, experimental APIs, internal APIs, and deprecation rules, see the [API Stability Policy](./docs/API_STABILITY.md).
231231

docs/API_STABILITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Pull requests that introduce breaking changes should include a `BREAKING CHANGE:
7272

7373
## Package Version Alignment
7474

75-
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.
75+
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.
7676

77-
Mixing package versions can bypass compatibility checks and produce runtime failures, especially around plugin registration, Facade API composition, locales, commands, and shared data models.
77+
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.
7878

7979
## Public API Checklist
8080

docs/CONTRIBUTING-FACADE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,4 @@ All APIs/constants/enums should be accessible from the `univerAPI` variable.
4848

4949
## Documentation
5050

51-
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.
52-
51+
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.

docs/FIX_MEMORY_LEAK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For example: dream-num/univer@6423ff8/packages/sheets-drawing-ui/src/controllers
3131
3232
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.
3333
34-
For example: https://github.com/dream-num/univer/blob/dev/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts#L433.
34+
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).
3535
3636
**HOW TO FIX**: Please consider extracting the related logic to an `IRenderModule` instead.
3737

docs/NAMING_CONVENTION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export interface ISomeCommandParams {
119119
// Define the parameters here
120120
}
121121

122-
export const SomeCommand = ICommand<ISomeCommandParams> = {
122+
export const SomeCommand: ICommand<ISomeCommandParams> = {
123123
id: '<business-type>.<command-type>.<command-name>',
124124
};
125125
```
@@ -153,7 +153,7 @@ export const ResolveCommentCommand: ICommand<IResolveCommentCommandParams> = {
153153

154154
## Id
155155

156-
All IDs should be in pascal case: `id` or `Id`.
156+
Within camelCase or PascalCase identifiers, use `Id` instead of `ID` (for example, `unitId` and `getUnitId`). Keep the standalone property name `id` lowercase.
157157

158158
## Locale Keys
159159

docs/readme/es-ES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ renderizado basado en Canvas, un motor de fórmulas y una Facade API que funcion
2020
[![Stars](https://img.shields.io/github/stars/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/stargazers)
2121
[![Contributors](https://img.shields.io/github/contributors/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/graphs/contributors)
2222
[![Issues](https://img.shields.io/github/issues/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/issues)
23-
[![Last Commit](https://img.shields.io/github/last-commit/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/commits/main/)
23+
[![Last Commit](https://img.shields.io/github/last-commit/dream-num/univer?style=flat-square)](https://github.com/dream-num/univer/commits/dev/)
2424

2525
[![Discord](https://img.shields.io/discord/1136129819961217077?logo=discord&logoColor=FFFFFF&label=discord&color=5865F2&style=flat-square)](https://discord.gg/z3NKNT6D2f)
2626
[![Twitter](https://img.shields.io/twitter/follow/univerhq?style=flat-square&logo=x)](https://twitter.com/univerhq)
@@ -225,7 +225,7 @@ Consulta más detalles en la [guía de instalación y uso básico](https://docs.
225225
| **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) |
226226
| **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) |
227227

228-
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/*`.
228+
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.
229229

230230
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).
231231

0 commit comments

Comments
 (0)