The module introduces several Angular directives and services to do scrolling sorcery in Angular-friendly, declarative way: ...
Instead of jQuery-fashioned, harder to maintain code: ...
Even if the full power of ScrollMagic is demanded for some serious black arts, ScrollMagic API is available through Angular services.
The stage behind the sequence of scenes which does no actions and holds no logic. Known as controller in ScrollMagic but renamed to stage in ng-magics to match its role better and avoid confusion with Angular controllers (it even asked for that in person).
It defines root element for the act (any container, but, more frequently,
window) and the axis of scrolling. All the relevant scenes are attached to it, the controller also defines default settings for them.
The stage holds global information (current position, direction, container) about the stage. There's not much to say about it besides that.
The place where the magic happens in ScrollMagic. The scene triggers events on its beginning, continuation and finale, any sort of change (likely visual) can be caused by them.
ScrollMagic doesn't perform any visual effects by itself, they have to be implemented by either CSS3 classes or third-party animation library (*TweenMax* or TweenLite).
A scene may be some abstract start point and have no end, but ng-magics
magics-scene directive limits the scene to the bounds of specific DOM element.
Fixes the element in viewport during the current scene, until it is unpinned manually, or the scene is over. While ScrollMagic can pin an arbitrary element, ng-magics
magics-pin directive is supposed to pin only scene's children.
The concept of scene spies is specific to ng-magics. A spy directive,
magics-pin binds scope properties to the events ('enter', 'leave' and 'progress') of the relevant scene.
It also depends on GreenSock TweenMax or TweenLite libraries (
TweenLite global) and their ScrollToPlugin plugin for ScrollMagic animations, one of the libraries should be loaded before ScrollMagic.
Creates a new scene or reuses the existing one
on either the stage specified by
magicsStage directive or 'default' stage.
- as attribute: ...
| Param | Type | Details | | :--: | :--: | :--: | | magicsScene(optional) | string | Scene name. | | magicsSceneOptions(optional) | Object | Options that are used on scene creation. |
Sets up a spy for the scene specified
by either parent
magicsScene directive or
- as attribute:
| Param | Type | Details | | :--: | :--: | :--: | | magicsSpy(optional) | expression | Scope variable flag (read-only). | | magicsSpyScene(optional) | string | Scene name. | | magicsSpyProgress(optional) | expression | Scene progress callback function. |
Creates a new stage or reuses the existing one.
- as attribute:
[magics-stage="string"] [magics-stage-options="Object"]> ...
| Param | Type | Details | | :--: | :--: | :--: | | magicsStage(optional) | string | Stage name. | | magicsStageOptions(optional) | Object | Options that have to be passed to magics.stage. |
A demo is available, it briefly depicts the features and the concepts behind the module.