Skip to content

Typescript definition#14

Open
romain-preston wants to merge 1 commit intozengabor:distfrom
romain-preston:typescript-typedef
Open

Typescript definition#14
romain-preston wants to merge 1 commit intozengabor:distfrom
romain-preston:typescript-typedef

Conversation

@romain-preston
Copy link

Here a simple typescript definition for the class, it comes handy in a typescript and module/AMD environment.

@zengabor
Copy link
Owner

Thank you very much

@zivni
Copy link

zivni commented Jul 4, 2016

To be used with import * as zenscroll from "zenscroll"
I think the typing should be in modules like so:

declare module ZenScroll {

    interface ZenScrollBase {

        to(element: HTMLElement);
        to(element: HTMLElement, duration: number);
        to(element: HTMLElement, duration: number, onDone: () => void);

        toY(y: number);
        toY(y: number, duration: number);
        toY(y: number, duration: number, onDone: () => void);


        center(element: HTMLElement);
        center(element: HTMLElement, duration: number);
        center(element: HTMLElement, duration: number, offset: number);
        center(element: HTMLElement, duration: number, offset: number, onDone: () => void);



        moving(): boolean;

        stop();

        setup(duration: number);
        setup(duration: number, offset: number);
    }

    interface ZenScroll extends ZenScrollBase {
        createScroller(element: HTMLElement, duration: number, offset: number): ZenScrollBase;

        intoView(element: HTMLElement);
    }
}

declare module "zenscroll" {
    var zenscroll: ZenScroll.ZenScroll;
    export = zenscroll;
}

@Nixuge
Copy link

Nixuge commented Jul 20, 2024

Is there a reason why this isn't merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants