Skip to Content
Coming soon!
V2 (beta)API & ReferenceReact Props Reference

React Props Reference

Comprehensive specification of all props for components exported by scrollsequence/react.


<Scene>

Controls pinning, scroll duration, triggers, and imperative scrubbing.

PropTypeDefaultDescription
refRef<SceneHandle>undefinedRef handle to access progress(val) imperative method.
durationnumber1500Duration in pixels that the scene stays pinned.
triggerStartnumber0.5Viewport trigger start position (0 = top, 1 = bottom).
triggerEndnumber0.5Viewport trigger end position.
scrubnumber1Scrub smoothing factor (0 for direct lock, 1 for smooth damping).
markersbooleanfalseVisual debug markers for start/end triggers.
contentAnimationsContentAnimationsundefinedKeyframe track timelines on scroll.
classNamestring''CSS classes for scene wrapper.
styleCSSPropertiesundefinedInline styles.

<Layer>

Direct child of <Scene> for 9-point spatial placement.

PropTypeDefaultDescription
placementPlacementType'center center'Alignment: 'top left', 'top center', 'top right', 'center left', 'center center', 'center right', 'bottom left', 'bottom center', 'bottom right'.
classNamestring''CSS classes for layer container.
styleCSSPropertiesundefinedInline styles.

<Canvas2d>

Mounts and renders hardware-accelerated image sequence frames.

PropTypeDefaultDescription
mediaGroupsMediaGroup[][]Array of image sequence sources (manifests or image arrays).
depthMapsTiltnumber0Parallax tilt intensity multiplier (e.g. 0.28).
disableDepthmapsbooleanfalseDisables WebGL depth shaders and renders 2D canvas only.
classNamestring''Custom CSS class names for canvas element.
styleCSSPropertiesundefinedInline styles.
Last updated on
Feedback