first run page redesign

chrome/content/ui/firstRun.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2013 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
 (function()
 {
-  var shade;
-  var scrollTimer;
-
   // Load subscriptions for features
   var featureSubscriptions = [
     {
       feature: "malware",
       homepage: "http://malwaredomains.com/",
       title: "Malware Domains",
       url: "https://easylist-downloads.adblockplus.org/malwaredomains_full.txt"
     },
     {
       feature: "social",
       homepage: "https://www.fanboy.co.nz/",
       title: "Fanboy's Social Blocking List",
       url: "https://easylist-downloads.adblockplus.org/fanboy-social.txt"
     },
     {
       feature: "tracking",
       homepage: "https://easylist.adblockplus.org/",
       title: "EasyPrivacy",
       url: "https://easylist-downloads.adblockplus.org/easyprivacy.txt"
     }
   ];
 
   function onDOMLoaded()
   {
+    // Set up URL

[Wladimir Palant, 2013/10/02 13:21:39]

URL => URLs

+    var donateLink = E("donate");
+    donateLink.href = Utils.getDocLink("donate");
+    
+    var contributors = E("contributors");
+    contributors.href = Utils.getDocLink("contributors");
+    
+    setLinks("acceptableAdsExplanation", Utils.getDocLink("acceptable_ads_criteria"), openFilters);
+    setLinks("share-headline", Utils.getDocLink("contribute"));
+    
     // Show warning if data corruption was detected
     if (typeof backgroundPage != "undefined" && backgroundPage.seenDataCorruption)
     {
       E("dataCorruptionWarning").removeAttribute("hidden");
       setLinks("dataCorruptionWarning", Utils.getDocLink("knownIssuesChrome_filterstorage"));
     }
 
-    // Set up URL
-    setLinks("acceptableAdsExplanation", Utils.getDocLink("acceptable_ads_criteria"), openFilters);
-
-    shade = E("shade");
-    shade.addEventListener("mouseover", scrollPage, false);
-    shade.addEventListener("mouseout", stopScroll, false);
-
     // Set up feature buttons linked to subscriptions
     featureSubscriptions.forEach(setToggleSubscriptionButton);
     var filterListener = function(action)
     {
       if (/^subscription\.(added|removed|disabled)$/.test(action))
       {
         for (var i = 0; i < featureSubscriptions.length; i++)
         {
           var featureSubscription = featureSubscriptions[i];
           updateToggleButton(featureSubscription.feature, isSubscriptionEnabled(featureSubscription));
         }
       }
     }
     FilterNotifier.addListener(filterListener);
     window.addEventListener("unload", function(event)
     {
       FilterNotifier.removeListener(filterListener);
     }, false);
 
-    window.addEventListener("resize", onWindowResize, false);
-    document.addEventListener("scroll", onScroll, false);
-
-    onWindowResize();
+    // You can click activate-feature or one of the icons to toggle the features area
+    E("activate-features").addEventListener("click", showFeature, false);
+    E("can-do-more-overview").addEventListener("click", showFeature, false);
 
     initSocialLinks();
   }
-
-  function onScroll()
-  {
-    var currentHeight = document.documentElement.scrollTop + document.body.scrollTop + document.documentElement.clientHeight;
-    shade.style.opacity = (document.documentElement.scrollHeight == currentHeight) ? "0.0" : "0.5";
-  }
-
-  function onWindowResize()
-  {
-    onScroll();
-  }
-
-  function toggleTypoCorrectionEnabled()
-  {
-    Prefs.correctTypos = !Prefs.correctTypos;
+  
+  function showFeature()

[Wladimir Palant, 2013/10/02 13:21:39]

I think the proper name for this function would be toggleFeature().

+  { 
+    var canDoMore = E("can-do-more");
+    var canDoMoreOverview = E("can-do-more-overview");
+    var canDoMoreExpanded = E("can-do-more-expanded");
+    
+    if (!canDoMore.classList.contains("expanded"))
+    { 
+      canDoMore.classList.add("expanded");
+      canDoMoreOverview.classList.add("fade");
+      
+      setTimeout(function()
+      {
+        canDoMoreOverview.classList.add("hide");
+        canDoMoreExpanded.classList.remove("hide");
+      },500);
+      
+      /* Next timeout has to be done because of an js bug. 
+       * If you set "display: block" and "opacity: 1" 
+       * at the same time the content would be shown 
+       * directly without any transition. 
+       * With the following timeout the opacity 
+       * transition works correctly 
+       */   
+      setTimeout(function()
+      {
+        canDoMoreExpanded.classList.remove("fade");
+      },520);

[Wladimir Palant, 2013/10/02 13:21:39]

JavaScript doesn't guarantee any particular order for timeouts - e.g. if the
browser doesn't get to run any code for a second, it can run all the callbacks
in random order. What you want should be done by adding a zero ms timeout inside
the previous one.

Note that display property not being animatable is behavior according to spec,
not a "bug" (and definitely not a JS one).

+    }
+    else if (canDoMore.classList.contains("expanded"))
+    {
+      canDoMore.classList.remove("expanded");
+      canDoMoreExpanded.classList.add("fade");
+      
+      setTimeout(function()
+      { 
+        canDoMoreExpanded.classList.add("hide");
+        canDoMoreOverview.classList.remove("hide");
+      },500);
+        
+      setTimeout(function()
+      {
+        canDoMoreOverview.classList.remove("fade");
+      },520);
+    }

[Wladimir Palant, 2013/10/02 13:21:39]

We are using CSS transitions - why does this have to be so complicated? IMHO
adding/removing "expanded" class on the container should be sufficient to
trigger all the necessary transitions. The problem is apparently hiding the
element after fading out - display:none won't work for that as mentioned above.
Changing max-height seems to be working however, along these lines:

#can-do-more-expanded
{
  opacity: 0;
  max-height: 0;
  -moz-transition: opacity 0.5s ease-out, max-height 0.5s step-end;
}
#can-do-more.expanded > #can-do-more-expanded
{
  opacity: 1;
  max-height: 10000px;
  -moz-transition: opacity 0.5s step-end, max-height 0.5s step-end;
}

   }
 
   function isSubscriptionEnabled(featureSubscription)
   {
     return featureSubscription.url in FilterStorage.knownSubscriptions
       && !Subscription.fromURL(featureSubscription.url).disabled;
   }
 
   function setToggleSubscriptionButton(featureSubscription)
   {
@@ skipping 11 matching lines @@
         subscription.disabled = false;
         subscription.title = featureSubscription.title;
         subscription.homepage = featureSubscription.homepage;
         FilterStorage.addSubscription(subscription);
         if (!subscription.lastDownload)
           Synchronizer.execute(subscription);
       }
     }, false);
   }
 
-  function scrollPage()
-  {
-    if (scrollTimer)
-      stopScroll();
-
-    scrollTimer = setInterval(function()
-    {
-      window.scrollBy(0, 5);
-    }, 20);
-  }
-
-  function stopScroll()
-  {
-    clearTimeout(scrollTimer);
-    scrollTimer = null;
-  }
-
   function openSharePopup(url)
   {
     var iframe = E("share-popup");
     var glassPane = E("glass-pane");
     var popupMessageReceived = false;
 
     var popupMessageListener = function(event)
     {
       var originFilter = Filter.fromText("||adblockplus.org^");
       if (!originFilter.matches(event.origin, "OTHER", null, null))
@@ skipping 56 matching lines @@
     {
       event.preventDefault();
       openSharePopup(Utils.getDocLink(event.target.id));
     }
   }
 
   function setLinks(id)
   {
     var element = E(id);
     if (!element)
+    {
       return;
-
+    }
+    
     var links = element.getElementsByTagName("a");
+    
     for (var i = 0; i < links.length; i++)
     {
       if (typeof arguments[i + 1] == "string")
       {
         links[i].href = arguments[i + 1];
         links[i].setAttribute("target", "_blank");
       }
       else if (typeof arguments[i + 1] == "function")
       {
         links[i].href = "javascript:void(0);";
@@ skipping 16 matching lines @@
   {
     var button = E("toggle-" + feature);
     if (isEnabled)
       button.classList.remove("off");
     else
       button.classList.add("off");
   }
 
   document.addEventListener("DOMContentLoaded", onDOMLoaded, false);
 })();