Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

docs: standardize package READMEs (#8165)

白熱dd40200fb2fe
diff --git a/packages/action-recorder/README.md b/packages/action-recorder/README.md
index 632c3b87cf..b91c9e76f5 100644
--- a/packages/action-recorder/README.md
+++ b/packages/action-recorder/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/action-recorder` | `UniverActionRecorder` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/action-recorder` | `UniverActionRecorder` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/action-recorder
npm install @univerjs/action-recorder
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/action-recorder/lib/index.css';
import EnUS from '@univerjs/action-recorder/locale/en-US';
diff --git a/packages/core/README.md b/packages/core/README.md
index cfd58dca0e..fc326c8d0b 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/core` | `UniverCore` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/core` | `UniverCore` | No | No | Yes | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/core
npm install @univerjs/core
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
@@ -32,6 +30,10 @@ const univer = new Univer({
});
```
+## Integration Notes
+
+- Import `@univerjs/core/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/data-validation/README.md b/packages/data-validation/README.md
index 88b854b48d..30db8269f3 100644
--- a/packages/data-validation/README.md
+++ b/packages/data-validation/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/data-validation` | `UniverDataValidation` | No | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/data-validation` | `UniverDataValidation` | No | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/data-validation
npm install @univerjs/data-validation
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverDataValidationPlugin } from '@univerjs/data-validation';
diff --git a/packages/design/README.md b/packages/design/README.md
index cf96382056..a6e475c329 100644
--- a/packages/design/README.md
+++ b/packages/design/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/design` | `UniverDesign` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/design` | `UniverDesign` | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/design
npm install @univerjs/design
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/packages/docs-drawing-ui/README.md b/packages/docs-drawing-ui/README.md
index c5d776ac28..4054111c5c 100644
--- a/packages/docs-drawing-ui/README.md
+++ b/packages/docs-drawing-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-drawing-ui` | `UniverDocsDrawingUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-drawing-ui` | `UniverDocsDrawingUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-drawing-ui
npm install @univerjs/docs-drawing-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/docs-drawing-ui/lib/index.css';
import EnUS from '@univerjs/docs-drawing-ui/locale/en-US';
diff --git a/packages/docs-drawing/README.md b/packages/docs-drawing/README.md
index 08bec3b982..4b24c146f1 100644
--- a/packages/docs-drawing/README.md
+++ b/packages/docs-drawing/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-drawing` | `UniverDocsDrawing` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-drawing` | `UniverDocsDrawing` | No | No | Yes | No |
## Installation
@@ -20,16 +20,20 @@ pnpm add @univerjs/docs-drawing
npm install @univerjs/docs-drawing
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDocsDrawingPlugin } from '@univerjs/docs-drawing';
univer.registerPlugin(UniverDocsDrawingPlugin);
```
+## Integration Notes
+
+- Import `@univerjs/docs-drawing/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/docs-find-replace/README.md b/packages/docs-find-replace/README.md
index 634bfe1908..11b756259e 100644
--- a/packages/docs-find-replace/README.md
+++ b/packages/docs-find-replace/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-find-replace` | `UniverDocsFindReplace` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-find-replace` | `UniverDocsFindReplace` | No | No | No | No |
## Installation
@@ -22,6 +22,8 @@ npm install @univerjs/docs-find-replace @univerjs/find-replace
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverDocsFindReplacePlugin } from '@univerjs/docs-find-replace';
diff --git a/packages/docs-hyper-link-ui/README.md b/packages/docs-hyper-link-ui/README.md
index 059a4fab56..baff285df6 100644
--- a/packages/docs-hyper-link-ui/README.md
+++ b/packages/docs-hyper-link-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-hyper-link-ui` | `UniverDocsHyperLinkUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-hyper-link-ui` | `UniverDocsHyperLinkUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-hyper-link-ui
npm install @univerjs/docs-hyper-link-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/docs-hyper-link-ui/lib/index.css';
import EnUS from '@univerjs/docs-hyper-link-ui/locale/en-US';
diff --git a/packages/docs-hyper-link/README.md b/packages/docs-hyper-link/README.md
index ab87e7a5e0..2a3405e49b 100644
--- a/packages/docs-hyper-link/README.md
+++ b/packages/docs-hyper-link/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-hyper-link` | `UniverDocsHyperLink` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-hyper-link` | `UniverDocsHyperLink` | No | No | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-hyper-link
npm install @univerjs/docs-hyper-link
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDocsHyperLinkPlugin } from '@univerjs/docs-hyper-link';
diff --git a/packages/docs-thread-comment-ui/README.md b/packages/docs-thread-comment-ui/README.md
index 2bebc7d631..90c45e131c 100644
--- a/packages/docs-thread-comment-ui/README.md
+++ b/packages/docs-thread-comment-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-thread-comment-ui` | `UniverDocsThreadCommentUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-thread-comment-ui` | `UniverDocsThreadCommentUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui @univerj
npm install @univerjs/docs-thread-comment @univerjs/docs-thread-comment-ui @univerjs/thread-comment-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import '@univerjs/docs-thread-comment/facade';
diff --git a/packages/docs-thread-comment/README.md b/packages/docs-thread-comment/README.md
index 7f9ba45ccc..c5f334183b 100644
--- a/packages/docs-thread-comment/README.md
+++ b/packages/docs-thread-comment/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-thread-comment` | `UniverDocsThreadComment` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-thread-comment` | `UniverDocsThreadComment` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-thread-comment
npm install @univerjs/docs-thread-comment
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDocsThreadCommentPlugin } from '@univerjs/docs-thread-comment';
import '@univerjs/docs-thread-comment/facade';
diff --git a/packages/docs-toc-ui/README.md b/packages/docs-toc-ui/README.md
index 867251f8d2..e898c737ac 100644
--- a/packages/docs-toc-ui/README.md
+++ b/packages/docs-toc-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-toc-ui` | `UniverDocsTocUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-toc-ui` | `UniverDocsTocUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-toc-ui
npm install @univerjs/docs-toc-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/docs-toc-ui/lib/index.css';
import EnUS from '@univerjs/docs-toc-ui/locale/en-US';
diff --git a/packages/docs-toc/README.md b/packages/docs-toc/README.md
index f87fcafcc2..68c723b179 100644
--- a/packages/docs-toc/README.md
+++ b/packages/docs-toc/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-toc` | `UniverDocsToc` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-toc` | `UniverDocsToc` | No | No | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-toc
npm install @univerjs/docs-toc
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDocsTocPlugin } from '@univerjs/docs-toc';
diff --git a/packages/docs-ui/README.md b/packages/docs-ui/README.md
index 48201ee09f..30d8027856 100644
--- a/packages/docs-ui/README.md
+++ b/packages/docs-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs-ui` | `UniverDocsUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs-ui` | `UniverDocsUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/docs-ui
npm install @univerjs/docs-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/docs-ui/lib/index.css';
import EnUS from '@univerjs/docs-ui/locale/en-US';
@@ -34,77 +34,9 @@ univer.registerPlugin(UniverDocsUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
-## Document outline (`toc`)
-
-The optional `IUniverDocsUIConfig.toc` setting controls the left-hand document outline for heading navigation.
-
-| `toc` | Modern documents | Traditional documents |
-| --- | --- | --- |
-| Omitted | Enabled | Disabled |
-| `true` | Enabled | Enabled |
-| `false` | Disabled | Disabled |
-
-Set it when registering the plugin to override the document mode's default:
-
-```ts
-univer.registerPlugin(UniverDocsUIPlugin, {
- toc: false,
-});
-```
-
-Preset integrations can pass the same option to `UniverDocsCorePreset({ container: 'app', toc: false })`.
-When enabled, the outline collapses if there is insufficient space or table content overlaps it,
-and reopens when the layout provides enough space without overlap.
-
-## Heading collapse
-
-Modern documents show a Canvas triangle beside visible Heading 1 through Heading 5 paragraphs
-that have section content. Click it to collapse or expand the section. This is independent of
-the document outline's `toc` setting. Traditional documents and embedded text editors do not
-show these controls.
-
-Collapsing keeps the heading visible and hides its following section, including nested headings,
-tables, and images. Expanding the parent retains each nested heading's own collapse state.
-Hidden content remains in the document snapshot. Collapse changes participate in undo/redo and
-collaboration, so other editors share the state. Selections inside hidden content move to a
-visible heading, and caret navigation skips hidden content. Collaborative table edits and history
-can update hidden cells without drawing a rectangular selection over that heading.
-
-The paragraph menu leaves the Canvas arrow accessible when constrained against the canvas edge,
-including headings resolved through inherited styles. The triangle and its tooltip are drawn on Canvas. Colors follow `ThemeService`, including
-runtime theme changes. After a 500 ms hover, the control shows the localized “Collapse”
-or “Expand” tooltip above it; if the viewport clips the top, the tooltip appears below.
-Scrolling, zooming, leaving the control, or activating it clears the tooltip.
-
-See [the snapshot and command contract](../docs/README.md#heading-collapse-in-modern-documents)
-to change collapse state programmatically through `SetHeadingCollapsedCommand`.
-
-## Format painter
-
-Use the shared Start ribbon format painter to copy character formatting. Include a paragraph
-mark in the source selection to also copy paragraph formatting and list formatting. Drag over
-a target selection or click a word to apply. Text, paragraph identities, and embedded entities
-are retained, and each application is undoable. The same text command serves embedded Shape
-text editors. The source format is captured when the brush is activated.
-The clear-formatting icon resets the selected text and paragraphs to default formatting,
-retains their content and identities, and supports undo.
-
-## Typing format at text boundaries
-
-Backspace in ordinary document text retains the removed character's formatting for immediate
-input. Forward Delete and Cut resolve formatting at the surviving caret. Replacing a text
-selection uses its first character's format, regardless of selection direction. In table cells,
-character-by-character Backspace resolves the surviving caret format; selection Backspace retains
-the first selected character's format.
+## Integration Notes
-Retained typing format is transient and clears on explicit selection changes or document switches.
-Formatting commands such as Bold update this input format without clearing it.
-It is not serialized as an empty text run. Explicit `paragraphMarkTextStyle` remains authoritative
-after repositioning or reopening; deletion does not overwrite this explicit paragraph style.
-Modern paragraphs, including list items, retain their first character's formatting on the existing
-paragraph-ending character when all text is deleted. This keeps empty-paragraph input and list
-markers stable after editing elsewhere, undo/redo and reopening. Explicit list-marker and
-paragraph-mark style overrides retain their precedence.
+- Import `@univerjs/docs-ui/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/docs/README.md b/packages/docs/README.md
index 710af1e158..58b8390762 100644
--- a/packages/docs/README.md
+++ b/packages/docs/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/docs` | `UniverDocs` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/docs` | `UniverDocs` | No | No | Yes | Yes |
## Installation
@@ -20,17 +20,17 @@ pnpm add @univerjs/docs
npm install @univerjs/docs
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDocsPlugin } from '@univerjs/docs';
univer.registerPlugin(UniverDocsPlugin);
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverDocsLayoutWorkerPlugin` from `@univerjs/docs`. Register it alongside `UniverDocsPlugin` and set `workerFactory` to a function that creates the layout worker.
@@ -42,55 +42,9 @@ import { UniverDocsWorkerPlugin } from '@univerjs/docs/worker';
univer.registerPlugin(UniverDocsWorkerPlugin);
```
-## Heading collapse in Modern documents
-
-Modern documents (`DocumentFlavor.MODERN`) support collapsing Heading 1 through Heading 5.
-The heading stays visible; its section extends to the next heading of the same or a higher
-level, or the end of its content flow. Each table cell and Modern column has its own heading
-hierarchy. Expanding a parent preserves the collapse flags of its nested headings.
-Traditional documents ignore these flags.
-
-`IParagraph.headingCollapsed` is an optional boolean in the document snapshot. Only `true`
-collapses a heading; `false` or an omitted flag leaves it expanded. Collapsing changes layout
-visibility without deleting the section's text, tables, images, or other snapshot content.
-Saving and reopening a Univer snapshot retains the flag. This contract does not establish
-preservation through Office import or export.
-
-### Change collapse state with a command
-
-`UniverDocsPlugin` registers `SetHeadingCollapsedCommand` (`doc.command.set-heading-collapsed`).
-After registering the plugin and creating the document, execute the registered command through
-the Facade API or `ICommandService`; do not call its handler or mutate the model directly.
-For an existing `univerAPI` instance:
-
-```ts
-import { SetHeadingCollapsedCommand } from '@univerjs/docs';
-
-const changed = await univerAPI.executeCommand(SetHeadingCollapsedCommand.id, {
- unitId: documentId,
- paragraphId: headingParagraphId,
- collapsed: true,
-});
-```
-
-Pass the document's unit ID, the heading's stable paragraph ID, and the desired boolean state.
-Use `collapsed: false` to expand. The command returns `false` for a no-op or an invalid target,
-including Traditional or disabled documents, headings hidden by an ancestor, empty sections
-when collapsing, and targets without edit permission.
-
-Concurrent paragraph formatting preserves inherited style references and imported numbering metadata;
-a full replacement can still explicitly clear those fields.
-
-Collapse state is shared document state, not a personal view preference. The command uses the
-rich-text mutation path for undo/redo and collaboration. Undoing a fold preserves later peer
-character formatting and enclosing field or content-control properties that the fold did not edit.
-A selection hidden by a collapse moves to the visible heading. Worker layout uses the same flags
-after edits, undo/redo, and snapshot recovery; visibility changes rebuild the affected layout and retain the published viewport until
-replacement content is ready. Hidden tables and images are omitted from layout publications,
-while their source data remains in the snapshot. Rejected edits with empty operations do not
-advance the Worker mutation queue or force the next real edit to resnapshot the document.
+## Integration Notes
-See [the editor interaction details](../docs-ui/README.md#heading-collapse) for the Canvas control.
+- Import `@univerjs/docs/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/drawing-ui/README.md b/packages/drawing-ui/README.md
index cc0d0d030f..ac229c60e9 100644
--- a/packages/drawing-ui/README.md
+++ b/packages/drawing-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/drawing-ui` | `UniverDrawingUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/drawing-ui` | `UniverDrawingUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/drawing-ui
npm install @univerjs/drawing-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/drawing-ui/lib/index.css';
import EnUS from '@univerjs/drawing-ui/locale/en-US';
@@ -34,18 +34,6 @@ univer.registerPlugin(UniverDrawingUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
-## OLE online conversion
-
-For collaborative Sheets, Docs and Slides, configure `ole.getLink` on `UniverDrawingPlugin`. The existing Pro `UniverExchangeClientPlugin` installs `ole.convertOffice`, `ole.convertToOnline` and the exact-Unit collaboration check; it preserves application-provided callbacks. Conversion keeps stage progress on the source page. The host's normal drawing mutation commands save only `{ unitId, type }` on the original drawing. After that reference is saved, a persistent completion notification offers an Open action. A new tab opens only when the user clicks Open, either in that notification or in the drawing toolbar. The original attachment is retained.
-
-`ole.getLink(unitId, type)` synchronously resolves a relative or absolute HTTP(S) URL on every Open action, including the completion notification. It is not called during conversion. There is no default application route. Without this callback, online actions stay hidden; preview and download follow their own capabilities. Legacy stored `url` fields are ignored, so changing the configured domain or route does not require rewriting existing online references.
-
-The shared `OleObject` in this package paints OLE attachment glyphs and captions directly on Canvas. It reuses existing engine image geometry, clipping and hit testing; OLE render paths skip native bitmap loading and caching. No additional plugin registration is required.
-
-Common Drawing UI owns the toolbar, preview dialog and temporary viewer lifecycle. The existing `@univerjs/sheets-drawing-ui`, `@univerjs/docs-drawing-ui` and `@univerjs-pro/slides-ui` modules supply their own read-only renderers. Cross-type preview requires the target product UI module, styles and locale resources to be loaded: a Sheet-only application must also load the Doc UI module to preview Word attachments. Module loading registers a stateless renderer without creating a target Unit or requiring another OLE plugin registration. If no renderer or application override is available, Preview is disabled with a localized explanation before reading or converting the attachment; Download remains available. Applications may override `ole.previewOffice` or `ole.createOfficePreview`. See the [integration guide](../drawing/docs/ole-attachments.md).
-
-Keep the source page open until reference saving completes. Closing the host stops local polling and progress UI; it does not delete an online Unit already created by the server. Applications own durable task recovery. A failed reference save can be retried in the same session without converting the attachment again.
-
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/drawing/README.md b/packages/drawing/README.md
index 8a4f26edce..94b98ff2cb 100644
--- a/packages/drawing/README.md
+++ b/packages/drawing/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/drawing` | `UniverDrawing` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/drawing` | `UniverDrawing` | No | No | No | No |
## Installation
@@ -20,22 +20,16 @@ pnpm add @univerjs/drawing
npm install @univerjs/drawing
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverDrawingPlugin } from '@univerjs/drawing';
univer.registerPlugin(UniverDrawingPlugin);
```
-## OLE online references
-
-An OLE drawing retains its `oleAttachmentId`, which identifies the original attachment's resource record. After explicit online conversion, `oleOnlineUnit` stores only the new Unit's `unitId` and `type`; it does not store a URL or embed the converted Unit's snapshot.
-
-Configure `ole.getLink(unitId, type)` on `UniverDrawingPlugin` to resolve the application's current URL on each explicit Open action. There is no default application route. The existing Pro `UniverExchangeClientPlugin` supplies conversion callbacks without adding a separate OLE plugin or owning navigation. Legacy stored `url` fields remain unchanged and are ignored when opening. See the [OLE integration guide](./docs/ole-attachments.md) for configuration and transport boundaries.
-
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/engine-formula/README.md b/packages/engine-formula/README.md
index 49fff628c6..c9029bac07 100644
--- a/packages/engine-formula/README.md
+++ b/packages/engine-formula/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/engine-formula` | `UniverEngineFormula` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/engine-formula` | `UniverEngineFormula` | No | Yes | Yes | Yes |
## Installation
@@ -20,79 +20,17 @@ pnpm add @univerjs/engine-formula
npm install @univerjs/engine-formula
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula';
univer.registerPlugin(UniverFormulaEnginePlugin);
```
-## Formula cache ownership
-
-The formula plugin registers one `FormulaCacheService` per Univer injector. Parsed ASTs and expanded lexer trees belong to that instance. Range arrays and comparison indexes belong to a calculation context that is released on completion, failure, reset, or disposal. Closing a workbook invalidates only that workbook's entries. Disposing one Univer does not clear another instance's caches.
-
-Registering, replacing, or unregistering a function invalidates its cached ASTs and expanded lexer trees using the parser's function-name normalization. Cached unknown-function errors are refreshed for names with whitespace, supported Excel prefixes, and aliases as well as ordinary names.
-
-`FormulaCacheService` is internal and is not exported from the package root. Integrations and cross-package test fixtures initialize formula dependencies through `UniverFormulaEnginePlugin` or the corresponding Pro plugin, which registers the owning cache service. `Lexer` owns expanded-tree cache lookup and invalidation. `LexerTreeBuilder` has no service dependency and always builds a fresh tree. Standalone and editor callers can construct it directly. Custom runtime implementations may omit the optional calculation-cache hooks; references then compute without caching.
-
-Range-array and comparison-index invalidation uses the owning runtime's `clearArrayObjectCache()` and `clearInvertedIndexCache()` hooks. The obsolete `FORMULA_REF_TO_ARRAY_CACHE` and `CELL_INVERTED_INDEX_CACHE` globals are removed. Facade usage, workbook IDs, snapshots, and collaboration changesets are unchanged.
-
-## Calculation input and result ownership
-
-Formula capture, load, and execution capabilities are internal interfaces shared by cooperating calculation engines, not application or Facade APIs. Their exports and type declarations remain available for cross-package integration; this does not make them stable public extension points. Validate the exact OSS, Pro, and engine versions together under the [API stability policy](../../docs/API_STABILITY.md).
-
-`IFormulaDataSnapshot` captures ephemeral calculation input, not a persisted Workbook snapshot or a replacement for `IWorkbookData`. It preserves formula values even when the Workbook is edited later. `materialize()` returns an owned, mutable formula DTO and caches it for later reads. `FormulaCurrentConfigService` can defer materialization until `getFormulaData()`; another load, formula-data registration, or disposal replaces that deferred state.
-
-Capture requires an engine to explicitly advertise `supportsFormulaDataSnapshot === true`, provide its execution method, and successfully prepare the input. Otherwise calculation retains the existing complete DTO and `execute()` route. A captured input contains a method and cannot be sent as an RPC payload. Worker and remote adapters retain serializable input unless their protocol explicitly supports another format; do not probe unknown methods through a generic RPC proxy.
-
-Capture shares the ordinary Workbook, Worksheet, and ObjectMatrix traversal, array preparation, and formula-field read order. It does not inspect private model storage or qualify every cell accessor. Ordinary formulas use bounded coordinate/string-reference chunks instead of one DTO cell object each. Shared formulas, unusual values, or unsupported coordinates switch that sheet to ordinary DTO output using the captured entries, without rescanning the source. Base formulas retain their DTO preparation; materialization releases the compact chunks.
-
-`IFormulaRuntimeService.beginCircularReferences()` preserves and validates previous cycle records for incremental Web/Pro calculation. An engine supplying the complete current cycle set can pass `true` to start an empty pending set without reading the formula DTO. Recording and completion still copy diagnostics, and stopped calculations do not replace the published set. An empty completed set clears resolved cycles; UI alerts and `FWorkbook.getCircularReferences()` continue to consume the published records.
-
-Customized formula-model preparation or initially customized output-matrix methods and relevant Object.prototype properties retain the eager route. Output-matrix and DTO prototypes must remain stable during synchronous capture; prototype mutations inside source getters are outside this capability contract. Ordinary source methods and getters remain supported. An optional Proxy classifier can reject a proxied formula model before preparation.
-
-`FormulaResultService` is the shared batch writer for Web, Pro, and native engines. It submits array/image/dependency metadata and cell results through the existing mutations. Web/Pro release calculation contexts after materializing results and before awaiting model application. Engines await the writer before publishing completion; `CalculateController` publishes the terminal notification without submitting results again. Native engines may submit intermediate dependency passes so feature callbacks reading Workbook values see the current pass. A completion remains an `IAllRuntimeData` snapshot; it is not a request to replay its values.
-
-Custom calculation-service implementations must use the writer for their batches before emitting completion. Subclasses calling the base `CalculateFormulaService` constructor must inject and pass `FormulaResultService`. Upgrade cooperating OSS, Pro, and native Wrapper integrations together; no result-ownership capability probe or extra mutation field is required.
-
-Delayed or absent application acknowledgements never cause an automatic duplicate submission. An integration that rejects delivery must retain and explicitly reapply its result through the shared writer; recalculation is not delivery retry because native output can omit unchanged cached cells. A thrown writer command rejects `execute()` and releases runtime data without announcing successful completion. Low-level callers must handle execution failures as well as completion events.
-
-After all required acknowledgements, the session synchronously emits the complete `resultApplied$` payload, then releases its strong reference if that session and result are still current. Duplicate acknowledgements use weak identity bookkeeping. Reentrant listeners must not have their new session overwritten; subscribers retaining a payload own that reference.
-
-Completion no longer adds a duplicate result mutation, including for arrays, multiple worksheets, other-formula grids, and pending acknowledgements. Result mutations carry `applyFormulaCalculationResult: true`. Engine-generated array metadata mutations carry `fromFormula: true` and `onlyLocal: true`; consumers must distinguish them from genuine edits without feeding formula output into another calculation. Public Workbook/Worksheet/ObjectMatrix models and persisted snapshot schemas remain unchanged. These controllers and session services are shared by browser and headless integrations.
-
-### Consumer validation
-
-- Compare OSS and Pro values, types, errors, formula text, formats, shared formulas, arrays, circular references, and incremental edits with the cooperating versions.
-- Check Pro last-value persistence, external references, and other-formula results; persistence must run once for each applied result batch.
-- Exercise formula replacement/removal, spill growth/shrinkage, blocked spills, undo/redo, and structural edits, checking mutation notifications as well as values.
-- Verify delayed, early, duplicate, and reentrant acknowledgements, stopped/failed calculations, disposal, independent instances, worker/RPC fallbacks, and collaboration consumers of mutation options or counts.
-
-Value comparisons alone do not establish notification, worker-protocol, or Pro compatibility. Each supported runtime must satisfy the result-application and event contracts.
-
-## Formula reference compatibility
-
-Formula reads convert rich-text paragraph separators to Excel's LF line breaks.
-Saved rich-text documents and CRLF in plain string values remain unchanged. This
-also corrects `LEN` and `SEARCH` over rich-text references; recalculate existing
-formula caches to refresh affected results. Public models and mutations are unchanged.
-
-`PV` uses integer compounding for whole periods with an absolute value no greater
-than 2,147,483,647, taking the reciprocal for negative periods. This preserves the
-factor before cancellation in small loan balances. Fractional and larger periods
-retain floating exponentiation. Last digits may change; formulas,
-Workbook models and snapshots require no migration. Pro and native integrations
-must use the matching correction. XIRR retains its current numerical precision;
-its result can differ from Excel's earlier stopping point.
-
-Reference-form `INDEX` returns `#VALUE!` when its areas span different worksheets or workbooks. References that resolve to the same worksheet remain valid.
-
-Use whole-span quoting for quoted 3D ranges, such as `'Jan:Mar'!B2:C3`. Separately quoted endpoints, such as `'Jan':'Mar'!B2:C3` and the Excel-saved `Jan:'Mar'!B2:C3` form, return `#NAME?` for both single-cell and rectangular references. Ordinary ranges such as `Jan!B2:'Jan'!C3` remain supported. Adjust formulas that depend on these invalid forms or their previous incorrect results. Workbook/Worksheet models, persisted snapshots, and mutation formats require no migration.
-
-## Worker usage
+### Worker usage
On the main thread, import `UniverFormulaEnginePlugin` from `@univerjs/engine-formula`. Set `notExecuteFormula: true` to delegate calculation to the worker.
@@ -104,6 +42,12 @@ import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula/worker';
univer.registerPlugin(UniverFormulaEnginePlugin, { notExecuteFormula: false });
```
+## Integration Notes
+
+- Load the locale resources from `@univerjs/engine-formula/locale/<language>` for each language enabled by your application.
+- Import `@univerjs/engine-formula/facade` when using this package through Univer Facade APIs.
+- Custom calculation engines must await `FormulaResultService` before emitting completion. Subclasses of `CalculateFormulaService` must pass this service to the base constructor.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/engine-render/README.md b/packages/engine-render/README.md
index 768d461bc2..102f3c3681 100644
--- a/packages/engine-render/README.md
+++ b/packages/engine-render/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/engine-render` | `UniverEngineRender` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/engine-render` | `UniverEngineRender` | No | No | No | Yes |
## Installation
@@ -20,17 +20,17 @@ pnpm add @univerjs/engine-render
npm install @univerjs/engine-render
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverRenderEnginePlugin } from '@univerjs/engine-render';
univer.registerPlugin(UniverRenderEnginePlugin);
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverRenderEnginePlugin` from `@univerjs/engine-render`.
diff --git a/packages/find-replace/README.md b/packages/find-replace/README.md
index 7f85f7b3cc..a40b91bf59 100644
--- a/packages/find-replace/README.md
+++ b/packages/find-replace/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/find-replace` | `UniverFindReplace` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/find-replace` | `UniverFindReplace` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/find-replace
npm install @univerjs/find-replace
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/find-replace/lib/index.css';
import EnUS from '@univerjs/find-replace/locale/en-US';
diff --git a/packages/network/README.md b/packages/network/README.md
index fc17364790..df04022a72 100644
--- a/packages/network/README.md
+++ b/packages/network/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/network` | `UniverNetwork` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/network` | `UniverNetwork` | No | No | Yes | No |
## Installation
@@ -20,16 +20,20 @@ pnpm add @univerjs/network
npm install @univerjs/network
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverNetworkPlugin } from '@univerjs/network';
univer.registerPlugin(UniverNetworkPlugin);
```
+## Integration Notes
+
+- Import `@univerjs/network/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/protocol/README.md b/packages/protocol/README.md
index b328a451bd..4b32fc9009 100644
--- a/packages/protocol/README.md
+++ b/packages/protocol/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/protocol` | `UniverProtocol` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/protocol` | `UniverProtocol` | No | No | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/protocol
npm install @univerjs/protocol
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/packages/rpc-node/README.md b/packages/rpc-node/README.md
index f31038cb8e..c1266da578 100644
--- a/packages/rpc-node/README.md
+++ b/packages/rpc-node/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/rpc-node` | `UniverRpcNode` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/rpc-node` | `UniverRpcNode` | No | No | No | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/rpc-node
npm install @univerjs/rpc-node
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { fileURLToPath } from 'node:url';
import { UniverRPCNodeMainPlugin } from '@univerjs/rpc-node';
@@ -36,7 +36,7 @@ Main-thread plugin classes:
- `UniverRPCNodeMainPlugin`
-## Worker usage
+### Worker usage
On the main thread, import `UniverRPCNodeMainPlugin` from `@univerjs/rpc-node`. Set `workerSrc` to the worker module path.
diff --git a/packages/rpc/README.md b/packages/rpc/README.md
index 0d2828456a..b049eb991d 100644
--- a/packages/rpc/README.md
+++ b/packages/rpc/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/rpc` | `UniverRpc` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/rpc` | `UniverRpc` | No | No | No | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/rpc
npm install @univerjs/rpc
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverRPCMainThreadPlugin } from '@univerjs/rpc';
@@ -36,7 +36,7 @@ Main-thread plugin classes:
- `UniverRPCMainThreadPlugin`
-## Worker usage
+### Worker usage
On the main thread, import `UniverRPCMainThreadPlugin` from `@univerjs/rpc`. Set `workerURL` to the worker URL or instance.
diff --git a/packages/sheets-conditional-formatting-ui/README.md b/packages/sheets-conditional-formatting-ui/README.md
index 4b15533916..e0ed224987 100644
--- a/packages/sheets-conditional-formatting-ui/README.md
+++ b/packages/sheets-conditional-formatting-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-conditional-formatting-ui` | `UniverSheetsConditionalFormattingUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-conditional-formatting-ui` | `UniverSheetsConditionalFormattingUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-conditional-formatting-ui
npm install @univerjs/sheets-conditional-formatting-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-conditional-formatting-ui/lib/index.css';
import EnUS from '@univerjs/sheets-conditional-formatting-ui/locale/en-US';
diff --git a/packages/sheets-conditional-formatting/README.md b/packages/sheets-conditional-formatting/README.md
index 5202d70ecd..2aa7dc3d8b 100644
--- a/packages/sheets-conditional-formatting/README.md
+++ b/packages/sheets-conditional-formatting/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-conditional-formatting` | `UniverSheetsConditionalFormatting` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-conditional-formatting` | `UniverSheetsConditionalFormatting` | No | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-conditional-formatting
npm install @univerjs/sheets-conditional-formatting
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';
@@ -42,6 +42,7 @@ univer.registerPlugin(UniverSheetsConditionalFormattingPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-conditional-formatting-ui` when users need menus and rule-management panels.
+- Import `@univerjs/sheets-conditional-formatting/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-crosshair-highlight/README.md b/packages/sheets-crosshair-highlight/README.md
index 47a13ee4b5..f7a3d193f5 100644
--- a/packages/sheets-crosshair-highlight/README.md
+++ b/packages/sheets-crosshair-highlight/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-crosshair-highlight` | `UniverSheetsCrosshairHighlight` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-crosshair-highlight` | `UniverSheetsCrosshairHighlight` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-crosshair-highlight
npm install @univerjs/sheets-crosshair-highlight
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-crosshair-highlight/lib/index.css';
import EnUS from '@univerjs/sheets-crosshair-highlight/locale/en-US';
@@ -34,6 +34,10 @@ univer.registerPlugin(UniverSheetsCrosshairHighlightPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
+## Integration Notes
+
+- Import `@univerjs/sheets-crosshair-highlight/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/sheets-data-validation-ui/README.md b/packages/sheets-data-validation-ui/README.md
index 7e31a947c1..c57f99b05c 100644
--- a/packages/sheets-data-validation-ui/README.md
+++ b/packages/sheets-data-validation-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-data-validation-ui` | `UniverSheetsDataValidationUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-data-validation-ui` | `UniverSheetsDataValidationUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-data-validation-ui
npm install @univerjs/sheets-data-validation-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-data-validation-ui/lib/index.css';
import EnUS from '@univerjs/sheets-data-validation-ui/locale/en-US';
diff --git a/packages/sheets-data-validation/README.md b/packages/sheets-data-validation/README.md
index aeb53bc0f9..1a1ddd416f 100644
--- a/packages/sheets-data-validation/README.md
+++ b/packages/sheets-data-validation/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-data-validation` | `UniverSheetsDataValidation` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-data-validation` | `UniverSheetsDataValidation` | No | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-data-validation
npm install @univerjs/sheets-data-validation
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsDataValidationPlugin } from '@univerjs/sheets-data-validation';
@@ -42,6 +42,7 @@ univer.registerPlugin(UniverSheetsDataValidationPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-data-validation-ui` when users need validation dialogs, dropdowns, and error UI.
+- Import `@univerjs/sheets-data-validation/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-drawing-ui/README.md b/packages/sheets-drawing-ui/README.md
index 5c37f1ecb8..c540b90202 100644
--- a/packages/sheets-drawing-ui/README.md
+++ b/packages/sheets-drawing-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-drawing-ui` | `UniverSheetsDrawingUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-drawing-ui` | `UniverSheetsDrawingUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-drawing-ui
npm install @univerjs/sheets-drawing-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-drawing-ui/lib/index.css';
import EnUS from '@univerjs/sheets-drawing-ui/locale/en-US';
@@ -34,6 +34,10 @@ univer.registerPlugin(UniverSheetsDrawingUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
+## Integration Notes
+
+- Import `@univerjs/sheets-drawing-ui/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/sheets-drawing/README.md b/packages/sheets-drawing/README.md
index f88665ca0a..f8be3453ba 100644
--- a/packages/sheets-drawing/README.md
+++ b/packages/sheets-drawing/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-drawing` | `UniverSheetsDrawing` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-drawing` | `UniverSheetsDrawing` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-drawing
npm install @univerjs/sheets-drawing
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsDrawingPlugin } from '@univerjs/sheets-drawing';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsDrawingPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-drawing-ui` when users need drawing interactions in the sheet UI.
+- Import `@univerjs/sheets-drawing/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-filter-ui/README.md b/packages/sheets-filter-ui/README.md
index 54e54e8833..bacfbce450 100644
--- a/packages/sheets-filter-ui/README.md
+++ b/packages/sheets-filter-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-filter-ui` | `UniverSheetsFilterUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-filter-ui` | `UniverSheetsFilterUi` | Yes | Yes | No | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-filter-ui
npm install @univerjs/sheets-filter-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-filter-ui/lib/index.css';
import EnUS from '@univerjs/sheets-filter-ui/locale/en-US';
@@ -39,7 +39,7 @@ Main-thread plugin classes:
- `UniverSheetsFilterUIPlugin`
- `UniverSheetsFilterMobileUIPlugin`
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsFilterUIPlugin` from `@univerjs/sheets-filter-ui`.
diff --git a/packages/sheets-filter/README.md b/packages/sheets-filter/README.md
index 11da96ee93..8c77bb16e1 100644
--- a/packages/sheets-filter/README.md
+++ b/packages/sheets-filter/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-filter` | `UniverSheetsFilter` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-filter` | `UniverSheetsFilter` | No | Yes | Yes | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-filter
npm install @univerjs/sheets-filter
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter';
@@ -39,7 +39,7 @@ const univer = new Univer({
univer.registerPlugin(UniverSheetsFilterPlugin);
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsFilterPlugin` from `@univerjs/sheets-filter`.
@@ -54,6 +54,7 @@ univer.registerPlugin(UniverSheetsFilterPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-filter-ui` when users need filter menus and panels.
+- Import `@univerjs/sheets-filter/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-find-replace/README.md b/packages/sheets-find-replace/README.md
index bdb9420a98..0ba573ebe3 100644
--- a/packages/sheets-find-replace/README.md
+++ b/packages/sheets-find-replace/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-find-replace` | `UniverSheetsFindReplace` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-find-replace` | `UniverSheetsFindReplace` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-find-replace
npm install @univerjs/sheets-find-replace
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsFindReplacePlugin } from '@univerjs/sheets-find-replace';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsFindReplacePlugin);
## Integration Notes
Use this package with `@univerjs/find-replace` to share find and replace infrastructure across Univer surfaces.
+- Import `@univerjs/sheets-find-replace/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-formula-ui/README.md b/packages/sheets-formula-ui/README.md
index b4965be88f..39a0fecbbf 100644
--- a/packages/sheets-formula-ui/README.md
+++ b/packages/sheets-formula-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-formula-ui` | `UniverSheetsFormulaUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-formula-ui` | `UniverSheetsFormulaUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-formula-ui
npm install @univerjs/sheets-formula-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-formula-ui/lib/index.css';
import EnUS from '@univerjs/sheets-formula-ui/locale/en-US';
@@ -34,6 +34,10 @@ univer.registerPlugin(UniverSheetsFormulaUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
+## Integration Notes
+
+- Import `@univerjs/sheets-formula-ui/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/sheets-formula/README.md b/packages/sheets-formula/README.md
index bdd45b8a07..37ba0cb88a 100644
--- a/packages/sheets-formula/README.md
+++ b/packages/sheets-formula/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-formula` | `UniverSheetsFormula` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-formula` | `UniverSheetsFormula` | No | Yes | Yes | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-formula
npm install @univerjs/sheets-formula
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import EnUS from '@univerjs/sheets-formula/locale/en-US';
import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula';
@@ -37,7 +37,7 @@ Main-thread plugin classes:
- `UniverSheetsFormulaPlugin`
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsFormulaPlugin` from `@univerjs/sheets-formula`. Set `notExecuteFormula: true` to delegate calculation to the worker.
@@ -52,6 +52,7 @@ univer.registerPlugin(UniverRemoteSheetsFormulaPlugin);
## Integration Notes
Register this package with `@univerjs/engine-formula` and `@univerjs/sheets` before adding formula UI packages.
+- Import `@univerjs/sheets-formula/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-hyper-link-ui/README.md b/packages/sheets-hyper-link-ui/README.md
index 8daedf7346..422390808c 100644
--- a/packages/sheets-hyper-link-ui/README.md
+++ b/packages/sheets-hyper-link-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-hyper-link-ui` | `UniverSheetsHyperLinkUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-hyper-link-ui` | `UniverSheetsHyperLinkUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-hyper-link-ui
npm install @univerjs/sheets-hyper-link-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-hyper-link-ui/lib/index.css';
import EnUS from '@univerjs/sheets-hyper-link-ui/locale/en-US';
@@ -34,6 +34,10 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
+## Integration Notes
+
+- Import `@univerjs/sheets-hyper-link-ui/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/sheets-hyper-link/README.md b/packages/sheets-hyper-link/README.md
index 04b72071e7..9658564d54 100644
--- a/packages/sheets-hyper-link/README.md
+++ b/packages/sheets-hyper-link/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-hyper-link` | `UniverSheetsHyperLink` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-hyper-link` | `UniverSheetsHyperLink` | No | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-hyper-link
npm install @univerjs/sheets-hyper-link
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsHyperLinkPlugin } from '@univerjs/sheets-hyper-link';
@@ -42,6 +42,7 @@ univer.registerPlugin(UniverSheetsHyperLinkPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-hyper-link-ui` when users need hyperlink editing UI.
+- Import `@univerjs/sheets-hyper-link/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-note-ui/README.md b/packages/sheets-note-ui/README.md
index aeedadef7c..f1fcf1c975 100644
--- a/packages/sheets-note-ui/README.md
+++ b/packages/sheets-note-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-note-ui` | `UniverSheetsNoteUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-note-ui` | `UniverSheetsNoteUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-note-ui
npm install @univerjs/sheets-note-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-note-ui/lib/index.css';
import EnUS from '@univerjs/sheets-note-ui/locale/en-US';
diff --git a/packages/sheets-note/README.md b/packages/sheets-note/README.md
index ae3e6d11c3..74b5ed62f4 100644
--- a/packages/sheets-note/README.md
+++ b/packages/sheets-note/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-note` | `UniverSheetsNote` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-note` | `UniverSheetsNote` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-note
npm install @univerjs/sheets-note
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsNotePlugin } from '@univerjs/sheets-note';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsNotePlugin);
## Integration Notes
Use this package with `@univerjs/sheets-note-ui` when users need note editing UI.
+- Import `@univerjs/sheets-note/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-numfmt-ui/README.md b/packages/sheets-numfmt-ui/README.md
index afe45e4b36..7a0bf674ea 100644
--- a/packages/sheets-numfmt-ui/README.md
+++ b/packages/sheets-numfmt-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-numfmt-ui` | `UniverSheetsNumfmtUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-numfmt-ui` | `UniverSheetsNumfmtUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-numfmt-ui
npm install @univerjs/sheets-numfmt-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-numfmt-ui/lib/index.css';
import EnUS from '@univerjs/sheets-numfmt-ui/locale/en-US';
diff --git a/packages/sheets-numfmt/README.md b/packages/sheets-numfmt/README.md
index 269e52996e..77ace14e60 100644
--- a/packages/sheets-numfmt/README.md
+++ b/packages/sheets-numfmt/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-numfmt` | `UniverSheetsNumfmt` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-numfmt` | `UniverSheetsNumfmt` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-numfmt
npm install @univerjs/sheets-numfmt
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsNumfmtPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-numfmt-ui` when users need number-format menus and editors.
+- Import `@univerjs/sheets-numfmt/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-sort-ui/README.md b/packages/sheets-sort-ui/README.md
index 8a408a5b63..caa41a88fb 100644
--- a/packages/sheets-sort-ui/README.md
+++ b/packages/sheets-sort-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-sort-ui` | `UniverSheetsSortUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-sort-ui` | `UniverSheetsSortUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-sort-ui
npm install @univerjs/sheets-sort-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-sort-ui/lib/index.css';
import EnUS from '@univerjs/sheets-sort-ui/locale/en-US';
diff --git a/packages/sheets-sort/README.md b/packages/sheets-sort/README.md
index f1748bbffc..2e07fb0150 100644
--- a/packages/sheets-sort/README.md
+++ b/packages/sheets-sort/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-sort` | `UniverSheetsSort` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-sort` | `UniverSheetsSort` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-sort
npm install @univerjs/sheets-sort
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsSortPlugin } from '@univerjs/sheets-sort';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsSortPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-sort-ui` when users need sorting menus and panels.
+- Import `@univerjs/sheets-sort/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-table-ui/README.md b/packages/sheets-table-ui/README.md
index a22e5d581f..aef6942185 100644
--- a/packages/sheets-table-ui/README.md
+++ b/packages/sheets-table-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-table-ui` | `UniverSheetsTableUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-table-ui` | `UniverSheetsTableUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-table-ui
npm install @univerjs/sheets-table-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-table-ui/lib/index.css';
import EnUS from '@univerjs/sheets-table-ui/locale/en-US';
diff --git a/packages/sheets-table/README.md b/packages/sheets-table/README.md
index 1c99834fdd..3e265cd9b0 100644
--- a/packages/sheets-table/README.md
+++ b/packages/sheets-table/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-table` | `UniverSheetsTable` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-table` | `UniverSheetsTable` | No | Yes | Yes | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-table
npm install @univerjs/sheets-table
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsTablePlugin } from '@univerjs/sheets-table';
@@ -39,7 +39,7 @@ const univer = new Univer({
univer.registerPlugin(UniverSheetsTablePlugin);
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsTablePlugin` from `@univerjs/sheets-table`.
@@ -54,32 +54,10 @@ univer.registerPlugin(UniverSheetsTablePlugin);
## Integration Notes
Use this package with `@univerjs/sheets-table-ui` when users need table controls in the sheet UI.
+- Import `@univerjs/sheets-table/facade` when using this package through Univer Facade APIs.
## Resources
- [Documentation](https://docs.univer.ai)
- [NPM package](https://npmjs.com/package/@univerjs/sheets-table)
- [GitHub repository](https://github.com/dream-num/univer)
-
-## Table differential formats
-
-Imported XLSX table themes and direct differential formats are separate. Table themes remain in the existing range-theme resource; direct formats remain in Table and TableColumn metadata. This support requires the matching Sheets and Sheets Numfmt implementations and a matching Office native importer/exporter. No new resource version field, column `style` mapping, Facade method or style editor is introduced.
-
-| Location | Format keys |
-| --- | --- |
-| `table.meta._xlsx.options` | `dataDxfStyle`, `headerRowDxfStyle`, `totalsRowDxfStyle`, `tableBorderDxfStyle`, `headerRowBorderDxfStyle`, `totalsRowBorderDxfStyle` |
-| `column.meta._xlsx` | `dataDxfStyle`, `headerRowDxfStyle`, `totalsRowDxfStyle` |
-
-Each format contains supported `IStyleData` properties. Fields beginning with an underscore preserve exchange information and are not rendered. The runtime applies the matching table region, then the matching column region by property, on top of the table theme. Explicit cell formats retain precedence; existing conditional-format processing remains separate. Border attributes are projected onto the current region boundary. Inside-horizontal and inside-vertical OOXML borders are not represented by the current frontend border model.
-
-The Sheets package exports its existing `RangeThemeInterceptorId`; table direct formats use the same identifier so reads that explicitly exclude inherited range formatting also exclude these formats. `InterceptCellContentPriority.TABLE_STYLE` places the metadata resolver before number formatting.
-
-Sheets Table writes matching direct formats to the existing runtime `themeStyle`; the theme and number-format interceptors consume that value according to their existing interceptor order without adding JSON or snapshot fields. Without a matching dxf, theme assignment and number-format lookup retain their previous behavior. The dxf number-format fallback is enabled only when the current high-priority Table interceptor has supplied `themeStyle.n`.
-
-Formats follow the current table range and column identities, including inserted rows and table moves. For tables with dxf metadata, table and column metadata are retained when copying worksheets and undoing table deletion, and column shifts preserve column objects. Tables without dxf continue to use their original structural and restoration paths. An imported table that has direct formats but originally no theme does not receive the default table theme. Ordinary default-theme behavior for other tables is unchanged. Direct formats are import-only: no UI, Facade setter or dedicated editing command is provided.
-
-For internal creation and restoration, `AddSheetTableMutation` accepts optional `meta`; `TableManager.addTable` and `SheetTableService.addTable` accept the same metadata as an optional final argument. Metadata is installed before the table-added event. Existing calls remain valid and do not add empty table metadata when the argument is omitted. The manager restores supplied column metadata only for tables with dxf; ordinary column initialization retains its previous behavior.
-
-The matching exporter treats an existing metadata container as authoritative: deleting a dxf key clears that direct format instead of reviving a stale native field or raw XML attribute. If the container is absent, legacy native fields remain readable. Raw dxf XML matching the current supported properties is retained; edits use the supported encoder and may lose unsupported extensions. These export consistency rules do not expose frontend dxf editing; mutating a metadata object directly is not a supported undoable formatting operation.
-
-New importers no longer materialize direct table formats into cell styles or use the old empty `rust-direct-dxf-*` theme. Older runtimes do not dynamically consume the new import result even if they save its metadata. Older bindings do not guarantee the new metadata edit/clear semantics. Upgrade the runtime and native exchange components together. Historical materialized snapshots are not automatically rewritten; re-import the original XLSX when possible. Published package combinations and Excel rendering require separate consumer validation.
diff --git a/packages/sheets-thread-comment-ui/README.md b/packages/sheets-thread-comment-ui/README.md
index 32bac0f209..2b2d7dbf80 100644
--- a/packages/sheets-thread-comment-ui/README.md
+++ b/packages/sheets-thread-comment-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-thread-comment-ui` | `UniverSheetsThreadCommentUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-thread-comment-ui` | `UniverSheetsThreadCommentUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-thread-comment-ui @univerjs/thread-comment-ui
npm install @univerjs/sheets-thread-comment-ui @univerjs/thread-comment-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsThreadCommentUIPlugin } from '@univerjs/sheets-thread-comment-ui';
diff --git a/packages/sheets-thread-comment/README.md b/packages/sheets-thread-comment/README.md
index d2ddc33a71..779dc00f51 100644
--- a/packages/sheets-thread-comment/README.md
+++ b/packages/sheets-thread-comment/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-thread-comment` | `UniverSheetsThreadComment` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-thread-comment` | `UniverSheetsThreadComment` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-thread-comment
npm install @univerjs/sheets-thread-comment
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverSheetsThreadCommentPlugin } from '@univerjs/sheets-thread-comment';
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsThreadCommentPlugin);
## Integration Notes
Use this package with `@univerjs/sheets-thread-comment-ui` when users need comment UI in sheets.
+- Import `@univerjs/sheets-thread-comment/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/sheets-ui/README.md b/packages/sheets-ui/README.md
index ca7c5e7771..424f87e433 100644
--- a/packages/sheets-ui/README.md
+++ b/packages/sheets-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets-ui` | `UniverSheetsUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets-ui` | `UniverSheetsUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-ui
npm install @univerjs/sheets-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/sheets-ui/lib/index.css';
import EnUS from '@univerjs/sheets-ui/locale/en-US';
@@ -39,6 +39,10 @@ Exported plugin classes:
- `UniverSheetsUIPlugin`
- `UniverSheetsMobileUIPlugin`
+## Integration Notes
+
+- Import `@univerjs/sheets-ui/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/sheets/README.md b/packages/sheets/README.md
index f58c0634ad..5e3d697542 100644
--- a/packages/sheets/README.md
+++ b/packages/sheets/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/sheets` | `UniverSheets` | No | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/sheets` | `UniverSheets` | No | Yes | Yes | Yes |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets
npm install @univerjs/sheets
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import EnUS from '@univerjs/sheets/locale/en-US';
import { UniverSheetsPlugin } from '@univerjs/sheets';
@@ -33,7 +33,7 @@ univer.registerPlugin(UniverSheetsPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsPlugin` from `@univerjs/sheets`. Set `notExecuteFormula: true` to delegate calculation to the worker.
@@ -45,6 +45,10 @@ import { UniverSheetsPlugin } from '@univerjs/sheets/worker';
univer.registerPlugin(UniverSheetsPlugin, { onlyRegisterFormulaRelatedMutations: true });
```
+## Integration Notes
+
+- Import `@univerjs/sheets/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/packages/telemetry/README.md b/packages/telemetry/README.md
index 9c63a4d55b..4472f3e180 100644
--- a/packages/telemetry/README.md
+++ b/packages/telemetry/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/telemetry` | `UniverTelemetry` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/telemetry` | `UniverTelemetry` | No | No | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/telemetry
npm install @univerjs/telemetry
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/packages/themes/README.md b/packages/themes/README.md
index 6bb75b75c2..a50d54cfdf 100644
--- a/packages/themes/README.md
+++ b/packages/themes/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/themes` | `UniverThemes` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/themes` | `UniverThemes` | No | No | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/themes
npm install @univerjs/themes
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/packages/thread-comment-ui/README.md b/packages/thread-comment-ui/README.md
index fb9f85db07..570b220ba0 100644
--- a/packages/thread-comment-ui/README.md
+++ b/packages/thread-comment-ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/thread-comment-ui` | `UniverThreadCommentUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/thread-comment-ui` | `UniverThreadCommentUi` | Yes | Yes | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/thread-comment-ui
npm install @univerjs/thread-comment-ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/thread-comment-ui/lib/index.css';
import EnUS from '@univerjs/thread-comment-ui/locale/en-US';
diff --git a/packages/thread-comment/README.md b/packages/thread-comment/README.md
index 7af40136f1..3adad3d9a6 100644
--- a/packages/thread-comment/README.md
+++ b/packages/thread-comment/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/thread-comment` | `UniverThreadComment` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/thread-comment` | `UniverThreadComment` | No | No | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/thread-comment
npm install @univerjs/thread-comment
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverThreadCommentPlugin } from '@univerjs/thread-comment';
import '@univerjs/thread-comment/facade';
diff --git a/packages/ui-adapter-vue3/README.md b/packages/ui-adapter-vue3/README.md
index 97cfb4d22b..a05bc6ae92 100644
--- a/packages/ui-adapter-vue3/README.md
+++ b/packages/ui-adapter-vue3/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/ui-adapter-vue3` | `UniverUiAdapterVue3` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/ui-adapter-vue3` | `UniverUiAdapterVue3` | No | No | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/ui-adapter-vue3
npm install @univerjs/ui-adapter-vue3
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverVue3AdapterPlugin } from '@univerjs/ui-adapter-vue3';
diff --git a/packages/ui-adapter-web-component/README.md b/packages/ui-adapter-web-component/README.md
index df369f039c..02c9edbf8a 100644
--- a/packages/ui-adapter-web-component/README.md
+++ b/packages/ui-adapter-web-component/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/ui-adapter-web-component` | `UniverUiAdapterWebComponent` | No | No | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/ui-adapter-web-component` | `UniverUiAdapterWebComponent` | No | No | No | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/ui-adapter-web-component
npm install @univerjs/ui-adapter-web-component
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverWebComponentAdapterPlugin } from '@univerjs/ui-adapter-web-component';
diff --git a/packages/ui/README.md b/packages/ui/README.md
index 035b55c5d8..59fbbf3ae5 100644
--- a/packages/ui/README.md
+++ b/packages/ui/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/ui` | `UniverUi` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/ui` | `UniverUi` | Yes | Yes | Yes | No |
## Installation
@@ -20,10 +20,10 @@ pnpm add @univerjs/ui
npm install @univerjs/ui
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import '@univerjs/ui/lib/index.css';
import EnUS from '@univerjs/ui/locale/en-US';
@@ -39,21 +39,9 @@ Exported plugin classes:
- `UniverUIPlugin`
- `UniverMobileUIPlugin`
-## Format painter
-
-The desktop Start ribbon has one format painter entry. A single click captures a detached
-format snapshot for one application; a double click keeps it active until Escape or another
-click on the entry. Unsupported targets do not consume the snapshot. The canvas displays a
-brush cursor on supported targets and an unavailable cursor elsewhere.
-
-`FormatPainterSessionService` coordinates the local session. Host adapters claim the active
-editing context and apply formatting through their domain commands. A higher-priority shape
-selection prevents a stale cell selection from becoming the source. Changing the focused
-Unit or disposing the source Unit cancels the session. The session itself is not persisted.
+## Integration Notes
-The icon-only clear-formatting button below the format painter resets the active domain's
-formatting without removing content. Clearing cancels an active brush; each domain applies
-the change through its undoable commands.
+- Import `@univerjs/ui/facade` when using this package through Univer Facade APIs.
## Resources
diff --git a/packages/watermark/README.md b/packages/watermark/README.md
index 2ba4f448a3..54822edcef 100644
--- a/packages/watermark/README.md
+++ b/packages/watermark/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs/watermark` | `UniverWatermark` | No | No | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/watermark` | `UniverWatermark` | No | No | Yes | No |
## Installation
@@ -20,16 +20,20 @@ pnpm add @univerjs/watermark
npm install @univerjs/watermark
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
```ts
import { UniverWatermarkPlugin } from '@univerjs/watermark';
univer.registerPlugin(UniverWatermarkPlugin);
```
+## Integration Notes
+
+- Import `@univerjs/watermark/facade` when using this package through Univer Facade APIs.
+
## Resources
- [Documentation](https://docs.univer.ai)
diff --git a/presets/README.md b/presets/README.md
new file mode 100644
index 0000000000..280fc0e549
--- /dev/null
+++ b/presets/README.md
@@ -0,0 +1,52 @@
+# @univerjs/presets
+
+[![npm version](https://img.shields.io/npm/v/@univerjs/presets?style=flat-square)](https://npmjs.com/package/@univerjs/presets)
+[![license](https://img.shields.io/npm/l/@univerjs/presets?style=flat-square)](https://npmjs.com/package/@univerjs/presets)
+[![downloads](https://img.shields.io/npm/dm/@univerjs/presets?style=flat-square)](https://npmjs.com/package/@univerjs/presets)
+
+`@univerjs/presets` provides `createUniver` to compose plugin presets and return a Univer instance with its Facade API.
+
+## Package Overview
+
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/presets` | — | No | No | No | No |
+
+## Installation
+
+```sh
+pnpm add @univerjs/presets
+# or
+npm install @univerjs/presets
+```
+
+## Usage
+
+Install `@univerjs/preset-sheets-core` for this example and provide an HTML element with the ID `app`.
+
+```ts
+import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core';
+import SheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US';
+import { createUniver, LocaleType } from '@univerjs/presets';
+import '@univerjs/preset-sheets-core/lib/index.css';
+
+const { univerAPI } = createUniver({
+ locale: LocaleType.EN_US,
+ locales: { [LocaleType.EN_US]: SheetsCoreEnUS },
+ presets: [UniverSheetsCorePreset({ container: 'app' })],
+});
+
+univerAPI.createWorkbook({ name: 'Workbook' });
+```
+
+## Integration Notes
+
+- Install the presets needed by your document type and merge their locale resources for each enabled language.
+- Import styles from the selected presets. This composition package has no stylesheet or independent Facade/Worker subpath.
+- Register each plugin through either a preset or the `plugins` option; do not register the same plugin through both.
+
+## Resources
+
+- [Documentation](https://docs.univer.ai/guides/sheets/getting-started/installation)
+- [NPM package](https://npmjs.com/package/@univerjs/presets)
+- [GitHub repository](https://github.com/dream-num/univer)
diff --git a/presets/packages/preset-docs-core/README.md b/presets/packages/preset-docs-core/README.md
index 337a737865..400d7e6095 100644
--- a/presets/packages/preset-docs-core/README.md
+++ b/presets/packages/preset-docs-core/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ---------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-docs-core` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-docs-core` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-docs-core
npm install @univerjs/preset-docs-core
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-docs-drawing/README.md b/presets/packages/preset-docs-drawing/README.md
index fcaf57f579..f6edd38095 100644
--- a/presets/packages/preset-docs-drawing/README.md
+++ b/presets/packages/preset-docs-drawing/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-docs-drawing` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-docs-drawing` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-docs-drawing
npm install @univerjs/preset-docs-drawing
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-docs-hyper-link/README.md b/presets/packages/preset-docs-hyper-link/README.md
index 5a1e537d35..14c1a8dc44 100644
--- a/presets/packages/preset-docs-hyper-link/README.md
+++ b/presets/packages/preset-docs-hyper-link/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ---------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-docs-hyper-link` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-docs-hyper-link` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-docs-hyper-link
npm install @univerjs/preset-docs-hyper-link
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-docs-thread-comment/README.md b/presets/packages/preset-docs-thread-comment/README.md
index a07acfe9ac..a20a28fd73 100644
--- a/presets/packages/preset-docs-thread-comment/README.md
+++ b/presets/packages/preset-docs-thread-comment/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| -------------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-docs-thread-comment` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-docs-thread-comment` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-docs-thread-comment
npm install @univerjs/preset-docs-thread-comment
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-conditional-formatting/README.md b/presets/packages/preset-sheets-conditional-formatting/README.md
index 25247cc631..6de608f0d8 100644
--- a/presets/packages/preset-sheets-conditional-formatting/README.md
+++ b/presets/packages/preset-sheets-conditional-formatting/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------------------------ | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-conditional-formatting` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-conditional-formatting` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-conditional-formatting
npm install @univerjs/preset-sheets-conditional-formatting
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-core/README.md b/presets/packages/preset-sheets-core/README.md
index 394d8e1a5b..9443a65123 100644
--- a/presets/packages/preset-sheets-core/README.md
+++ b/presets/packages/preset-sheets-core/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------ | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-core` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-core` | — | Yes | Yes | No | Yes |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-core
npm install @univerjs/preset-sheets-core
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
@@ -31,7 +29,7 @@ import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core';
// createUniver({ presets: [UniverSheetsCorePreset()] });
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsCorePreset` from `@univerjs/preset-sheets-core`. Set `workerURL` to the worker URL or instance.
diff --git a/presets/packages/preset-sheets-data-validation/README.md b/presets/packages/preset-sheets-data-validation/README.md
index a1df45400c..7e83eac786 100644
--- a/presets/packages/preset-sheets-data-validation/README.md
+++ b/presets/packages/preset-sheets-data-validation/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ----------------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-data-validation` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-data-validation` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-data-validation
npm install @univerjs/preset-sheets-data-validation
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-drawing/README.md b/presets/packages/preset-sheets-drawing/README.md
index 25361a0982..566d5a4fa1 100644
--- a/presets/packages/preset-sheets-drawing/README.md
+++ b/presets/packages/preset-sheets-drawing/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| --------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-drawing` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-drawing` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-drawing
npm install @univerjs/preset-sheets-drawing
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-filter/README.md b/presets/packages/preset-sheets-filter/README.md
index 6224ddc48b..0e9f92f779 100644
--- a/presets/packages/preset-sheets-filter/README.md
+++ b/presets/packages/preset-sheets-filter/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| -------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-filter` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-filter` | — | Yes | Yes | No | Yes |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-filter
npm install @univerjs/preset-sheets-filter
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
@@ -31,7 +29,7 @@ import { UniverSheetsFilterPreset } from '@univerjs/preset-sheets-filter';
// createUniver({ presets: [UniverSheetsFilterPreset()] });
```
-## Worker usage
+### Worker usage
On the main thread, import `UniverSheetsFilterPreset` from `@univerjs/preset-sheets-filter`. Configure `workerURL` on `UniverSheetsCorePreset`.
diff --git a/presets/packages/preset-sheets-find-replace/README.md b/presets/packages/preset-sheets-find-replace/README.md
index 66b6b1537a..210ad88893 100644
--- a/presets/packages/preset-sheets-find-replace/README.md
+++ b/presets/packages/preset-sheets-find-replace/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| -------------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-find-replace` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-find-replace` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-find-replace
npm install @univerjs/preset-sheets-find-replace
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-hyper-link/README.md b/presets/packages/preset-sheets-hyper-link/README.md
index dde625f285..85e54369f1 100644
--- a/presets/packages/preset-sheets-hyper-link/README.md
+++ b/presets/packages/preset-sheets-hyper-link/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------------ | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-hyper-link` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-hyper-link` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-hyper-link
npm install @univerjs/preset-sheets-hyper-link
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-note/README.md b/presets/packages/preset-sheets-note/README.md
index a0fdd3076d..e228ec5a33 100644
--- a/presets/packages/preset-sheets-note/README.md
+++ b/presets/packages/preset-sheets-note/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------ | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-note` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-note` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-note
npm install @univerjs/preset-sheets-note
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-sort/README.md b/presets/packages/preset-sheets-sort/README.md
index 547e35bd2e..f2ad5ca601 100644
--- a/presets/packages/preset-sheets-sort/README.md
+++ b/presets/packages/preset-sheets-sort/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------ | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-sort` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-sort` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-sort
npm install @univerjs/preset-sheets-sort
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-table/README.md b/presets/packages/preset-sheets-table/README.md
index eafa3adcf3..1bae0455fd 100644
--- a/presets/packages/preset-sheets-table/README.md
+++ b/presets/packages/preset-sheets-table/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-table` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-table` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-table
npm install @univerjs/preset-sheets-table
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts
diff --git a/presets/packages/preset-sheets-thread-comment/README.md b/presets/packages/preset-sheets-thread-comment/README.md
index aa0e98ce39..9beeb23efc 100644
--- a/presets/packages/preset-sheets-thread-comment/README.md
+++ b/presets/packages/preset-sheets-thread-comment/README.md
@@ -8,9 +8,9 @@
## Package Overview
-| Package | CSS | Locales | Facade entry |
-| ---------------------------------------- | :-: | :-----: | :----------: |
-| `@univerjs/preset-sheets-thread-comment` | Yes | Yes | Yes |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs/preset-sheets-thread-comment` | — | Yes | Yes | No | No |
## Installation
@@ -20,8 +20,6 @@ pnpm add @univerjs/preset-sheets-thread-comment
npm install @univerjs/preset-sheets-thread-comment
```
-Keep all `@univerjs/*` packages on the same version.
-
## Usage
```ts