mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
78 lines
2.5 KiB
TypeScript
78 lines
2.5 KiB
TypeScript
// Type definitions for rellax 1.7
|
|
// Project: https://github.com/dixonandmoe/rellax, https://dixonandmoe.com/rellax
|
|
// Definitions by: Rostislav Shermenyov <https://github.com/shermendev>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace Rellax {
|
|
interface Rellax {
|
|
/**
|
|
* Inits and starts the Parallax animations
|
|
* @param el Single element or string with selector of elements
|
|
* @param options Options
|
|
*/
|
|
(el?: string | Element, options?: RellaxOptions): RellaxInstance;
|
|
/**
|
|
* Inits and starts the Parallax animations
|
|
* @param el Single element or string with selector of elements
|
|
* @param options Options
|
|
*/
|
|
new (el?: string | Element, options?: RellaxOptions): RellaxInstance;
|
|
}
|
|
|
|
interface RellaxInstance {
|
|
/**
|
|
* End Rellax and reset parallax elements to their original positions
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Rellax elements
|
|
*/
|
|
elms: NodeListOf<Element> | Element[];
|
|
/**
|
|
* Options
|
|
*/
|
|
options: RellaxOptions;
|
|
/**
|
|
* Destroy and create again parallax with previous settings
|
|
*/
|
|
refresh(): void;
|
|
}
|
|
|
|
interface RellaxOptions {
|
|
/**
|
|
* Will run on every animation event
|
|
* @param positions Object with x and y positions of the rellax element
|
|
*/
|
|
callback?(positions: { x: number; y: number }): void;
|
|
/**
|
|
* Enable the ability to center parallax elements in your viewport
|
|
*/
|
|
center?: boolean;
|
|
/**
|
|
* Enable horizontal parallax. This feature is intended for panoramic style websites, where users scroll horizontally instead of vertically
|
|
*/
|
|
horizontal?: boolean;
|
|
/**
|
|
* Allow decimal pixel values
|
|
*/
|
|
round?: boolean;
|
|
/**
|
|
* A negative value will make it move slower than regular scrolling, and a positive value will make it move faster
|
|
*/
|
|
speed?: number;
|
|
/**
|
|
* Enable vertical parallax
|
|
*/
|
|
vertical?: boolean;
|
|
/**
|
|
* By default, the position of parallax elements is determined via the scroll position of the body. Passing in the wrapper property will tell Rellax to watch that element instead
|
|
*/
|
|
wrapper?: string;
|
|
}
|
|
}
|
|
|
|
declare const Rellax: Rellax.Rellax;
|
|
|
|
export = Rellax;
|
|
export as namespace Rellax;
|