animare
Version:
Advanced animation library for modern JavaScript.
22 lines • 757 B
TypeScript
import type { ScrollAnimationOptions } from '../types.js';
/**
* Makes the scroll progress control the timeline.
*
* @param options - The options for configuring the scroll-controlled animation.
* @returns A function to remove the scroll event listener.
*
* @example
* const myAnimation = animare( ... );
*
* // The element to track when entering and exiting the viewport
* const element = document.getElementById('element');
*
* const unsubscribe = scrollAnimation({
* timeline: myAnimation,
* element: element
* });
*
* unsubscribe(); // Removes the scroll event listener
*/
export declare function scrollAnimation<Name extends string>(options: ScrollAnimationOptions<Name>): () => void;
//# sourceMappingURL=scrollAnimation.d.ts.map