univer-sheet-start-kit

A starter kit for trying Univer sheet presets with both ESM and UMD examples.

Getting Started

pnpm install
pnpm dev

Open the local Vite URL in your browser. The home page lists all available examples.

For collaboration examples, copy .env.sample to .env and set UNIVER_ENDPOINT to your collaboration server endpoint.

Examples

ESM Examples

• preset-sheets-core/: basic spreadsheet editor with core sheet presets.
• preset-sheets-core-with-worker/: core sheet setup with the formula worker enabled.
• preset-sheets-advanced/: extends the core example with @univerjs/preset-sheets-advanced.
• preset-sheets-collaboration/: enables collaboration presets and creates or opens a sheet unit through the collaboration API.
• preset-sheets-collaboration-with-worker/: collaboration setup with worker-backed sheet and advanced presets.

UMD Examples

• umd/preset-sheets-core/: same core sheet setup using UMD bundles from node_modules.
• umd/preset-sheets-advanced/: advanced sheet setup using UMD bundles.
• umd/preset-sheets-collaboration/: collaboration sheet setup using UMD bundles.

UMD examples intentionally do not include worker variants.

Scripts

• pnpm dev: start the Vite dev server.
• pnpm build: run TypeScript checks and build the app.
• pnpm test: verify the example directory metadata.
• pnpm lint: check code style.
• pnpm lint:fix: auto-fix lint issues where possible.