Terminal
Terminal/Skill
Guides building LottieFiles Creator plugins with the Creator Plugin API, covering sandbox and UI message passing, scene edits, and assets.
By LottieFiles
Works with
npx skills add lottiefiles/creator-plugin-skills --skill creator-plugin-developmentCreator Plugins extend the LottieFiles Creator animation application. They have a two-part sandboxed architecture:
plugin/plugin.ts) — Runs in isolation with access to the creator global API. Can manipulate scenes, layers, shapes, keyframes. Cannot make network requests.src/) — Standard React application rendered in an iframe. Can make network requests via fetch. Cannot access the creator API.The two parts communicate exclusively via message passing.
my-plugin/
├── plugin/
│ ├── manifest.json # Plugin metadata (id, name, apiVersion, entry, ui)
│ ├── plugin.ts # Sandbox code — has `creator` API access
│ └── [helpers].ts # Optional helper modules
├── src/
│ ├── main.tsx # React DOM entry point
│ ├── app.tsx # Main UI component
│ └── components/ # React components
├── vite.config.ts # Uses @lottiefiles/vite-plugin-creator
├── tsconfig.json # Root config with references
├── tsconfig.plugin.json # Plugin sandbox TypeScript config (no DOM)
├── tsconfig.app.json # UI TypeScript config (DOM + JSX)
├── index.html # Vite app template
└── package.json
tsconfig.plugin.json compiles sandbox code (no DOM libs). tsconfig.app.json compiles UI code (DOM + JSX).
The plugin manifest (plugin/manifest.json) defines the plugin's identity and entry points:
{
"id": "unique-uuid-v4",
"name": "My Plugin",
"apiVersion": "1",
"entry": "plugin.js",
"ui": "ui.html"
}
npm create @lottiefiles/creator-plugin@latest my-plugin # Scaffold a new plugin
# From the plugin directory (e.g., plugins/my-plugin/):
npm run dev # Start dev server with HTTPS hot-reload
npm run build # TypeScript check + Vite production build
npm exec tsc -- -b # Type check (run before completing any task)
To load in Creator: Plugins > Develop > New plugin > enter the localhost URL from npm run dev.
This is the most common source of bugs. The message wrapping is asymmetric:
// In UI code (src/app.tsx) — MUST wrap in pluginMessage object
parent.postMessage(
{ pluginMessage: { type: 'create-shape', color: '#ff0000' } },
'*'
);
// In plugin sandbox (plugin/plugin.ts) — messages arrive unwrapped
creator.ui.onMessage((msg) => {
if (msg.type === 'create-shape') {
// Use creator API here
}
});
// In plugin sandbox — no wrapping needed
creator.ui.postMessage({ type: 'shape-created', layerId: layer.id });
// In UI code — messages arrive wrapped in pluginMessage
window.addEventListener('message', (event) => {
const message = event.data.pluginMessage;
if (message?.type === 'shape-created') {
// Handle response
}
});
Define shared message types to catch mismatches at compile time:
// shared/types.ts
export type PluginMessage =
| { type: 'create-shape'; color: string }
| { type: 'import-svg'; content: string }
| { type: 'delete-selection' };
For request/response tracking, include a messageId field.
creator.ui.show({ width: 300, height: 500 });
const scene = creator.activeScene;
scene.size; // { width, height }
scene.duration; // seconds
scene.framerate; // FPS
scene.layers; // ReadonlyArray<Layer>
const layer = creator.activeScene.createShapeLayer();
const rect = layer.createRectangle({ size: { width: 200, height: 150 } });
layer.createFill({ type: 'SOLID', color: { r: 66, g: 133, b: 244 } });
// From URL
const anim = await scene.import({ type: 'LOTTIE', url: 'https://...' });
const img = await scene.import({ type: 'IMAGE', url: 'https://...' });
const svg = await scene.import({ type: 'SVG', url: 'https://...' });
// From content string
const svgLayer = await scene.import({ type: 'SVG', content: svgString });
// Audio, from a URL or base64 content
const audio = await scene.import({ type: 'AUDIO', content: base64Audio });
LOTTIE and SVG imports return SceneLayer. IMAGE imports return ImageLayer. AUDIO imports return AudioLayer. A failed import rejects, so wrap scene.import() in try/catch.
layer.position.addKeyframes([
{ frame: 0, value: { x: 100, y: 100 } },
{ frame: 60, value: { x: 400, y: 100 } },
]);
// With easing
const easeInOut = { type: 'CUBIC_BEZIER', x1: 0.42, y1: 0, x2: 0.58, y2: 1 };
layer.position.addKeyframes([
{ frame: 0, value: { x: 50, y: 100 }, easing: easeInOut },
{ frame: 60, value: { x: 350, y: 100 } },
]);
const selectedNodes = creator.selection.nodes;
creator.on('selection:nodes', (nodes) => {
creator.ui.postMessage({ type: 'selection-changed', count: nodes.length });
});
Always check node types before operations, and skip types you do not support. scene.layers, creator.selection.nodes, selection:nodes, shapes and creator.assets can return types your plugin does not know about, including types newer than your installed API types. See "Unknown Node Types" in references/scene-graph-and-nodes.md:
const layers = creator.selection.nodes;
layers.forEach((node) => {
if (node.type === 'SHAPE_LAYER') {
// Shape layer operations (has .shapes, .fills, .strokes, .trimPaths)
} else if (node.type === 'IMAGE_LAYER') {
// Image layer operations (has .image)
} else if (node.type === 'SCENE_LAYER') {
// Scene layer operations (has .scene, .break())
} else if (node.type === 'TEXT_LAYER') {
// Text layer operations (has .text, .fontFamily, .fontStyle, .fontSize,
// .alignment, .fill/.createFill, .stroke/.createStroke)
} else if (node.type === 'NULL_LAYER') {
// Null layer operations (transform only, has .layers)
} else if (node.type === 'AUDIO_LAYER') {
// Audio layer operations (has .audio, .muted, .volume; no transform)
}
// Any other type: skip it
});
Audio layers have no transform. Before reading position, opacity, or other transform members on a layer from scene.layers or the selection, check its type or use creator.utils.isTransformableLayer(layer). See references/scene-graph-and-nodes.md.
The plugin sandbox cannot make fetch requests. Use this pattern:
parent.postMessage({ pluginMessage: ... }, '*')For complete examples, see references/network-and-libraries.md.
pluginMessage wrapper — UI-to-plugin messages MUST be wrapped: { pluginMessage: { ... } }. Plugin-to-UI messages do NOT need wrapping.fetch calls to src/.localStorage/sessionStorage — The sandboxed iframe blocks browser storage APIs. Use creator.clientStorage from plugin code instead.node.type before accessing type-specific properties.staticValue on animated properties — Setting staticValue when keyframes exist will not affect the animation. Clear keyframes first or modify keyframe values directly.createRectangle(), call createFill().100 = 100% scale (not 1.0). Use { x: 100, y: 100 } for normal size.100 for fully opaque.{ r: 0-255, g: 0-255, b: 0-255 }.creator.ui.show() early — Call it at the top of plugin.ts, before setting up message handlers.creator.ui.postMessage() right after creator.ui.show() will be dropped because the iframe hasn't loaded. Use a "ui-ready" handshake: have the UI send { type: 'ui-ready' } on mount, then send data from the plugin only after receiving that message.visible, position, scale, rotation, or opacity. Code that walks scene.layers and reads those members fails to compile, and throws at runtime on a project with audio. Filter by type first, and skip types you do not handle.Before considering a task complete:
npm exec tsc -- -b — fix all type errorspluginMessage wrapping is correct in both directionsFor deeper information, consult these reference files as needed:
| Reference | When to Consult |
|---|---|
references/architecture-and-communication.md | Detailed architecture, complete message passing examples, UI API |
references/scene-graph-and-nodes.md | Scene hierarchy, node types, traversal patterns |
references/shapes-styling-animation.md | Creating shapes, fills/strokes/gradients, keyframes, easing |
references/importing-assets.md | LOTTIE/SVG/IMAGE/AUDIO import formats and patterns |
references/storage-and-events.md | clientStorage, node data, selection events, timeline API |
references/network-and-libraries.md | Fetch-from-UI pattern, using npm packages |