From: SassNinja <kai.falkowski@gmail.com>
Date: Wed, 14 Jun 2017 15:59:13 +0000 (+0200)
Subject: Remove content classes on close, fix transitionend listener & set default transform... 
X-Git-Tag: v6.4.0-rc5~9^2~7
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c35d8ec9ec5b43a8f801d6c115e60afa39101c9e;p=thirdparty%2Ffoundation%2Ffoundation-sites.git

Remove content classes on close, fix transitionend listener & set default transform none for content

Now the content container has none transform by default so position fixed works as soon as an push off-canvas is closed.
Besides the transitionend listener is now fixed so it isn't bound to only the content or the element but to both of them.
The content classes specification is now part of the setup (this.contentClasses) for an improved readability.
---

diff --git a/js/foundation.offcanvas.js b/js/foundation.offcanvas.js
index 23d6ad8de..9d7a90ea8 100644
--- a/js/foundation.offcanvas.js
+++ b/js/foundation.offcanvas.js
@@ -27,13 +27,23 @@ class OffCanvas extends Plugin {
   _setup(element, options) {
     this.$element = element;
     this.options = $.extend({}, OffCanvas.defaults, this.$element.data(), options);
+    this.contentClasses = [];
     this.$lastTrigger = $();
     this.$triggers = $();
     this.position = 'left';
     this.$content = $();
     this.nested = !!(this.options.nested);
 
-    //Triggers init is idempotent, just need to make sure it is initialized
+    // Defines the CSS transition/position classes of the off-canvas content container.
+    $(['push', 'overlap']).each((index, val) => {
+      this.contentClasses.push('has-transition-'+val);
+    });
+    $(['left', 'right', 'top', 'bottom']).each((index, val) => {
+      this.contentClasses.push('has-position-'+val);
+      this.contentClasses.push('has-reveal-'+val);
+    });
+
+    // Triggers init is idempotent, just need to make sure it is initialized
     Triggers.init($);
 
     this._init();
@@ -79,11 +89,9 @@ class OffCanvas extends Plugin {
       this.options.transition = 'overlap';
       // Remove appropriate classes if already assigned in markup
       this.$element.removeClass('is-transition-push');
-      this.$content.removeClass('has-transition-push');
     }
 
     this.$element.addClass(`is-transition-${this.options.transition} is-closed`);
-    this.$content.addClass(`has-transition-${this.options.transition}`);
 
     // Find triggers that affect this element and add aria-expanded to them
     this.$triggers = $(document)
@@ -118,7 +126,8 @@ class OffCanvas extends Plugin {
       this.$element.css('transition-duration', this.options.transitionTime);
     }
 
-    this._setContentClasses();
+    // Initally remove all transition/position CSS classes from off-canvas content container.
+    this._removeContentClasses();
   }
 
   /**
@@ -161,19 +170,25 @@ class OffCanvas extends Plugin {
   }
 
   /**
-   * Sets the CSS transition/position classes of the off-canvas content container.
+   * Removes the CSS transition/position classes of the off-canvas content container.
    * Removing the classes is important when another off-canvas gets opened that uses the same content container.
-   * @param {Boolean} hasReveal - true if related off-canvas element is revealed.
    * @private
    */
-  _setContentClasses(hasReveal) {
-    this.$content
-      .removeClass('has-transition-push has-transition-overlap has-position-left has-position-top has-position-right has-position-bottom has-reveal-left has-reveal-top has-reveal-right has-reveal-bottom')
-      .addClass(`has-transition-${this.options.transition} has-position-${this.position}`);
+  _removeContentClasses() {
+    this.$content.removeClass(this.contentClasses.join(' '));
+  }
 
+  /**
+   * Adds the CSS transition/position classes of the off-canvas content container, based on the opening off-canvas element.
+   * Beforehand any transition/position class gets removed.
+   * @param {Boolean} hasReveal - true if related off-canvas element is revealed.
+   * @private
+   */
+  _addContentClasses(hasReveal) {
+    this._removeContentClasses();
+    this.$content.addClass(`has-transition-${this.options.transition} has-position-${this.position}`);
     if (hasReveal === true) {
-      this.$content
-        .addClass(`has-reveal-${this.position}`);
+      this.$content.addClass(`has-reveal-${this.position}`);
     }
   }
 
@@ -203,7 +218,7 @@ class OffCanvas extends Plugin {
         $closer.show();
       }
     }
-    this._setContentClasses(isRevealed);
+    this._addContentClasses(isRevealed);
   }
 
   /**
@@ -321,7 +336,7 @@ class OffCanvas extends Plugin {
       Keyboard.trapFocus(this.$element);
     }
 
-    this._setContentClasses();
+    this._addContentClasses();
   }
 
   /**
@@ -368,12 +383,22 @@ class OffCanvas extends Plugin {
       Keyboard.releaseFocus(this.$element);
     }
 
-    // Listen to transitionEnd of content container and add class when done.
-    // The listener is not assigned to the off-canvas element itself because it doesn't transform if nested (push).
-    this.$content.on(Foundation.transitionend(this.$content), function(e) {
+    // Listen to transitionEnd  and add class when done.
+    // Listening to both, element and content, is required because they don't always transform together (e.g. on nested push transition).
+    this.$content.one(Foundation.transitionend(this.$content), function(e) {
+      if (e.originalEvent.propertyName.match(/transform/i)) {
+        _this.$element.off(Foundation.transitionend(this.$content)); // unbind $element listener since it hasn't transformed
+        _this.$element.addClass('is-closed');
+        _this.$content.off(Foundation.transitionend(_this.$content));
+        _this._removeContentClasses();
+      }
+    });
+    this.$element.one(Foundation.transitionend(this.$element), function(e) {
       if (e.originalEvent.propertyName.match(/transform/i)) {
+        _this.$content.off(Foundation.transitionend(this.$element)); // unbind $content listener since it hasn't transformed
         _this.$element.addClass('is-closed');
         _this.$content.off(Foundation.transitionend(_this.$content));
+        _this._removeContentClasses();
       }
     });
   }
diff --git a/scss/components/_off-canvas.scss b/scss/components/_off-canvas.scss
index 68cae8037..ba5e7e900 100644
--- a/scss/components/_off-canvas.scss
+++ b/scss/components/_off-canvas.scss
@@ -287,17 +287,18 @@ $maincontent-class: 'off-canvas-content' !default;
     }    
   }
 
-  // No transform on overlap transition
-  @at-root .#{$maincontent-class}.has-transition-overlap {
-    transform: none;
-  }
 }
 
 /// Sets the styles for the content container.
 @mixin off-canvas-content() {
-  transform: translate(0, 0);
+  transform: none;
   transition: transform $offcanvas-transition-length $offcanvas-transition-timing;
   backface-visibility: hidden;
+
+  // Preserve transform none on overlap transition (override position based translate)
+  &.has-transition-overlap {
+    transform: none;
+  }
 }
 
 /// Adds styles that reveal an off-canvas panel.