animare
Version:
Advanced animation library for modern JavaScript.
24 lines • 781 B
TypeScript
/// <reference types="react" />
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 scrollAnim = useAnimare(() => {
* // ...
* });
*
* useScrollAnimation({
* timeline: scrollAnim,
* element: document.querySelector<HTMLDivElement>('.block')!,
* start: ScrollElementEdge.Bottom,
* end: ScrollElementEdge.Top,
* startOffset: 100,
* });
*/
export declare function useScrollAnimation<Name extends string>(options: ScrollAnimationOptions<Name>, deps?: React.DependencyList): void;
//# sourceMappingURL=useScrollAnimation.d.ts.map