Search documentation

Find a vivid-layer page or product.

Warp

An animated field of colors shaped by noise, distortion, and swirling motion.

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

Customize

Proportion
0.45
Softness
1
Distortion
0.25
Swirl
0.8
Swirl Iterations
10
Shape Scale
0.1
Speed
1
Scale
1
Rotation
0

API reference

The wrapper adds playback and runtime safeguards while preserving the complete Paper Warp API. This includes its colors, pattern, distortion, motion, sizing, pixel-ratio, and styling props. See the Paper Warp 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[]["#121212", "#9470ff", "#121212", "#8838ff"]Supplies up to ten warp colors. The wrapper provides a dark purple curated palette when omitted.
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.