Reference

Configuration reference

Reference for Zeenat preset, intensity, duration, motion, scheduling, seed, z-index, enabled and diagnostics options.

Scene options

React ZeenatProps extends ZeenatOptions and adds className. The vanilla adapter adds an optional mount target and className.

TypeScript
type ZeenatOptions = {
  preset: BuiltInPresetName | ZeenatPreset;
  flag?: CountryFlag; // required for preset="bunting" only
  orientation?: "horizontal" | "vertical"; // flag-bunting presets only
  intensity?: "low" | "medium" | "high"; // medium
  duration?: number | "infinite"; // infinite
  zIndex?: number; // 1000
  respectReducedMotion?: boolean; // true
  motion?: "system" | "full" | "reduced"; // system
  enabled?: boolean; // true
  seed?: number;
  activeFrom?: string | Date;
  activeUntil?: string | Date;
  debug?: boolean; // false
};

Flag and orientation

flag is required for the bunting string preset and invalid on other presets. orientation defaults to horizontal and is accepted by bunting, pakistan-independence-day, pakistan-defence-day and us-independence-day. For a custom preset object, configure orientation inside its factory or bunting effect instead of passing it at the scene level.

Flag options
<Zeenat preset="bunting" flag="JP" orientation="vertical" />;
<Zeenat preset="pakistan-independence-day" orientation="horizontal" />;

Deterministic seed

A normalized scene seed derives one stable random stream for every preset effect index. Restarting with the same seed replays the same generated geometry.

Motion override

Use system for normal applications. full and reduced are explicit overrides intended for user-controlled motion settings and preview tools. respectReducedMotion is true by default.

Host z-index

zIndex controls the root's relationship with the host application. Individual effects use background, ambient, foreground and top bands inside that root and cannot escape the scene.