three-story-controls

Home > three-story-controls > ScrollAdaptorProps

ScrollAdaptorProps interface

Properties that can be passed to the ScrollAdaptor constructor

Signature:

export interface ScrollAdaptorProps 

Properties

Property Type Description
buffer? number (Optional) Buffer before and after element to start registering scroll. Number between 0 and 1, defaults to 0.1
dampingFactor? number (Optional) Value between 0 and 1. Defaults to 0.5
endOffset? string (Optional) Offset to end registering scroll, in px or vh. Default ends when bottom of element is at top of viewport.
scrollElement HTMLElement Long DOM Element to observe
startOffset? string (Optional) Offset to start registering scroll, in px or vh. Default starts when top of element is at bottom of viewport.