@univerjs/engine-render 0.21.1 → 0.22.0-insiders.20260513-0b53885

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +25 -18
  2. package/lib/cjs/index.js +755 -939
  3. package/lib/es/index.js +755 -939
  4. package/lib/umd/index.js +2 -3
  5. package/package.json +14 -10
  6. package/LICENSE +0 -176
package/README.md CHANGED
@@ -1,31 +1,38 @@
1
1
  # @univerjs/engine-render
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs/engine-render?style=flat-square)](https://npmjs.com/package/@univerjs/engine-render)
4
+ [![license](https://img.shields.io/npm/l/@univerjs/engine-render?style=flat-square)](https://npmjs.com/package/@univerjs/engine-render)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs/engine-render?style=flat-square)](https://npmjs.com/package/@univerjs/engine-render)
6
+
7
+ `@univerjs/engine-render` is Univer's canvas rendering engine. It handles document layout, rendering primitives, interaction layers, scrolling, and zooming.
8
+
3
9
  ## Package Overview
4
10
 
5
- | Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
6
- | --- | --- | --- | --- | --- | :---: | :---: |
7
- | `@univerjs/engine-render` | `UniverEngineRender` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ❌ | ❌ |
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | --- | --- | :---: | :---: | :---: |
13
+ | `@univerjs/engine-render` | `UniverEngineRender` | No | No | No |
8
14
 
9
- ## Introduction
15
+ ## Installation
10
16
 
11
- The `@univerjs/engine-render` provides the ability to render Univer documents on a canvas element, including the capability to draw graphical elements, handle cursor interactions, and process scrolling and zooming.
17
+ ```sh
18
+ pnpm add @univerjs/engine-render
19
+ # or
20
+ npm install @univerjs/engine-render
21
+ ```
12
22
 
13
- The rendering layer for various document types is extended based on the foundational infrastructure provided by `@univerjs/engine-render`.
23
+ Keep all `@univerjs/*` packages on the same version.
14
24
 
15
25
  ## Usage
16
26
 
17
- ### Installation
27
+ ```ts
28
+ import { UniverRenderEnginePlugin } from '@univerjs/engine-render';
18
29
 
19
- ```shell
20
- # Using npm
21
- npm install @univerjs/engine-render
22
-
23
- # Using pnpm
24
- pnpm add @univerjs/engine-render
30
+ univer.registerPlugin(UniverRenderEnginePlugin);
25
31
  ```
26
32
 
27
- <!-- Links -->
28
- [npm-version-shield]: https://img.shields.io/npm/v/@univerjs/engine-render?style=flat-square
29
- [npm-version-link]: https://npmjs.com/package/@univerjs/engine-render
30
- [npm-license-shield]: https://img.shields.io/npm/l/@univerjs/engine-render?style=flat-square
31
- [npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/engine-render?style=flat-square
33
+ ## Resources
34
+
35
+ - [Documentation](https://docs.univer.ai)
36
+ - [NPM package](https://npmjs.com/package/@univerjs/engine-render)
37
+ - [GitHub repository](https://github.com/dream-num/univer)
38
+