@eraserlabs/render

中文文档
0.5.2发布于 2026/11/12MITTypeScriptES Module构建来源已验证近 30 天下载 1.1万

In-browser fill, measure, layout, and apply implementation for the Eraser diagram protocol.

原始使用文档
文档目录4 节
  1. Introduction
  2. Why
  3. Usage
  4. Editor APIs

@eraserlabs/render

Introduction

@eraserlabs/render is the in-browser half of the rendering pipeline. Given resolved elements and a prepared template library, it fills markup, mounts and isolates each template's CSS, measures the boxes the browser actually produced, routes connections through @eraserlabs/layout, and applies the result as positioned nodes plus a scene-wide SVG overlay.

It runs in Chromium as a self-contained IIFE (@eraserlabs/render/browser/iife, exposed as window.__eraser), which is how @eraserlabs/diagrams drives it. The root export is node-safe scene types and buildHtmlDocument and depends on nothing browser-specific. Portable element, icon, template, role, and font contracts live in @eraserlabs/protocol.

Why

Authored width and height are intent, not paint. Text wrapping, padding, icons, and shadows change the boxes that routing and export must honor. Those measurements only exist after a real layout engine has run, so this package lives in the page rather than approximating CSS in Node.

Usage

Inject the IIFE into a page, then:

window.__eraser.setup({ templates, baseCss });
await window.__eraser.registerFonts({ css, faces });

const { measures, layout } = await window.__eraser.run({
  entities,
  connections,
  icons,
});

const { scene, css } = window.__eraser.serialize();

setup and registerFonts are page-lifetime. run is per request: fill, mount, measure, route, apply. serialize returns the positioned scene markup and the stylesheets this bundle owns, for the HTML output path.

Authored connection points are route-local { x, y } objects whose origin is the connection's x / y. The adapter converts them to the tuple geometry @eraserlabs/layout uses; output polylines remain scene-space tuples.

The page API and measure contract are specified in SPEC.md.

Editor APIs

@eraserlabs/render/elements renders resolved subsets without mounting, routing, or global setup:

import { createElementRenderer } from '@eraserlabs/render/elements';
import { buildRenderPageSetup } from '@eraserlabs/diagram-templates';

const renderer = createElementRenderer(buildRenderPageSetup(resolver.library));
const result = await resolver.resolve(
  { elements: selection },
  { partial: true },
);
if (!result.ok) throw new Error(JSON.stringify(result.errors));
const fragment = await renderer.render({
  entities: result.entities!,
  connections: result.connections!,
  icons: result.icons!,
});

Install renderer.css and mount fragment.defs alongside the HTML. Wrap each element in [data-mdp-tag="<tag>"]; the host owns positioning and cleanup. Resolved themes are applied automatically to template roots. Use applyLayout to apply existing geometry without routing.

The same entry exports measureElements(mounted, entities?) and measureText(root). Supply connected, untransformed DOM with the library CSS and registered fonts; display:none cannot be measured. These calls wait for fonts. With entities, measurement applies the full renderer's sizing policies and restores probe styles; without them it reads current layout. Text measurements contain range fragments and their union, not padded boxes or one rectangle per line.

@eraserlabs/render/fit exports synchronous measureElement(wrapper) and fitElement(wrapper, constraints). Fit policies are natural, fixed, content, and balanced; fitting leaves the probe at its proposed size. The host decides whether to persist that geometry.

prepareWashMasters(master, elements, { idPrefix }?) prepares watercolor definitions before low-level filling and mutates props.washSym. renderer.render(request, { idPrefix }?) handles cloning and preparation itself. Keep returned definitions mounted; an optional prefix must be unique among mounted fragments, using only letters, digits, underscores and hyphens. Automatic prefixes are isolated across bundles.

版本与发布记录

@eraserlabs/render 共发布 11 个版本,首次发布于 2026/08/19;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.2latest2026/11/122 天前
0.5.12026/11/059 天前
0.5.02026/11/0311 天前
0.4.32026/10/2816 天前
0.4.22026/10/2817 天前
0.4.12026/10/2817 天前

关于 @eraserlabs/render 的常见问题

@eraserlabs/render 是什么?

In-browser fill, measure, layout, and apply implementation for the Eraser diagram protocol.

如何安装 @eraserlabs/render?

在项目目录运行 npm install @eraserlabs/render,或使用 pnpm add / yarn add / bun add。

@eraserlabs/render 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@eraserlabs/render 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@eraserlabs/render 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^22.23.4 || ^24.22.1 || >=26.12.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@eraserlabs/render 可以商用吗?

@eraserlabs/render 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@eraserlabs/render 的下载量有多少?

根据 npm 官方下载统计,@eraserlabs/render 在 2026/10/14 – 2026/11/12 这 30 天内被下载 10,688 次,日均约 356 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@eraserlabs/render 还在维护吗?

最新版本 0.5.2 发布于 2026/11/12(2 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/08/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。