@univerjs/engine-render is Univer's canvas rendering engine. It handles document layout, rendering primitives, interaction layers, scrolling, and zooming.

pnpm add @univerjs/engine-render
# or
npm install @univerjs/engine-render

Start with the integration setup for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

import { UniverRenderEnginePlugin } from '@univerjs/engine-render';

univer.registerPlugin(UniverRenderEnginePlugin);

On the main thread, import UniverRenderEnginePlugin from @univerjs/engine-render.

In the worker entry, import DocumentLayoutSession from @univerjs/engine-render/worker:

import { DocumentLayoutSession } from '@univerjs/engine-render/worker';

DocumentLayoutSession is a layout utility, not a plugin. For Docs layout workers, use the Docs worker setup, which manages the session lifecycle.

• Documentation
• NPM package
• GitHub repository