Search documentation

Find a vivid-layer page or product.

Metaballs

Animated colored blobs that move and merge into fluid organic forms.

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

Customize

Count
10
Size
0.83
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 Metaballs API. This includes its blob count, size, colors, motion, sizing, pixel-ratio, and styling props. See the Paper Metaballs 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[]["#6e33cc", "#ff5500", "#ffc105", "#ffc800", "#f585ff"]Supplies up to eight metaball colors. The wrapper provides a vivid curated palette when omitted.
colorBackstring"#000000"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.