Reference

API reference

Reference for the Zeenat React component, ZeenatScene, vanilla controller, core definitions, effects and presets.

React exports

The zeenat entry exports Zeenat, ZeenatScene, ZeenatHandle, ZeenatProps and ZeenatSceneProps. It also re-exports core definition, validation and public engine types.

Controller

ZeenatController exposes state plus pause(), resume(), restart(), destroy(), setIntensity(), getDiagnostics() and subscribeDiagnostics(). destroy() is idempotent.

Core authoring exports

zeenat/core exports defineEffect, definePreset, preset validation functions and framework-neutral authoring types including EffectContext, ZeenatEffect, ZeenatPreset, ZeenatScheduler and ZeenatLayer.

Effects and presets

zeenat/effects exports all nine neutral effect factories and their option types. zeenat/presets exports seven ready-to-use preset objects, the registry, resolver and eight typed factories. The configurable bunting ID requires flag and is resolved separately from builtInPresets through createBuntingPreset.

Country catalog and artwork contracts

zeenat/flags exports flagCatalog, resolveFlag, countryFlag, CountryFlag, CountryFlagCode and CountryFlagName. zeenat/effects/bunting exports pakistanFlag, unitedStatesFlag, BuntingFlagDesign, BuntingFlagRenderContext, FlagOrientation, FlagBuntingOptions and PennantBuntingOptions.