Help guide

Runtime API reference

Updated June 20, 2026

Runtime API reference

Product media placeholder

Replace this area with a screenshot or short walkthrough video during the media sweep.

The runtime API is the bridge between a page and a .fmtion file. It should be used deliberately so motion files mount, update, and dispose without leaving stale page state.

Where this fits

Load and mount

  • Load the .fmtion JSON before attaching it to the DOM or Canvas mount that owns the visual.
  • Keep the page mount selector and the file mount selector aligned. A mismatch should be treated as a publish blocker.
  • When a page has multiple motion files, give each instance its own lifecycle and debug label.

Control and parameters

  • Play and pause should be explicit when motion depends on route state, tab visibility, modal state, or viewport presence.
  • Parameter updates should use named paths and expected value shapes so debug output remains readable.
  • Avoid writing parameters from several page systems unless the ownership and precedence are documented.

Dispose and cleanup

  • Dispose motion instances when the page route, section, modal, or component is removed.
  • Cleanup should remove listeners, animation frames, Canvas state, and any DOM writes that should not persist.
  • After dispose, verify that reopening the page or component creates a clean new instance.

Working sample slot

Runtime API reference: This page reserves a sample location for a later verified example. Add the sample only after the source file, public page, validation output, and visual check all pass.

Faster Motion docs

Use these links to move between the guide set, the deeper reference pages, and the recipe planning pages. Verified working samples will be inserted after this documentation structure is reviewed.

Start

Surfaces

Reference

Start

DOM animation

Reference

Canvas animation

3D and procedural

Operations

Recipes

Was this guide helpful?

Sunny Arora

Written by

Sunny Arora

Get technical deep dives delivered to your inbox

Join creators and developers who get exclusive insights, tutorials, and behind-the-scenes content every week.

No spam. Unsubscribe anytime.

Continue Exploring

You might also enjoy