HypeScrollMagic (main) doxdox documentation

A streamlined tool for synchronizing and managing nested timelines in response to scroll events, designed for use with Tumult Hype 4. This utility facilitates the control of animation timelines, allowing them to play forward or reverse in sync with the user's scroll position.

# addScrollTimeline(hypeDocument, element, timelineName, options)

Parameters

Name Types Description
hypeDocument object - the current Hype document
element HTMLElement - the element to add the scroll timeline to
timelineName string - the name of the timeline
options object - the options for the timeline

# debounceByRequestFrame(fn)

Parameters

Name Types Description
fn function - the function to be debounced

# getDefault(key)

This function returns the value of a default by key or all default if no key is given

Parameters

Name Types Description
key String This the key of the default.

Returns

Returns the current value for a default with a certain key.

# getSymbolInstance(hypeDocument, element)

Parameters

Name Types Description
hypeDocument object - the current Hype document
element HTMLElement - the element to get the symbol instance for

# setDefault(key, value)

This function allows to override a global default by key or if a object is given as key to override all default at once

Parameters

Name Types Description
key String This is the key to override
value String Function

# Scene.removeIndicators()

Removes visual indicators from a ScrollMagic.Scene.