Entry points

One package, several entry points: you pay for what you import.

The entry points

@temporeum/timeline-core is a single package. Beside the engine it carries Gantt dependencies, a scheduler, resource views, calendars and more, each on an entry point of its own, so a timeline that uses none of them does not download them.

The element and the framework adapters import the engine, dom, live and words for you; groups, items, tools and intl come with the element's plugins of the same names, below. The scheduler you import yourself: only you decide when to schedule. The vis-timeline layer you import once, while you move over; the story's import, with the panel that tells it.

The element's entry points

The element follows the same rule: the parts a plain timeline does not need are plugins, each on an entry point of its own, and each imports its part of the core. A page downloads a plugin only when it imports it. Without any plugin the element draws, pans, zooms (wheel, pinch, keys), moves and resizes items, selects, clusters, loads windows of a fetched source, takes live data (addItems, updateItems, removeItems, changeItems), exports SVG, and renders on a server and hydrates — in English, left to right, on the Gregorian axis.

A plugin is registered once, for the page — every instance, every element and the server renderer draw with what is registered:

import { createTimeline, registerPlugin } from "@temporeum/timeline-element";
import { ganttPlugin, mountTaskGrid } from "@temporeum/timeline-element/gantt";

// The Gantt chart is a plugin: registered once, before the first timeline.
registerPlugin(ganttPlugin);

A configuration that asks for a plugin that is not registered — gantt without ganttPlugin, tooltip without toolsPlugin, an item of kind "point" without itemsPlugin — throws a TypeError where the timeline is created, updated (update, setItems, addItems) or rendered on a server, naming the import that is missing, and the instance is left as it was; it does not quietly draw a plain timeline. The items of a fetched source (items as a function) are checked when they arrive. The <script>-tag build (timeline-element.umd.js) carries every plugin and registers them on load.

How the budgets are measured

Every budget is minified and gzipped, for the whole entry point (import *), and every one is a gate in the library's CI: a change that crosses one does not merge.

• The core is measured on its own, because a server-side renderer or a canvas host can use it with nothing else.
• Every other entry point is measured as what it adds: the core and the entry point together, minus the core. None of them works without the core — they import it — so the price you see is the price you pay.

Two consequences, both checked by the same gates:

• Shared code ships once. An entry point imports the core's code from the core's own file instead of carrying a copy, so loading the core and an entry point together never downloads the same function twice.
• Unused code drops out. The package is marked "sideEffects": false, and a bundler keeps only what your code reaches: importing one function from the core costs a fraction of the whole entry point.

Formats

Each entry point ships as an ES module (.mjs) and as CommonJS (.cjs), each with its own type declarations, plus a self-contained UMD file for a plain <script> tag (dist/<entry point>.umd.js; the core's global is TemporeumTimeline, and each other entry point's is that followed by its name: TemporeumTimelineDom, TemporeumTimelineGroups, TemporeumTimelineItems, TemporeumTimelineGantt, TemporeumTimelineSchedule, TemporeumTimelineResources, TemporeumTimelineTools, TemporeumTimelineExport, TemporeumTimelineIntl, TemporeumTimelineLive, TemporeumTimelineWords, TemporeumTimelineCalendar, TemporeumTimelineVisCompat and TemporeumTimelineStory). The UMD files cannot share code with each other, so each carries what it needs. Import through the package name, not through dist/ paths: the stability policy covers the entry points, not the file layout.