canvas-scroll-clip/dist/tsc/main.d.ts

Canvas based image sequence scroll animation. Zero dependencies.

import { NoopFunction, IUserInputs } from "./helpers/intefaces";
import Canvas from "./common/canvas";
/**
 * @module
 * CanvasClip.js
 */
interface IMain {
    callback: NoopFunction;
}
/**
 * @class Main class
 */
declare class Main extends Canvas implements IMain {
    /**
     * This callback is called when the class is loaded
     *
     * @callback CallbackFunction
     */
    callback: NoopFunction;
    /**
     * An instance of App.js.
     *
     * @constructor
     * @param {String} class name of an HTML element.
     * @param {function} Callback function
     * @memberof Main
     */
    constructor(element: HTMLElement, options: IUserInputs, callback?: NoopFunction);
    /**
     * Hidden in order not to display this method in docs
     * Initializes in constructor
     */
    private init;
}
export default Main;