Skip to content

Component libraries Pre-release

@elenajs/bundler is the build tool for publishing Elena component libraries. It bundles JavaScript and TypeScript source files, minifies CSS, generates a Custom Elements Manifest, and produces TypeScript declarations for each component.

Elena bundler

Install

sh
npm install --save-dev @elenajs/bundler
sh
yarn add --dev @elenajs/bundler
sh
pnpm add --save-dev @elenajs/bundler
sh
bun add --dev @elenajs/bundler

CLI usage

The bundler provides an elena binary with build and watch commands:

bash
npx elena build

To start a watch session that rebuilds on file changes:

bash
npx elena watch

Flags

FlagDescription
--config <path>Path to a config file. Defaults to elena.config.mjs or elena.config.js in the project root.

Configuration

Create an elena.config.mjs (or elena.config.js) at the root of your package:

js
/**
 * ░█ [ELENA]: Bundler configuration
 *
 * @type {import("@elenajs/bundler").ElenaConfig}
 */
export default {
  // Source directory scanned for .js/.ts entry files and .css files.
  input: "src",

  // Rollup output options.
  output: {
    dir: "dist",
    format: "esm",
    sourcemap: true,
  },

  // Entry for the single-file bundle. Set to false to disable.
  bundle: "src/index.js",

  // Additional Rollup plugins appended after Elena’s built-in set.
  // plugins: [],

  // Custom Elements Manifest options. Set to false to skip entirely.
  // analyze: {
  //   plugins: [],
  // },

  // Browserslist targets for transpilation. Enables syntax transforms
  // (e.g. class fields, optional chaining) to widen browser support.
  // target: ["chrome 71", "firefox 69", "safari 12.1"],

  // Custom Terser minifier options, merged with the defaults.
  // terser: { ecma: 2020, module: true },

  // Banner comment prepended to bundle output files.
  // Use a @license tag so minifiers preserve it.
  // banner: `/** @license MIT */`,
};

Options

OptionTypeDefaultDescription
inputstring"src"Source directory to scan for .js, .ts, and .css files.
output.dirstring"dist"Output directory for compiled files.
output.formatstring"esm"Rollup output format.
output.sourcemapbooleantrueWhether to emit sourcemaps.
bundlestring | false"src/index.js"Entry point for the single-file bundle. Auto-detects src/index.ts if no .js entry exists. Set to false to disable.
pluginsPlugin[][]Additional Rollup plugins appended after the built-in set.
analyzeobject | false{ plugins: [] }CEM analysis options. Set to false to skip Custom Elements Manifest generation, TypeScript declarations, and JSX types entirely.
analyze.pluginsPlugin[][]Additional CEM analyzer plugins.
targetstring | string[] | falsefalseBrowserslist target(s) for transpilation. When set, enables syntax transforms (e.g. class fields, optional chaining) via @babel/preset-env. Example: ["chrome 71", "safari 12.1"].
terserobject{ ecma: 2020, module: true }Custom Terser minifier options, merged with the defaults. See the Terser API docs for available options.
bannerstring | falsefalseBanner comment prepended to index.js and bundle.js output files. Use a @license JSDoc tag so minifiers preserve it.

Build output

Running elena build produces:

FileDescription
dist/*.jsIndividual ES modules for each source file.
dist/*.cssMinified individual CSS files.
dist/bundle.jsSingle-file JavaScript bundle (optional).
dist/bundle.cssConcatenated and minified CSS bundle. CSS files imported as CSS Module Scripts (with { type: "css" }) for Shadow DOM are excluded.
dist/custom-elements.jsonCustom Elements Manifest describing all components.
dist/custom-elements.d.tsJSX integration types mapping tag names to prop types.
dist/*.d.tsPer-component TypeScript declarations with typed props and events.

TIP

CSS files that are imported as CSS Module Scripts (import styles from "./button.css" with { type: "css" }) for Shadow DOM use are automatically excluded from bundle.css. These files are instead inlined as CSSStyleSheet objects in the JavaScript output. Individual .css files are still emitted.

TypeScript support

The bundler supports both JavaScript and TypeScript source files. When .ts files are detected in the source directory, the bundler automatically transpiles them via @rollup/plugin-typescript. The output is identical to what you get from JavaScript sources.

To use TypeScript, write your components with inline type annotations instead of JSDoc:

ts
import { Elena, html } from "@elenajs/core";

export default class Button extends Elena(HTMLElement, {
  tagName: "elena-button",
  props: ["variant"],
}) {
  /**
   * The style variant of the component.
   * @property
   */
  variant: "default" | "primary" | "danger" = "default";

  render() {
    return html`<button>${this.text}</button>`;
  }
}
Button.define();

A tsconfig.json is required in the project root. A minimal configuration:

json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "skipLibCheck": true
  },
  "include": ["src"]
}

TIP

The bundler handles TypeScript declarations separately via the CEM analyzer. You don’t need declaration: true in your tsconfig.json.

See the TypeScript page for more on using and consuming the generated types.

Programmatic API

The bundler exports its internals so you can integrate it into your own build scripts:

js
import {
  createRollupConfig,
  runRollupBuild,
  watchRollupBuild,
  createCemConfig,
  runCemAnalyze,
} from "@elenajs/bundler";

Sub-path imports are also available:

js
import { createRollupConfig, runRollupBuild, watchRollupBuild } from "@elenajs/bundler/rollup";
import { createCemConfig, runCemAnalyze } from "@elenajs/bundler/cem";

createRollupConfig(options?)

Returns a Rollup configuration array. Useful if you want to wrap or extend the config in a custom rollup.config.js.

runRollupBuild(config)

Runs both build phases (individual modules + optional single-file bundle) programmatically.

watchRollupBuild(config, opts?)

Starts a Rollup watch session that rebuilds on file changes. Returns the Rollup watcher instance. Pass opts.onRebuild as an async callback to run after each successful rebuild (e.g. to re-run CEM analysis).

createCemConfig(options?)

Returns the Custom Elements Manifest analyzer configuration object.

runCemAnalyze(config, cwd?)

Runs the CEM analysis and writes custom-elements.json, custom-elements.d.ts, and per-component .d.ts files.

Example library Pre-release

@elenajs/components is a reference component library built with Elena. It demonstrates real-world component patterns and is available as a starting point for your own library.

sh
npm install @elenajs/components
sh
yarn add @elenajs/components
sh
pnpm add @elenajs/components
sh
bun add @elenajs/components

It includes the following components:

ComponentTagDescription
Button<elena-button>Renders a <button> or <a> with variants, states, and icons.
Spinner<elena-spinner>Animated loading indicator that inherits the current color.
Stack<elena-stack>Flexbox layout wrapper with configurable direction and gap.
Visually Hidden<elena-visually-hidden>Hides content visually while keeping it accessible.

Usage

Import the full bundle to register all components:

js
import "@elenajs/components";

Or import individual components for better tree-shaking:

js
import "@elenajs/components/dist/button.js";
import "@elenajs/components/dist/stack.js";

Each component has a matching CSS file:

css
@import "@elenajs/components/dist/button.css";
@import "@elenajs/components/dist/stack.css";

Or import the full CSS bundle:

css
@import "@elenajs/components/dist/bundle.css";

The source code is in packages/components/ of the Elena monorepo and serves as an example of how to structure, build, and publish a library with @elenajs/bundler.

Next steps