Search documentation

Find a vivid-layer page or product.

Heatmap

A contour-driven thermal color treatment for logos, marks, and transparent shapes.

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

Customize

Contour
0.5
Angle
0
Noise
0
Inner Glow
0.5
Outer Glow
0.5
Speed
1
Scale
0.75
Rotation
0
Offset X
0
Offset Y
0

API reference

The wrapper adds playback and runtime safeguards while preserving the complete Paper Heatmap API. See the Paper Heatmap reference for the full prop table and accepted ranges.

PropTypeDefaultDescription
imagestring | HTMLImageElementrequiredSupplies the source shape that Paper processes into the animated heatmap.
playback"auto" | "always" | "paused""auto"Controls motion policy. Auto pauses for reduced motion and while the shader is outside the viewport.
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. The example uses vivid-layer's own mark. vivid-layer supplies the adapter, playback and loading policies, documentation, and Registry packaging.