Search documentation

Find a vivid-layer page or product.

Spiral

An animated spiral that ranges from crisp geometry to flowing abstract rings.

pnpm dlx shadcn@latest add @vivid-layer/spiral

Customize

Density
1
Distortion
0
Stroke Width
0.5
Stroke Taper
0
Stroke Cap
0
Noise
0
Noise Frequency
0
Softness
0
Speed
1
Scale
1
Rotation
0
Offset X
0
Offset Y
0

API reference

The wrapper adds playback and runtime safeguards while preserving the complete Paper Spiral API. This includes its stroke, noise, color, motion, sizing, pixel-ratio, and styling props. See the Paper Spiral reference for the full prop table and accepted ranges.

PropTypeDefaultDescription
playback"auto" | "always" | "paused""auto"Controls motion policy. Auto pauses for reduced motion and while the shader is outside the viewport.
colorFrontstring"#79D1FF"Sets the spiral stroke color.
colorBackstring"#001429"Sets the background color.
width / heightnumber | string"100%"Sets the canvas CSS dimensions. Size the parent element to establish the visible area.
maxPixelCountnumber2073600Caps the rendered pixel budget. Override only after measuring the target devices.

Credits

The rendering engine is Paper Shaders, distributed under the Apache License 2.0. vivid-layer supplies the React adapter, playback policy, documentation, and Registry packaging; it does not vendor or modify Paper's shader source.