HelixOverviewComponentsMapsGraphIntroductionInstallationDeriving a themeSandboxTheme builderVisual testingCortexDocsEngramActiveTraceActiveRecallActiveServicesInsightsGet in touchSource on GitHub
Loading the reference
ShineView sourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorSweeps a band of light across its content, such as a button asking to be pressed.Also called Shine border, Glint, Sheen, and Light sweep.ExperimentalSince 0.241.0ContentImportimport'@fusion.dev/helix/shine'Preview
API referenceRoothelix-shineSweeps a band of light across its content, such as a button asking to be pressed.
PropTypeDescriptionloopbooleanDefaultfalseWhether the band crosses by itself, with a rest between. Reflected,
because the stylesheet runs the loop on it.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The content the band crosses.
PartDescriptionbandThe band of light.sweepThe layer over the content that the band crosses, clipped to --shine-radius. Hidden from screen readers.
CSS PropertyDescription--shine-colorThe color of the band. Defaults to white at 45% in light mode and black at 18% in dark mode, which show on the dark and the light fill of an action in each.--shine-durationHow long the band takes to cross. Defaults to two and a half times --helix-duration-slow, 800ms.--shine-radiusThe corners the band is clipped to. Defaults to --helix-radii-sm, the corners of a Button.
Custom stateDescriptionpausedThe page's motion is paused, so a band that crosses by itself does not.settledSet one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
Examples
NameDescriptionLoopA band that crosses by itself every few seconds, and stops when the page's motion is paused.PreviewA band of light crosses the button when the mouse comes over it or focus comes in.