React Props Reference
Comprehensive specification of all props for components exported by scrollsequence/react.
<Scene>
Controls pinning, scroll duration, triggers, and imperative scrubbing.
| Prop | Type | Default | Description |
|---|---|---|---|
ref | Ref<SceneHandle> | undefined | Ref handle to access progress(val) imperative method. |
duration | number | 1500 | Duration in pixels that the scene stays pinned. |
triggerStart | number | 0.5 | Viewport trigger start position (0 = top, 1 = bottom). |
triggerEnd | number | 0.5 | Viewport trigger end position. |
scrub | number | 1 | Scrub smoothing factor (0 for direct lock, 1 for smooth damping). |
markers | boolean | false | Visual debug markers for start/end triggers. |
contentAnimations | ContentAnimations | undefined | Keyframe track timelines on scroll. |
className | string | '' | CSS classes for scene wrapper. |
style | CSSProperties | undefined | Inline styles. |
<Layer>
Direct child of <Scene> for 9-point spatial placement.
| Prop | Type | Default | Description |
|---|---|---|---|
placement | PlacementType | 'center center' | Alignment: 'top left', 'top center', 'top right', 'center left', 'center center', 'center right', 'bottom left', 'bottom center', 'bottom right'. |
className | string | '' | CSS classes for layer container. |
style | CSSProperties | undefined | Inline styles. |
<Canvas2d>
Mounts and renders hardware-accelerated image sequence frames.
| Prop | Type | Default | Description |
|---|---|---|---|
mediaGroups | MediaGroup[] | [] | Array of image sequence sources (manifests or image arrays). |
depthMapsTilt | number | 0 | Parallax tilt intensity multiplier (e.g. 0.28). |
disableDepthmaps | boolean | false | Disables WebGL depth shaders and renders 2D canvas only. |
className | string | '' | Custom CSS class names for canvas element. |
style | CSSProperties | undefined | Inline styles. |
Last updated on