WildflowerJS Logo WildflowerJS

Reference

The reference lists every function, option, computed property and default of wildflower.kinetic, in twenty-one pages. A link to a section of the old one-page reference opens the page that now holds that section.

The pages

Where an outcome has several routes, Which to use gives the one for each case and says which is the default: blur, grain, music, and fading a clip. Charts, simulations and particles have no module of their own, and Charts, simulations and particles gives the approach for each.

  1. Loading, tiers and TypeScript: the script tags, the tier each feature needs, the type declarations and the skill.
  2. The composition and the clock: the root's attributes, the kinetic store, the channels a seek arrives by, and the controls.
  3. Scenes: scene(), a scene's computed properties, its timing, edges, keyframes, pools, seek(local), waitFor, inputs and the scene's own root.
  4. Interactive mode: the two modes, steps, step(), the calls between steps, scripts, follow and the diagnostics.
  5. Transitions: the clip attributes, each kind, luma masks, what Kinetic writes and transition().
  6. Effects and line boil: effect() and its kinds, and boil().
  7. Shading: shade(), its marks, boil, freeze and move, light and grain, and blur().
  8. Type, Lottie and animated images: text(), lottie() and animatedImage().
  9. Eases, interpolation and tracks: ease(), interpolate(), tracks and styleAt(), text values and path data.
  10. Springs and motion helpers: spring(), ramp() and mix(), oklch, stagger(), posterize(), loop(), hold(), moment(), focus(), random(), noise() and wiggle().
  11. Camera, 3D and motion blur: camera(), depth(), shake(), smear(), trails() and Trillium.
  12. Trillium, three.js in a scene: a view drawn once per seek, the renderer it needs, aiming the camera, a tag over a scene point, footage as a texture, and check() and render().
  13. Paths, shapes and fields: matchPaths(), shape(), trimPath(), transforms on SVG, distribute() and falloff().
  14. Text and data: split(), typewriter(), format(), textMetrics(), ticks(), rank(), scramble(), captions(), srt() and beat().
  15. Audio: audio clips, markers and tempo, sound in the preview and in a render, level() and spectrum().
  16. Footage: video clips, the frame for a time, speed ramps, seeks and playing, and loading.
  17. Readiness and check(): readiness, failure and check().
  18. render(): render(), the shutter, the finish, what a render needs and canvases in a render.
  19. The preview bar, the guard and diagnostics: the bar, the guard, CSS-animation catch-up, the development diagnostics and the KN codes by range.
  20. Coming from Remotion, HyperFrames or After Effects: where each part comes from, and the Remotion, HyperFrames and After Effects equivalents.
  21. Rendering through HyperFrames: the runtime tag, the commands, what changes on the page while the runtime is present, and the frame-rate grid.

Every KN code is listed with its cause and fix on the WildflowerJS site's error codes page.