Search documentation

Find a vivid-layer page or product.

Swirl

Animated color bands that twist into flowing arcs and vortex forms.

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

Customize

Band Count
4
Twist
0.1
Center
0.2
Proportion
0.5
Softness
0
Noise
0.2
Noise Frequency
0.4
Speed
0.32
Scale
1
Rotation
0
Offset X
0
Offset Y
0

API reference

The wrapper adds playback and runtime safeguards while preserving the complete Paper Swirl API. This includes its band, noise, color, motion, sizing, pixel-ratio, and styling props. See the Paper Swirl 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.
colorsstring[]["#ffd1d1", "#ff8a8a", "#660000"]Supplies up to ten band colors. The wrapper provides a warm red curated palette when omitted.
colorBackstring"#330000"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.