Generative Ribbon Field

<GenerativeRibbonField>CSS Modules

Braided ribbons that bend toward the pointer.

InstallationColoxo CLI
npx coloxo add generative-ribbon-field
ES Module ImportPlayground / npm package
import { GenerativeRibbonField } from '@coloxo/ui/visuals';

1. Live preview

This is the real component, not a recording. Move the pointer over it, then adjust the renderer settings.

Canvas 2D
<GenerativeRibbonField quality="low" />

2. Usage

Braided ribbons that bend toward the pointer. npx coloxo add generative-ribbon-field copies this effect in a Tailwind project or a Coloxo CSS project, and adds @coloxo/ui to package.json. You can also import it from @coloxo/ui/visuals.

3. Performance notes

Effects render on demand and dispose their GPU context when unmounted.

  • Every effect pauses when scrolled out of view or when the tab is hidden, so an idle page costs nothing.
  • quality caps the device pixel ratio. Keep it at low when several effects share one viewport.
  • With respectReducedMotion enabled, the effect renders a single static frame instead of animating.
  • The output is a decorative canvas hidden from assistive technology. Never place essential content only inside the effect.

4. Props

NameTypeDefaultDescription
ribbonCountnumber14Number of ribbons, 3–40.
waveAmplitudenumber42Wave amplitude in CSS pixels, 0–120.
flowSpeednumber0.6Forward scroll speed, 0–2.
ribbonThicknessnumber1.6Stroke width in CSS pixels, 0.5–8.
pointerAttractionnumber0.5How strongly ribbons bend toward the pointer, 0–1.
filledbooleanfalseDraw ribbons as filled bands rather than lines.
colorstringColoxo bluePrimary colour.
accentColorstringcyanSecondary colour.
pausedbooleanfalseRender a single static frame instead of animating.
respectReducedMotionbooleantrueFreeze to a static frame when prefers-reduced-motion is set.
quality"low" | "medium" | "high"mediumCaps the renderer pixel ratio. Use low for grids of many effects.
className / stylestring / CSSProperties—Applied to the container element.