kaioken-gsap
Version:
Tools for using GSAP in Kaioken, like useGSAP() which is a drop-in replacement for useLayoutEffect()/useEffect()
24 lines (23 loc) • 950 B
TypeScript
/**
* @fileoverview Tools for using GSAP in Kaioken, like useGSAP() which is a drop-in replacement for useLayoutEffect()/useEffect()
* @version 1.0.0
* @license ISC
* Based on the work of Jack Doyle, jack@greensock.com - (https://github.com/greensock/react/blob/main/src/index.js)
*/
type ContextSafeFunc = <T extends Function>(func: T) => T;
type ContextFunc = (context: gsap.Context, contextSafe: ContextSafeFunc) => Function | any | void;
export type UseGSAPReturn = {
context: gsap.Context;
contextSafe: ContextSafeFunc;
};
export type UseGSAPConfig = {
scope?: Kaioken.MutableRefObject<Element | null> | Element | string;
dependencies?: unknown[];
revertOnUpdate?: boolean;
};
export declare function useGSAP(callback?: ContextFunc | UseGSAPConfig, dependencies?: unknown[] | UseGSAPConfig): UseGSAPReturn;
export declare namespace useGSAP {
var register: (core: any) => any;
var headless: boolean;
}
export {};