#3, #4 - Code optimisation

agenceepsilon · Mar 26, 2014 · eac8a5a · eac8a5a
1 parent bb83ed0
commit eac8a5a
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -4,18 +4,26 @@ Easily place your content blocks on top or bottom of the page to scroll.
 
 ## Parameters
 
-| Options       | Types   | Defaults  | Others     |
-| ------------- | ------- | --------- | ---------- |
-| mainClass     | string  | immobilis | Your class |
-| css           | boolean | ``true``  | ``false``  |
-| target        | string  | top       | bottom     |
+| Options       | Types   | Defaults  | Others            |
+| ------------- | ------- | --------- | ----------------- |
+| itemSelector  | string  | immobilis | Choose your class |
+| css           | boolean | ``true``  | ``false``         |
+| target        | string  | "top "    | "bottom"          |
 
 ## Initialize
 
     $(".mobilis").immobilis();
 
 ## Changelogs
 
+### 1.2.0
+
+* Options:
+    * "mainClass" replaced by "itemSelector" ([#3](https://github.com/agenceepsilon/jquery-immobilis/issues/3))
+* Code optimisation:
+    * Code cleaning
+    * outerHeight(); ([#4](https://github.com/agenceepsilon/jquery-immobilis/issues/4))
+
 ### 1.1.1
 
 * innerHeight(); ([#2](https://github.com/agenceepsilon/jquery-immobilis/issues/2))

diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
     "name": "jquery-immobilis",
-    "version": "1.1.1",
+    "version": "1.2.0",
     "description": "Easily place your content blocks on top or bottom of the page to scroll.",
     "main": "jquery.immobilis.js",
     "ignore": [
@@ -15,7 +15,9 @@
     "keywords": [
         "jquery",
         "scroll",
-        "fixed"
+        "fixed",
+        "header",
+        "footer"
     ],
     "licenses": [
         {

diff --git a/immobilis.jquery.json b/immobilis.jquery.json
@@ -2,11 +2,13 @@
     "name": "immobilis",
     "title": "jQuery Immobilis",
     "description": "Easily place your content blocks on top or bottom of the page to scroll.",
-    "version": "1.1.1",
+    "version": "1.2.0",
     "keywords": [
         "jquery",
         "scroll",
-        "fixed"
+        "fixed",
+        "header",
+        "footer"
     ],
     "author": {
         "name": "Boris Damevin",

diff --git a/index.html b/index.html
@@ -10,21 +10,19 @@
         .header {
             background: dodgerblue;
             height: 150px;
-            border-bottom: solid 1px #CCC;
         }
         .nav {
-            background: hotpink;
             height: 30px;
-            border-bottom: solid 1px #CCC;
+            border-top: dashed 1px #CCC;
+            border-bottom: dashed 1px #CCC;
         }
         .main {
             background: #9F00FF;
             height: 1000px;
-            border-bottom: solid 1px #CCC;
         }
         .footer {
-            background: hotpink;
             height: 30px;
+            border-top: dashed 1px #CCC;
         }
         .footer2 {
             height: 50px;
@@ -41,10 +39,7 @@
 <div class="main">
     Main
 </div>
-<div class="footer mobilis-bottom">
-    Footer
-</div>
-<!--<div class="footer2">Footer 2</div>-->
+<div class="footer mobilis-bottom">Footer</div>
 <script src="bower_components/jquery/dist/jquery.js"></script>
 <script src="jquery.immobilis.js"></script>
 <script>

diff --git a/jquery.immobilis.js b/jquery.immobilis.js
@@ -1,99 +1,95 @@
 /*!
- * jQuery Immobilis v1.1.1 (https://github.com/agenceepsilon/jquery-immobilis)
+ * jQuery Immobilis v1.2.0 (https://github.com/agenceepsilon/jquery-immobilis)
  * Copyright 2014 Agence Epsilon.
  * Licensed under MIT (http://www.opensource.org/licenses/mit-license.php)
  */
 
 (function($){
     $.fn.immobilis = function(opts){
         var defaults = {
-            mainClass: "immobilis",
+            itemSelector: "immobilis",
             target: "top",
             css: true
         };
 
         var params = $.extend(defaults, opts);
 
         return this.each(function(){
-            var $mobilisClass = $(this);
-            var $initialPosTop = $mobilisClass.offset().top;
+            var $elem = $(this);
+            var $initialElemPos = $elem.offset().top;
 
-            function cssStyle(){
+            function cssStyle($reset){
                 if(params.css){
-                    if(params.target == "top"){
-                        $mobilisClass.css({
-                            "width": "100%",
-                            "position": "fixed",
-                            "top": 0,
-                            "left": 0
-                        });
-                    } else {
-                        $mobilisClass.css({
-                            "width": "100%",
-                            "position": "fixed",
-                            "top": "auto",
-                            "bottom": "0",
-                            "left": 0
-                        });
-                    }
-                }
-            }
-
-            function cssStyleReset(){
-                if(params.css){
-                    if(params.target == "top"){
-                        $mobilisClass.css({
-                            "width": "",
-                            "position": "",
-                            "top": "",
-                            "left": ""
-                        });
-                    } else {
-                        $mobilisClass.css({
-                            "width": "",
-                            "position": "",
-                            "top": "",
-                            "bottom": "",
-                            "left": ""
-                        });
+                    if($reset !== false){
+                        if(params.target == "top"){
+                            $elem.css({
+                                "width": "100%",
+                                "position": "fixed",
+                                "top": 0,
+                                "left": 0
+                            });
+                        } else{
+                            $elem.css({
+                                "width": "100%",
+                                "position": "fixed",
+                                "bottom": "0",
+                                "left": 0
+                            });
+                        }
+                    } else{
+                        if(params.target == "top"){
+                            $elem.css({
+                                "width": "",
+                                "position": "",
+                                "top": "",
+                                "left": ""
+                            });
+                        } else{
+                            $elem.css({
+                                "width": "",
+                                "position": "",
+                                "bottom": "",
+                                "left": ""
+                            });
+                        }
                     }
                 }
             }
 
             function immobilisTop(){
                 var $scrollTop = $(window).scrollTop();
-                var $mobilisPos = $mobilisClass.offset().top;
-                var $mobilisHeight = $($mobilisClass).innerHeight();
+                var $mobilisPos = $elem.offset().top;
+                var $elemHeight = $($elem).outerHeight();
 
                 if($scrollTop > $mobilisPos){
-                    $mobilisClass.addClass(params.mainClass);
-                    $mobilisClass.next().css("margin-top", $mobilisHeight);
+                    $elem.addClass(params.itemSelector);
+                    $elem.next().css("margin-top", $elemHeight);
 
                     cssStyle();
                 }
-                if($scrollTop < $initialPosTop){
-                    $mobilisClass.removeClass(params.mainClass);
-                    $mobilisClass.next().css("margin-top", "");
+                if($scrollTop < $initialElemPos){
+                    $elem.removeClass(params.itemSelector);
+                    $elem.next().css("margin-top", "");
 
-                    cssStyleReset();
+                    cssStyle(false);
                 }
             }
 
             function immobilisFooter(){
+                var $scrollTop = $(window).scrollTop();
                 var $windowHeight = $(window).height();
                 var $documentHeight = $(document).height();
                 var $heightGap = $documentHeight - $windowHeight;
-                var $scrollTop = $(window).scrollTop();
-                var $mobilisHeight = $($mobilisClass).innerHeight();
+                var $elemHeight = $($elem).outerHeight();
 
                 if($scrollTop >= $heightGap){
-                    $mobilisClass.removeClass(params.mainClass);
-                    $mobilisClass.prev().css("margin-bottom", "");
+                    $elem.removeClass(params.itemSelector);
+                    $elem.prev().css("margin-bottom", "");
 
-                    cssStyleReset();
+                    cssStyle(false);
                 } else{
-                    $mobilisClass.addClass(params.mainClass);
-                    $mobilisClass.prev().css("margin-bottom", $mobilisHeight);
+                    $elem.addClass(params.itemSelector);
+                    $elem.prev().css("margin-bottom", $elemHeight);
 
                     cssStyle();
                 }

diff --git a/jquery.immobilis.min.js b/jquery.immobilis.min.js