typeit/dist/types.d.ts

The most versatile animated typing utility on the planet.

export type Character = {
    node: El | null;
    content: string | Node;
};
export interface CursorAnimationOptions {
    frames?: AnimationKeyFrame[];
    options?: Partial<AnimationEffectTiming>;
}
export interface CursorOptions {
    autoPause?: boolean;
    autoPauseDelay?: number;
    animation?: CursorAnimationOptions;
}
export interface Options {
    breakLines?: boolean;
    cursorChar?: string;
    cursor?: CursorOptions | boolean;
    cursorSpeed?: number;
    deleteSpeed?: null | number;
    html?: boolean;
    lifeLike?: boolean;
    loop?: boolean;
    loopDelay?: number | number[];
    nextStringDelay?: number | number[];
    speed?: number;
    startDelay?: number;
    startDelete?: boolean;
    strings?: string[] | string;
    waitUntilVisible?: boolean;
    beforeString?: Function;
    afterString?: Function;
    beforeStep?: Function;
    afterStep?: Function;
    afterComplete?: Function;
}
export interface Statuses {
    started: boolean;
    completed: boolean;
    frozen: boolean;
    destroyed: boolean;
    firing: boolean;
}
export type ActionOpts = Options & {
    to?: Sides;
    instant?: boolean;
    delay?: number;
};
export type QueueItem = {
    done?: boolean;
    func?: () => any;
    delay?: number;
    char?: any;
    typeable?: boolean;
    deletable?: boolean;
    cursorable?: boolean;
    shouldPauseCursor?: () => boolean;
};
export type QueueMapPair = [Symbol, QueueItem];
export type El = (HTMLElement | HTMLInputElement) & {
    originalParent?: HTMLElement;
};
export type Sides = "START" | "END";