A photo you can stir like liquid
| Name | Type | Default | Description |
|---|---|---|---|
src | string | Koi pond | Image to stir. It is cropped to cover the component. |
alt | string | "Orange-and-black koi beneath green lily pads on a reflective pond" | Accessible description of the image. |
aspectRatio | number | 4 / 3 | Width divided by height. 0 fills the parent's height instead. |
radius | number | 16 | Corner radius in pixels. |
brushSize | number | 60 | Radius in pixels of the liquid the pointer drags along. |
force | number | 1 | How hard the pointer pushes the liquid. Faster moves push harder. |
swirl | number | 0.35 | How much the flow curls into eddies, from 0 (smooth smears) to 1 (marbled whirls). |
flow | number | 0.45 | Seconds for the liquid to lose half its speed once the pointer stops. |
settleTime | number | 1.1 | How quickly the image flows back into place, in seconds. Longer values leave the swirls on show. |
gloss | number | 0.4 | Wet highlight on the moving liquid, from 0 to 2. |
shade | number | 0.4 | Darkening where the liquid bunches up and lightening where it thins out, from 0 to 1. |
chromatic | number | 0.3 | Colour fringing where the image is pulled furthest, from 0 to 1. |
highlightColor | string | "#FFFFFF" | Colour of the wet highlight. |
quality | number | 1 | Detail of the fluid simulation, from 0.25 to 2. Lower values are cheaper and give broader swirls. |
hover | boolean | true | Stir the liquid as the pointer moves over it. On touch screens, horizontal swipes stir and vertical swipes scroll. |
clickBurst | boolean | true | Clicking, tapping or pressing Enter pushes the liquid outward from that point. |
autoplay | boolean | false | While nobody is interacting, a slow stir wanders across the image. |
autoplaySpeed | number | 1 | Speed of that stir. |
idleDelay | number | 2 | Seconds after the pointer leaves before autoplay resumes. |
ref | { stir, burst, settle } | — | stir(x, y, dx, dy) pushes the liquid at a point with a velocity in pixels per second. burst(x, y) pushes outward. settle() snaps the image back at once. |
className | string | — | Classes for the root element, which fills its parent's width. |
style | CSSProperties | — | Inline styles for the root element. |
srcstringImage to stir. It is cropped to cover the component.
Koi pondaltstringAccessible description of the image.
"Orange-and-black koi beneath green lily pads on a reflective pond"aspectRationumberWidth divided by height. 0 fills the parent's height instead.
4 / 3radiusnumberCorner radius in pixels.
16brushSizenumberRadius in pixels of the liquid the pointer drags along.
60forcenumberHow hard the pointer pushes the liquid. Faster moves push harder.
1swirlnumberHow much the flow curls into eddies, from 0 (smooth smears) to 1 (marbled whirls).
0.35flownumberSeconds for the liquid to lose half its speed once the pointer stops.
0.45settleTimenumberHow quickly the image flows back into place, in seconds. Longer values leave the swirls on show.
1.1glossnumberWet highlight on the moving liquid, from 0 to 2.
0.4shadenumberDarkening where the liquid bunches up and lightening where it thins out, from 0 to 1.
0.4chromaticnumberColour fringing where the image is pulled furthest, from 0 to 1.
0.3highlightColorstringColour of the wet highlight.
"#FFFFFF"qualitynumberDetail of the fluid simulation, from 0.25 to 2. Lower values are cheaper and give broader swirls.
1hoverbooleanStir the liquid as the pointer moves over it. On touch screens, horizontal swipes stir and vertical swipes scroll.
trueclickBurstbooleanClicking, tapping or pressing Enter pushes the liquid outward from that point.
trueautoplaybooleanWhile nobody is interacting, a slow stir wanders across the image.
falseautoplaySpeednumberSpeed of that stir.
1idleDelaynumberSeconds after the pointer leaves before autoplay resumes.
2ref{ stir, burst, settle }stir(x, y, dx, dy) pushes the liquid at a point with a velocity in pixels per second. burst(x, y) pushes outward. settle() snaps the image back at once.
—classNamestringClasses for the root element, which fills its parent's width.
—styleCSSPropertiesInline styles for the root element.
—