mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
37 lines
1.2 KiB
TypeScript
37 lines
1.2 KiB
TypeScript
// 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 callbackParameterType = "complete" | "canceled"
|
|
type Callback = (type: callbackParameterType) => 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;
|
|
}
|