debug |
boolean
|
Whether to print debug messages in
the browser console. |
slug |
boolean
|
A special codename for the instance
of the element, to be used as a
class on its container and as a key
in arrays where it is grouped with
other elements of its kind. |
watch |
string
|
The element to watch. This is the
element which is watched by the
module as it enters, crosses and
eventually leaves the viewport. The
parallax effect starts when the
watched element enters the viewport
and finishes when the watched
element leaves the viewport. |
properties |
Object
|
In the case where the parallaxed
element is the watched element
itself this associative array
represents the CSS properties of it
that will be affected by the
parallax effect and their initial
and final values. |
elements |
Object
|
In the case where the parallaxed
element(s) are different from the
watched element this associative
array represents these elements
along with their CSS properties
which are to be affected by the
parallax effect. It may be either a
single element or an array of
elements. |
throttle |
integer
|
Duration in milliseconds to
throttle the scroll event, so that
the modulescroll callbacks are not
called on each and every browser
scroll event. |
duration |
integer
|
The duration of the animation of
the transition of the CSS
properties that are to be
parallaxed. |
offsetTop |
integer
|
How much to delay the parallax
effect in terms of space, after the
watched element has appeared in the
browser viewport. |
offsetBottom |
integer
|
How much to make completion faster
in terms of space for the parallax
effect. |
onAppear |
mixed
|
Function callback to trigger or
class to add when the watched
element appears in the browser
viewport. |
onDisappear |
mixed
|
Function callback to trigger or
class to add when the watched
element disappears from the browser
viewport. |
runOnce |
boolean
|
If true, then the what the parallax
functionality will only run once as
the user scrolls up and down the
and will not be reversed or run
again after it has completed.
Defaults to false. |
enter |
string
|
Comma separated list of breakpoints
in which the parallax enters,
which means it is enabled. |
leave |
string
|
Comma separated list of breakpoints
in which the parallax leaves, which
means it is disabled. |