Optional
actThe element to instantiate all actions on this trigger for.
The element on which the Trigger is defined
Optional
delayDelay in milliseconds before doing, undoing or toggling actions.
Optional
directionsThe XYDirections to use as the trigger. See also OnScrollOptions
Actions will be "done" when the scroll direction is one of the given ones and "undone" when it's the opposite direction. E.g. for "up" the opposite is "down".
Optional
doDelay in milliseconds before doing actions.
Optional
idAn ID for the trigger so that it can be looked up by ID. It has to be unique for each element, but you can use the same ID on different elements.
Optional
onceIf true, the trigger will run at most once. This will result in the run
or toggle
methods removing all three of run
, reverse
and toggle
when called, so that the actions are done at most once.
Optional
oneIf true, then the reverse
method of the trigger will do nothing and the
toggle
method will always do the actions, i.e. will be equivalent to
run
.
Optional
scrollableThe scrolling element target to use for the ScrollWatcher. See OnScrollOptions
ScrollWatcher default, the main scrolling element
Optional
thresholdThe scroll threshold to pass to the ScrollWatcher. See also OnScrollOptions
ScrollWatcher default
Optional
undoDelay in milliseconds before undoing actions.