Setup

Installation

Package requirements, imports, ESM and CJS output, React peer dependencies and supported Zeenat.js subpath exports.

Install the package

The npm package name is zeenat. Version 0.3.0 ships ESM, CommonJS, declarations and sourcemaps. Optional flag geometry is split into on-demand chunks in both builds; keep the complete package output when deploying.

npm
npm install zeenat

Choose the smallest entry point

The main entry exports React adapters and core definitions. Framework-neutral consumers can use zeenat/core or zeenat/vanilla. Effects and configurable presets have aggregate and individual subpath exports for tree shaking.

Imports
import { Zeenat } from "zeenat";
import { zeenat } from "zeenat/vanilla";
import { snow } from "zeenat/effects/snow";
import { createWinterPreset } from "zeenat/presets/winter";

React peer dependencies

React 18.2 or newer is supported. React DOM is an optional peer for framework integration, while framework-neutral entries do not depend on React at runtime.

Optional country flags

zeenat/flags exports flagCatalog, resolveFlag and countryFlag. Country metadata is synchronous; selected artwork loads from local package chunks when a flag scene mounts.

Flag imports
import { flagCatalog, countryFlag, resolveFlag } from "zeenat/flags";
import { createBuntingPreset } from "zeenat/presets/bunting";