HelixOverviewComponentsMapsGraphIntroductionInstallationDeriving a themeSandboxTheme builderVisual testingCortexDocsEngramActiveTraceActiveRecallActiveServicesInsightsGet in touchSource on GitHub
Loading the reference
Border BeamView sourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA light that travels around the edge of its content, for something running or live.Also called Running border, Moving border, Border light, and Glow border.ExperimentalSince 0.246.0ContentImportimport'@fusion.dev/helix/border-beam'Preview
GuidelinesWhen to use
A card or a panel whose work is running, such as an agent writing a reply.Border BeamThis page
Set idle when the work stops.A light left running says the work is still going.
Say what is running in words as well, such as with a Badge.The light takes no pointer and is hidden from screen readers.
API referenceRoothelix-border-beamA light that travels around the edge of its content, for something running or live.
PropTypeDescriptionidlebooleanDefaultfalseWhether the work has stopped, so no light runs. Reflected, because the
stylesheet takes the light away on it.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The content whose edge the light travels, such as a Card.
PartDescriptionbeamThe light, a soft spot cut to the edge. Hidden from screen readers.
CSS PropertyDescription--border-beam-colorThe color of the light. Defaults to --helix-color-accent.--border-beam-durationHow long one lap takes. Defaults to the length of the edge at a steady pace, between 2.4 and 6 seconds.--border-beam-radiusThe corners the light follows. Defaults to --helix-radii-md, the corners of a Card.--border-beam-sizeHow far the light reaches along the edge. Defaults to 4rem, and to half the shorter side of a small box.--border-beam-widthHow wide the lit edge is. Defaults to --helix-border-thin, a Card's border.
Custom stateDescriptionpausedThe page's motion is paused, so the light holds where it is.settledSet one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
Examples
NameDescriptionIdleThe light goes when the work stops, and comes back when it starts again.PreviewA light runs around the edge of a card while the work inside it goes on.