rytm-webflow 2.0.7 → 2.0.9

package/README.md

@@ -250,7 +250,7 @@ Animate any element within the *WebflowView* container using the **Webflow synta
 ```
 or (more complex example):
 ```html
-<div data-webview-initial="x:-10,y:50" data-webview-show="x:0,y:0,t:.5,d:.15,e:Power2.easeOut" data-webview-hide="x:10,y:-25,t:.4,d:.2,e:Power2.easeIn">
+<div data-webview-initial="x:-10,y:50" data-webview-show="x:0,y:0,t:.5,d:.15,e:power3.out" data-webview-hide="x:10,y:-25,t:.4,d:.2,e:power2.in">
   ...
 </div>
 ```
@@ -300,7 +300,7 @@ To implement ShowUp on your HTML add a `data-webflow` or `data-webpara` attribut
 Add easing for your animations
 ```html
 <!-- gsap easing -->
-<div data-webflow="x:-10vw,t:.5,e:Expo.easeOut">...</div>
+<div data-webflow="x:-10vw,t:.5,e:expo.out">...</div>
 ```
 Delay animations
 ```html
@@ -387,7 +387,7 @@ Examples:
 <h1>Webflow show up</h1>
 <div data-webflow="t:.4,o:0,y:10;t:.4,o:0,y:-30">Webflow Simple ALPHA no delay</div>
 <div data-webflow="t:.4,o:0,s:.4;t:.4,o:0,s:1.5">Webflow Scale</div>
-<div data-webflow="t:1.4,x:-300,e:Expo.easeOut;t:.4,d:0,x:-100,e:Expo.easeIn" data-webset="offset:100">Webflow Offset: 100, Ease EXPO</div>
+<div data-webflow="t:1.4,x:-300,e:expo.out;t:.4,d:0,x:-100,e:expo.in" data-webset="offset:100">Webflow Offset: 100, Ease EXPO</div>
 <div data-webflow="t:1.4,x:-100vw;t:.4,d:0,x:-250" data-webset="offset:center">Webflow Offset: center</div>
 <div data-webflow="t:1.4,x:-250;t:.4,d:0,x:-250" data-webset="offset:top">Webflow offset: TOP</div>
 <div data-webflow="t:1.4,x:-250,w:10;t:.4,d:0,x:-250" data-webset="trigger:#boom">Webflow Triggered by next BLOCK</div>
@@ -395,7 +395,7 @@ Examples:
 <!-- ### Webflow Parallax ### -->
 <h1>Webflow parallax</h1>
 <div data-webpara="x:400" data-webset="duration:100%">Parallax duration 100%</div>
-<div data-webpara="x:400,e:Back.easeOut" data-webset="duration:40vh">Parallax  duration 40vh, ease: Back</div>
+<div data-webpara="x:400,e:back.out" data-webset="duration:40vh">Parallax  duration 40vh, ease: Back</div>
 <div >parent TRIGGER
   <div data-webpara="y:-500,r:180" data-webset="duration:100%,trigger:parent">Parallax Y</div>
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rytm-webflow",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "rytm webflow pack - ASwap, ShowUp",
   "main": "scripts/index.js",
   "scripts": {

package/scripts/aswap/WebflowView.js

@@ -0,0 +1,286 @@
+import ScrollMagic from 'scrollmagic';
+import gsap from 'gsap';
+import View from './View';
+import scrollController from './../showup/ScrollController';
+import { getWebflowAnimationProps, parseProps } from './../lib/dataTweenParser';
+import { getScrollMagicSceneProps } from './../lib/dataScrollMagicParser';
+
+// data-webview-... (aswap show / hide)
+const DATA_ATTR_WEBVIEW_INIT = "webview-initial";
+const DATA_ATTR_WEBVIEW_SHOW = "webview-show";
+const DATA_ATTR_WEBVIEW_HIDE = "webview-hide";
+// data-webscroll-... (scroll magic)
+const DATA_ATTR_WEBSCROLL_INIT = "webscroll-initial";
+const DATA_ATTR_WEBSCROLL_SHOW = "webscroll-show";
+const DATA_ATTR_WEBSCROLL_HIDE = "webscroll-hide";
+// data-stagger-... (stagger - lists)
+const DATA_ATTR_STAGGER_INIT = "stagger-initial";
+const DATA_ATTR_STAGGER_SHOW = "stagger-show";
+const DATA_ATTR_STAGGER_HIDE = "stagger-hide";
+const DATA_ATTR_SETUP = "webset";
+
+class WebflowView extends View {
+
+  constructor(id) {
+    super(id);
+    this.scenes = [];
+  }
+  /**
+  * prepare (before show)
+  **/
+  prepare(container) {
+    super.prepare(container);
+  }
+  /**
+  * animate in (show)
+  **/  
+  show(container) {
+    super.show(container);
+    this.container = container;
+    // show Aswap webviews
+    this.webViewsShow();
+    // show stagger elements
+    this.staggerShow();
+    // build scrollmagic scenes
+    this.buildScrollmagicScenes();
+    // add event listeners
+    this.addEventListeners();
+  }
+  /**
+  * animate out (hide)
+  **/
+  hide(container) {
+    super.hide(container);
+    // hide Aswap webviews
+    this.webViewsHide();
+    // hide stagger elements
+    this.staggerHide();
+    // hide scrollmagic scenes
+    this.hideScrollmagicScenes();
+  }
+  /**
+  * animate out (hide)
+  **/
+  hidden(container) {
+    super.hidden(container);
+    this.removeEventListeners();
+    this.destroyScenes();
+  }
+  /**
+   * ##################
+   * ### DOM events ###
+   * ##################
+   */
+  /**
+   * Class event handlers
+   */
+  handleEvent(e) {
+    switch (e.type) {
+      case 'resize':
+        this.onWindowUpdate(e);
+        break;
+      case 'DOMContentLoaded':
+        this.onWindowUpdate(e);
+        break;
+    }
+  }
+  /**
+   * Add event listeners
+   */
+  addEventListeners() {
+    window.addEventListener('resize', this);
+    document.addEventListener('DOMContentLoaded', this);
+  }
+  /**
+   * Remove event listeners
+   */
+  removeEventListeners() {
+    window.removeEventListener('resize', this);
+    document.removeEventListener('DOMContentLoaded', this);
+  }
+  onWindowUpdate(e) {
+    if (this.scenes.length > 0) {
+      scrollController.refresh();
+    }
+  }
+  /**
+   * ############
+   * ### SHOW ###
+   * ############
+   */
+  // ### ASwap Show / Hide ###
+  // show webviews
+  webViewsShow() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_WEBVIEW_SHOW + ']')];
+    list.forEach(this.webViewElementShow.bind(this));
+  }
+  // showe webview element
+  webViewElementShow(el, index) {
+    const propsInitial = this.getTweenProps(el, DATA_ATTR_WEBVIEW_INIT);
+    const propsShow = this.getTweenProps(el, DATA_ATTR_WEBVIEW_SHOW);
+    if (propsInitial && propsShow) {
+      gsap.killTweensOf(el);
+      gsap.set(el, {...propsInitial.tween});
+      gsap.to(el, {duration: propsShow.time, ...propsShow.tween});
+    }
+  }
+  // ### Stagger ###
+  // Stagger (lists) show
+  staggerShow() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_STAGGER_SHOW + ']')];
+    list.forEach(this.staggerListShow.bind(this));
+  }
+  staggerListShow(el, index) {
+    const { selector } = parseProps(el.dataset[DATA_ATTR_SETUP]);
+    if (!selector)  {
+      console.warn("Unknown selector for webflow stagger", el);
+      return;
+    }
+    const items = [...el.querySelectorAll(selector)];
+    const propsInit = this.getTweenProps(el, DATA_ATTR_STAGGER_INIT);
+    const propsShow = this.getTweenProps(el, DATA_ATTR_STAGGER_SHOW);
+    if (items.length && propsInit && propsShow) {
+      gsap.killTweensOf(items);
+      gsap.set(items, {...propsInit.tween});
+      gsap.to(items, {duration: propsShow.time, ...propsShow.tween});
+    }
+  }
+  // ### ScrollMagic ###
+  /**
+   * Build scenes for scrollmagic
+   */
+  buildScrollmagicScenes() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_WEBSCROLL_SHOW + ']')];
+    list.forEach(this.buildScrollmagicScene.bind(this));
+  }
+  /**
+   * Build scroll magic scene
+   * @param {DOM} el 
+   * @param {Int} index 
+   */
+  buildScrollmagicScene(el, index) {
+    const propsInitial = this.getTweenProps(el, DATA_ATTR_WEBSCROLL_INIT);
+    const propsShow = this.getTweenProps(el, DATA_ATTR_WEBSCROLL_SHOW);
+    const setup = parseProps(el.dataset[DATA_ATTR_SETUP]);
+    if (propsInitial && propsShow) {
+      const smsp = getScrollMagicSceneProps(el, setup);
+      const scene = new ScrollMagic.Scene(smsp);
+      scene.on("start", (e) => {
+        if (e.scrollDirection === "FORWARD") {
+          gsap.killTweensOf(el);
+          gsap.set(el, {...propsInitial.tween});
+          gsap.to(el, {duration: propsShow.time, ...propsShow.tween});
+        }
+      });
+      scene.addTo(scrollController.get());
+      this.scenes.push(scene);
+    }
+  }
+  /**
+   * ############
+   * ### HIDE ###
+   * ############
+   */
+  // ### ASwap Show / Hide ###
+  // hide webviews
+  webViewsHide() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_WEBVIEW_HIDE + ']')];
+    list.forEach(this.webViewsElementHide.bind(this));
+  }
+  // showe webview element
+  webViewsElementHide(el, index) {
+    const propsHide = this.getTweenProps(el, DATA_ATTR_WEBVIEW_HIDE);
+    if (propsHide) {
+      gsap.killTweensOf(el);
+      gsap.to(el, {duration: propsHide.time, ...propsHide.tween});
+    }
+  }
+  // ### Stagger ###
+  // Hide stagger
+  staggerHide() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_STAGGER_HIDE + ']')];
+    list.forEach(this.staggerListHide.bind(this));
+  }
+  // Hide stagger element
+  staggerListHide(el, index) {
+    const { selector } = parseProps(el.dataset[DATA_ATTR_SETUP]);
+    if (!selector)  {
+      console.warn("Unknown selector for webflow stagger", el);
+      return;
+    }
+    const items = [...el.querySelectorAll(selector)];
+    const propsHide = this.getTweenProps(el, DATA_ATTR_STAGGER_HIDE);
+    if (items.length && propsHide) {
+      gsap.killTweensOf(items);
+      gsap.to(items, {duration: propsHide.time, ...propsHide.tween});
+    }
+  }
+  // ### ScrollMagic ###
+  /**
+   * hide scenes
+   */
+  hideScrollmagicScenes() {
+    if (!this.container) {
+      console.warn("Unknown container", this);
+      return;
+    }
+    const list = [...this.container.querySelectorAll('*[data-' + DATA_ATTR_WEBSCROLL_HIDE + ']')];
+    list.forEach(this.hideScrollmagicElement.bind(this));
+  }
+  /**
+   * Hide element
+   * @param {DOM} el 
+   * @param {Int} index 
+   */
+  hideScrollmagicElement(el, index) {
+    const propsHide = this.getTweenProps(el, DATA_ATTR_WEBSCROLL_HIDE);
+    if (propsHide) {
+      gsap.killTweensOf(el);
+      gsap.to(el, { duration: propsHide.time, ...propsHide.tween});
+    }
+  }
+  // ## Destroy scrollmagic scenes
+  destroyScenes() {
+    this.scenes.forEach((scene) => {
+      scene.destroy();
+      scene = null;
+    })
+    this.scenes = [];
+  }
+  /**
+   * ###############
+   * ### HELPERS ###
+   * ###############
+   */
+  // get animation props
+  getTweenProps(el, name) {
+    const dataAttrName = this.getDataAttributeName(name);
+    return getWebflowAnimationProps(el.dataset[dataAttrName]);
+  }
+  // replace data-x with dataX
+  getDataAttributeName(name) {
+    return name.replace(/-([a-z])/g, function (g) { return g[1].toUpperCase(); });
+  }
+
+}
+export default WebflowView

package/scripts/index.js

@@ -2,6 +2,7 @@ import aswapInstance from './aswap/ASwap'
 import Controller from './aswap/Controller'
 import ControllerImgLoad from './aswap/ControllerImgLoad'
 import View from './aswap/View'
+import WebflowView from './aswap/WebflowView'
 // Bootstrap v5 helper
 import bootsrap5 from './bootstrap/v5/Bootstrap5'
 // showup
@@ -15,6 +16,7 @@ export default {
   Controller,
   ControllerImgLoad,
   View,
+  WebflowView,
   // boottstrap
   bootsrap5,
   // showup

package/scripts/lib/dataTweenParser.js

@@ -145,7 +145,10 @@ const translateNonNumericValue = (key, valStr) => {
   let val
   switch (key) {
     case 'ease':
-      val = getWebflowEasing(valStr)
+      // old syntax: 'Back.easeOut'
+      val = getWebflowEasing(valStr);
+      // new syntax, eg.: 'back.out'
+      val = val ? val : valStr;
       break;
     default:
       // by default don't change anything (eg. '100%', '50vw')
@@ -155,6 +158,7 @@ const translateNonNumericValue = (key, valStr) => {
   return val
 }
 /**
+ * ### Depreciated (use string values insted, eg "e:back.out")
  * Get the TweenMax Easing function
  * @param {string} str 
  * @return {Ease}