windups/dist/react/WindupChildren.d.ts

A unique typewriter effect library for React.

import * as React from "react";
import { Windup } from "../Windup";
import { HookMetadata } from "./useWindup";
export declare function useSkip(): () => void;
export declare function usePause(): () => void;
export declare function useResume(): () => void;
export declare function useRewind(): () => void;
export declare function useIsFinished(): boolean;
export interface ChildrenMetadata extends HookMetadata {
    element: React.ElementType | string | undefined;
    props?: any;
    ref?: any;
    key?: string | number | null;
}
export declare type ChildrenWindup = Windup<string, ChildrenMetadata>;
declare type WindupChildrenProps = {
    children: React.ReactNode;
    onFinished?: () => void;
    skipped?: boolean;
    isPaused?: boolean;
};
declare const WindupChildren: React.FC<WindupChildrenProps>;
export default WindupChildren;