UNPKG

declarations

Version:

[![npm version](https://badge.fury.io/js/declarations.svg)](https://www.npmjs.com/package/declarations)

37 lines (29 loc) 1.21 kB
// Type definitions for scroll-into-view 1.6.0 // Project: https://github.com/KoryNunn/scroll-into-view // Definitions by: zivni https://github.com/zivni // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare module __ScrollIntoView { interface Settings { time?: number ease?: (value: number) => number validTarget?: (target: HTMLElement, parentsScrolled: number) => boolean align?: Alignment } interface Alignment { /** 0 to 1, default 0.5 (center) */ top?: number /** 0 to 1, default 0.5 (center) */ left?: number } /** type will be 'complete' if the scroll completed or 'canceled' if the current scroll was canceled by a new scroll */ type callbackParamterType = "complete" | "canceled" type Callback = (type: callbackParamterType) => void interface ScrollIntoView { (target: HTMLElement, callback?: __ScrollIntoView.Callback) : void (target: HTMLElement, settings: __ScrollIntoView.Settings, callback?: __ScrollIntoView.Callback) : void } } declare module "scroll-into-view" { var scrollIntoView: __ScrollIntoView.ScrollIntoView export = scrollIntoView; }