Search documentation

Find a vivid-layer page or product.

Dithering

An animated two-color dithered field built from procedural pattern shapes.

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

Customize

Size
2
Speed
1
Scale
0.6
Rotation
0
Offset X
0
Offset Y
0

API reference

The wrapper adds playback and runtime safeguards while preserving the complete Paper Dithering API. This includes its pattern, dither, color, motion, sizing, pixel-ratio, and styling props. See the Paper Dithering 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"#00b2ff"Sets the dither pattern color.
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.