example-solid
Skill130 starsChanged 38 days agoApache-2.0View on GitHub
Patterns for using Helios with SolidJS. Use when building compositions in a SolidJS environment, utilizing signals for fine-grained reactivity.
In this repository38 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- llms.txtllms.txt
- skill-creatorSkill
- helios-coreSkill
- animated-video-philosophySkill
- cinematic-product-promo-planSkill
- motion-stylesSkill
- example-canvasSkill
- example-chartjsSkill
- example-d3-animationSkill
- example-framer-motionSkill
- example-gsapSkill
- example-lottieSkill
- example-p5-animationSkill
- example-pixiSkill
- example-podcast-visualizerSkill
- example-reactSkill
- example-signals-animationSkill
- example-svelteSkill
- example-tailwind-animationSkill
- example-threejsSkill
- example-vanillaSkill
- example-vueSkill
- helios-getting-startedSkill
- guided-brand-videoSkill
- guided-cartoon-shortSkill
- motion-design-rulesSkill
- guided-music-videoSkill
- guided-video-recipesSkill
- helios-playerSkill
- helios-rendererSkill
- helios-skillsSkill
- helios-studioSkill
- archive-brollSkill
- create-compositionSkill
- render-videoSkill
- workflow-visualize-dataSkill
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 155
createEffect: Use createEffect to trigger imperative canvas drawing logic whenever the Helios signal updates. - Very specific: line 156
Cleanup: Always use onCleanup to remove the Helios subscription when the component unmounts.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
SolidJS Composition Patterns
Integrate Helios into SolidJS components using Signals to manage frame state reactivity with high performance.
Quick Start
1. Create Helios Signal
Wrap the Helios instance in a SolidJS signal to make state reactive.
// lib/createHeliosSignal.js
import { createSignal, onCleanup } from 'solid-js';
export function createHeliosSignal(helios) {
const [frame, setFrame] = createSignal(helios.getState());
const unsubscribe = helios.subscribe((state) => {
setFrame(state);
});
onCleanup(() => {
unsubscribe();
});
return frame;
}2. Create Composition Component
// App.jsx
import { createEffect } from 'solid-js';
import { Helios } from '@helios-project/core';
import { createHeliosSignal } from './lib/createHeliosSignal';
// Initialize Helios (outside component or in a context)
const helios = new Helios({
duration: 10,
fps: 30,
width: 1920,
height: 1080
});
// Bind for external control
helios.bindToDocumentTimeline();
function App() {
let canvasRef;
// Create reactive accessor
const state = createHeliosSignal(helios);
createEffect(() => {
const canvas = canvasRef;
if (!canvas) return;
const ctx = canvas.getContext('2d');
const { currentFrame, width, height } = state();
// Clear
ctx.clearRect(0, 0, width, height);
// Draw
ctx.fillStyle = '#446b9e';
const x = (currentFrame / (10 * 30)) * width;
ctx.fillRect(x, height / 2 - 50, 100, 100);
});
return (
<canvas
ref={canvasRef}
width={1920}
height={1080}
style={{ width: '100%', height: 'auto' }}
/>
);
}
export default App;3. Three.js Integration
Integrate three with Helios by synchronizing the render loop via createEffect.
// App.jsx
import { createEffect, onCleanup, onMount } from "solid-js";
import * as THREE from "three";
import { Helios } from "@helios-project/core";
import { createHeliosSignal } from "./lib/createHeliosSignal";
// Singleton initialization pattern
if (!window.helios) {
window.helios = new Helios({
fps: 30,
duration: 10,
width: 1920,
height: 1080
});
}
export default function App() {
let canvasRef;
const state = createHeliosSignal(window.helios);
onMount(() => {
// 1. Setup Three.js Scene
const scene = new THREE.Scene();
const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
const renderer = new THREE.WebGLRenderer({ canvas: canvasRef, antialias: true });
// 2. Create Objects
const geometry = new THREE.BoxGeometry();
const material = new THREE.MeshBasicMaterial({ color: 0x00ff00 });
const cube = new THREE.Mesh(geometry, material);
scene.add(cube);
camera.position.z = 5;
// 3. Sync Render Loop
createEffect(() => {
const s = state();
const t = s.currentTime;
// Update animation state based on time
cube.rotation.x = t * 0.5;
cube.rotation.y = t * 0.5;
renderer.render(scene, camera);
});
// 4. Cleanup
onCleanup(() => {
renderer.dispose();
geometry.dispose();
material.dispose();
});
});
return <canvas ref={canvasRef} style={{ width: '100%', height: '100%' }} />;
}Key Concepts
- Fine-Grained Reactivity: SolidJS signals update only what changes. However, since Helios updates on every frame (30-60 times/sec), wrapping the entire state in a signal is the standard approach for canvas rendering.
createEffect: UsecreateEffectto trigger imperative canvas drawing logic whenever the Helios signal updates.- Cleanup: Always use
onCleanupto remove the Helios subscription when the component unmounts.
Source Files
- Helper:
examples/solid-animation-helpers/src/lib/createHeliosSignal.js - Example:
examples/solid-canvas-animation/ - Example:
examples/solid-threejs-canvas-animation/
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

