HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
AuraView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA lit, drifting background, drawn from the token layer.ExperimentalSince 0.1.0MediaUsageimport'@fusion.dev/helix/aura'Preview
API ReferenceRoothelix-auraA lit, drifting background, drawn from the token layer.
PropTypeDefaultDescriptionbloomnumber0.5How soft the falloff is, `0` tight and `1` diffuse.driftnumber0How far the settings wander on their own, `0` still and `1` restless.gainnumber1Overall brightness, as a multiplier on the field.interaction"light"|"none"|"ripple"|"shadow"What the pointer does, where the shape's own answer is not wanted.interactivebooleanfalseWhether the pointer shifts and lifts the field.reachnumber1How far the pointer reaches into the field, `0` upward.scalenumber1Feature size, as a multiplier on the sampled coordinates.speednumber1How fast it drifts, as a multiplier on time.terminusnumberWhere the axis crosses the top edge, as a fraction of the width.tiltnumber14The field's rotation, in degrees.variancenumber1How much the members of a population differ from one another, `0` a set
that is uniform and `1` the resting amount. Clamped to that range: these
are interpolations, so a larger number extrapolates rather than
exaggerating, and a streak whose length has passed through zero is drawn
as a bar across the whole frame.variant"aurora"|"braid"|"caustics"|"flow"|"fracture"|"lattice"|"particles"|"rays"|"streaks"|"threads"|"waves"Which form the light takes. Absent is `braid`.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
PartDescriptioncanvasThe surface the shader draws into.
ExamplesNameDescriptionAuroraCurtains on a drifting horizon, the one shape that is a landscape.CausticsLight through moving water. The pointer is a stone dropped in it.DriftEvery setting wandering on its own period, so the field has no countable cycle.FlowInk in a viscous medium. Move the pointer and the wake outlives it.FractureTerritories, lit only along the seams where two of them meet.LatticeA structure in perspective, lit at its joints.ParticlesPoints adrift on their own orbits, pushed aside by the pointer.PointerThe field answering a pointer, and how far its reach carries.PreviewA braided shaft of light, sized by the box it is put in.RaysRays from a source above the frame, following the pointer.StreaksLight traveling in lanes. The pointer is an obstacle the trails bow around.TerminusWhere the light leaves the top edge, held there whatever the box does.ThreadsFive curves woven to a pinch, and the pointer carries the pinch.TunedThe same braid, wound tighter and lit harder.WavesBroad bands rolling under a warp, with the crests dragged by the pointer.