Skip to main content

Installation

Requirements​

  • Node.js 20 or later
  • TypeScript 5.5+ (recommended)

Install Packages​

Choose the scenario that matches your app:

ScenarioMinimal install commandAdd these only if needed
React renderernpm install @esheet/renderer react react-dom@esheet/core for direct core imports/types; @esheet/fields for custom field component registry work
React builder + renderernpm install @esheet/builder @esheet/renderer react react-dom@esheet/core only for direct core APIs/types
Standalone renderernpm install @esheet/renderer-standalone@esheet/core only if importing core types/APIs directly in host app code
Blaze renderernpm install @esheet/renderer-blaze@esheet/core only if importing core types/APIs directly in host app code
info

@esheet/renderer and @esheet/builder include @esheet/core and @esheet/fields transitively — no need to install them separately unless your app imports them directly.

@esheet/renderer-standalone and @esheet/renderer-blaze are separate packages that include React transitively.

React Dependency​

React runtime dependencies are required for React-component usage (@esheet/renderer, @esheet/builder, @esheet/fields):

{
  "dependencies": {
    "react": "^19.0.0",
    "react-dom": "^19.0.0"
  }
}
  • @esheet/core is framework-agnostic — no React required.
  • @esheet/renderer-standalone and @esheet/renderer-blaze bundle React transitively, so your host app does not need React installed.

Verify Installation​

React renderer​

import { EsheetRenderer } from '@esheet/renderer';

console.log(EsheetRenderer);

React builder​

import { EsheetBuilder } from '@esheet/builder';

console.log(EsheetBuilder);

Standalone renderer​

import { mountStandaloneRenderer } from '@esheet/renderer-standalone';

console.log(mountStandaloneRenderer);

Blaze renderer​

import { registerBlazeTemplate } from '@esheet/renderer-blaze';

console.log(registerBlazeTemplate);

Next Steps​