govuk_tech_docs 1.8.3 → 1.9.0.pre.gfe

data/lib/assets/javascripts/_modules/navigation.js

@@ -1,34 +1,34 @@
-(function($, Modules) {
-  'use strict';
+(function ($, Modules) {
+  'use strict'
 
   Modules.Navigation = function () {
-    var $html = $('html');
+    var $html = $('html')
 
-    var $navToggle;
-    var $nav;
+    var $navToggle
+    var $nav
 
     this.start = function ($element) {
-      $navToggle = $('.js-nav-toggle', $element);
-      $nav = $('.js-nav', $element);
+      $navToggle = $('.js-nav-toggle', $element)
+      $nav = $('.js-nav', $element)
 
-      updateAriaAttributes();
+      updateAriaAttributes()
 
-      $navToggle.on('click', toggleNavigation);
-      $(window).on('resize', updateAriaAttributes);
+      $navToggle.on('click', toggleNavigation)
+      $(window).on('resize', updateAriaAttributes)
     }
 
-    function updateAriaAttributes() {
-      var navIsVisible = $nav.is(':visible');
+    function updateAriaAttributes () {
+      var navIsVisible = $nav.is(':visible')
 
-      $navToggle.attr('aria-expanded', navIsVisible ? 'true' : 'false');
-      $nav.attr('aria-hidden', navIsVisible ? 'false' : 'true');
+      $navToggle.attr('aria-expanded', navIsVisible ? 'true' : 'false')
+      $nav.attr('aria-hidden', navIsVisible ? 'false' : 'true')
     }
 
-    function toggleNavigation() {
-      var navIsVisible = !$html.hasClass('nav-open');
+    function toggleNavigation () {
+      var navIsVisible = !$html.hasClass('nav-open')
 
-      $html.toggleClass('nav-open', navIsVisible);
-      updateAriaAttributes();
+      $html.toggleClass('nav-open', navIsVisible)
+      updateAriaAttributes()
     }
-  };
-})(jQuery, window.GOVUK.Modules);
+  }
+})(jQuery, window.GOVUK.Modules)

data/lib/assets/javascripts/_modules/page-expiry.js

@@ -1,15 +1,15 @@
-(function($, Modules) {
-  'use strict';
+(function ($, Modules) {
+  'use strict'
 
-  Modules.PageExpiry = function PageExpiry() {
-    this.start = function start($element) {
-      var rawDate = $element.data('last-reviewed-on');
-      var isExpired = Date.parse(rawDate) < new Date();
+  Modules.PageExpiry = function PageExpiry () {
+    this.start = function start ($element) {
+      var rawDate = $element.data('last-reviewed-on')
+      var isExpired = Date.parse(rawDate) < new Date()
 
       if (isExpired) {
-        $element.find('.page-expiry--not-expired').hide(0);
-        $element.find('.page-expiry--expired').show(0);
+        $element.find('.page-expiry--not-expired').hide(0)
+        $element.find('.page-expiry--expired').show(0)
       }
-    };
-  };
-})(jQuery, window.GOVUK.Modules);
+    }
+  }
+})(jQuery, window.GOVUK.Modules)

data/lib/assets/javascripts/_modules/search.js

@@ -1,210 +1,208 @@
 //= require lunr.min
 //= require _vendor/jquery.mark.js
-(function($, Modules) {
-  'use strict';
+(function ($, Modules) {
+  'use strict'
 
-  Modules.Search = function Search() {
-    var s = this;
-    var $html = $('html');
-    s.lunrIndex;
-    s.lunrData;
-    var $searchForm;
-    var $searchLabel;
-    var $searchInput;
-    var $searchResults;
-    var $searchResultsTitle;
-    var $searchResultsWrapper;
-    var $searchResultsClose;
-    var results;
-    var query;
-    var queryTimer;
-    var maxSearchEntries = 20;
+  Modules.Search = function Search () {
+    var s = this
+    var $html = $('html')
+    var $searchForm
+    var $searchLabel
+    var $searchInput
+    var $searchResults
+    var $searchResultsTitle
+    var $searchResultsWrapper
+    var $searchResultsClose
+    var results
+    var query
+    var queryTimer
+    var maxSearchEntries = 20
 
-    this.start = function start($element) {
-      $searchForm = $element.find('form');
-      $searchInput = $element.find('#search');
-      $searchLabel = $element.find('.search__label');
+    this.start = function start ($element) {
+      $searchForm = $element.find('form')
+      $searchInput = $element.find('#search')
+      $searchLabel = $element.find('.search__label')
       $searchResultsWrapper = $element.find('.search-results')
-      $searchResults = $searchResultsWrapper.find('.search-results__content');
-      $searchResultsTitle = $searchResultsWrapper.find('.search-results__title');
-      $searchResultsClose = $searchResultsWrapper.find('.search-results__close');
-      s.downloadSearchIndex();
-      attach();
-      changeSearchLabel();
-    };
+      $searchResults = $searchResultsWrapper.find('.search-results__content')
+      $searchResultsTitle = $searchResultsWrapper.find('.search-results__title')
+      $searchResultsClose = $searchResultsWrapper.find('.search-results__close')
+      s.downloadSearchIndex()
+      attach()
+      changeSearchLabel()
+    }
 
-    this.downloadSearchIndex = function downloadSearchIndex() {
+    this.downloadSearchIndex = function downloadSearchIndex () {
       updateTitle('Loading search index')
       $.ajax({
         url: '/search.json',
         cache: true,
         method: 'GET',
-        success: function(data) {
-          s.lunrData = data;
-          s.lunrIndex = lunr.Index.load(s.lunrData.index);
-          replaceStopWordFilter();
-          $(document).trigger('lunrIndexLoaded');
+        success: function (data) {
+          s.lunrData = data
+          s.lunrIndex = lunr.Index.load(s.lunrData.index)
+          replaceStopWordFilter()
+          $(document).trigger('lunrIndexLoaded')
         }
-      });
+      })
     }
 
-    function attach() {
+    function attach () {
       // Search functionality on search text input
       $searchInput.on('input', function (e) {
-        e.preventDefault();
-        query = $(this).val();
-        s.search(query, function(r) {
-          results = r;
-          renderResults(query);
-          updateTitle();
-        });
-        if(window.ga) {
-          window.clearTimeout(queryTimer);
-          queryTimer = window.setTimeout(sendQueryToAnalytics, 1000);
+        e.preventDefault()
+        query = $(this).val()
+        s.search(query, function (r) {
+          results = r
+          renderResults(query)
+          updateTitle()
+        })
+        if (window.ga) {
+          window.clearTimeout(queryTimer)
+          queryTimer = window.setTimeout(sendQueryToAnalytics, 1000)
         }
-      });
+      })
 
       // Set focus on the first search result instead of submiting the search
       // form to Google
-      $searchForm.on('submit', function(e) {
-        e.preventDefault();
-        showResults();
-        $searchResults.find('.search-result__title a').first().focus();
-      });
+      $searchForm.on('submit', function (e) {
+        e.preventDefault()
+        showResults()
+        $searchResults.find('.search-result__title a').first().focus()
+      })
 
       // Closing the search results, move focus back to the search input
-      $searchResultsClose.on('click', function(e) {
-        e.preventDefault();
-        $searchInput.focus();
-        hideResults();
-      });
+      $searchResultsClose.on('click', function (e) {
+        e.preventDefault()
+        $searchInput.focus()
+        hideResults()
+      })
 
       // Attach analytics events to search result clicks
-      if(window.ga) {
-        $searchResults.on('click', '.search-result__title a', function() {
-          var href = $(this).attr('href');
+      if (window.ga) {
+        $searchResults.on('click', '.search-result__title a', function () {
+          var href = $(this).attr('href')
           ga('send', {
             hitType: 'event',
             eventCategory: 'Search result',
             eventAction: 'click',
             eventLabel: href,
             transport: 'beacon'
-          });
-        });
+          })
+        })
       }
 
       // When selecting navigation link, close the search results.
-      $('#toc').on('click','a', function(e) {
-        hideResults();
+      $('#toc').on('click', 'a', function (e) {
+        hideResults()
       })
     }
 
-    function changeSearchLabel() {
-      $searchLabel.text('Search');
+    function changeSearchLabel () {
+      $searchLabel.text('Search')
     }
 
-    function getResults(query) {
-      var results = [];
-      s.lunrIndex.search(query).forEach( function (item, index) {
-        if ( index < maxSearchEntries ) {
-          results.push(s.lunrData.docs[item.ref]);
+    function getResults (query) {
+      var results = []
+      s.lunrIndex.search(query).forEach(function (item, index) {
+        if (index < maxSearchEntries) {
+          results.push(s.lunrData.docs[item.ref])
         }
-      });
-      return results;
+      })
+      return results
     }
 
-    this.search = function search(query, callback) {
-      if(query === '') {
-        hideResults();
-        return;
+    this.search = function search (query, callback) {
+      if (query === '') {
+        hideResults()
+        return
       }
-      showResults();
+      showResults()
       // The index has not been downloaded yet, exit early and wait.
-      if(!s.lunrIndex) {
-        $(document).on('lunrIndexLoaded', function() {
-          s.search(query, callback);
-        });
-        return;
+      if (!s.lunrIndex) {
+        $(document).on('lunrIndexLoaded', function () {
+          s.search(query, callback)
+        })
+        return
       }
-      callback(getResults(query));
+      callback(getResults(query))
     }
 
-    function renderResults(query) {
-      var output = '';
-      if (results.length == 0) {
-        output += '<p>Nothing found</p>';
+    function renderResults (query) {
+      var output = ''
+      if (results.length === 0) {
+        output += '<p>Nothing found</p>'
       }
-      output += '<ul>';
-      for(var index in results) {
-        var result = results[index];
-        var content = s.processContent(result.content, query);
-        output += '<li class="search-result">';
-        output += '<h3 class="search-result__title">';
-        output += '<a href="' + result.url + '">';
-        output += result.title;
-        output += '</a>';
-        output += '</h3>';
-        if(typeof content !== 'undefined') {
-          output += '<p>' + content + '</p>';
+      output += '<ul>'
+      for (var index in results) {
+        var result = results[index]
+        var content = s.processContent(result.content, query)
+        output += '<li class="search-result">'
+        output += '<h3 class="search-result__title">'
+        output += '<a href="' + result.url + '">'
+        output += result.title
+        output += '</a>'
+        output += '</h3>'
+        if (typeof content !== 'undefined') {
+          output += '<p>' + content + '</p>'
         }
-        output += '</li>';
+        output += '</li>'
       }
-      output += '</ul>';
+      output += '</ul>'
 
-      $searchResults.html( output );
+      $searchResults.html(output)
     }
 
-    this.processContent = function processContent(content, query) {
-      var output;
-      content = '<div>'+  content + '</div>';
-      content = $(content).mark(query);
+    this.processContent = function processContent (content, query) {
+      var output
+      content = '<div>' + content + '</div>'
+      content = $(content).mark(query)
 
       // Split content by sentence.
-      var sentences = content.html().replace(/(\.+|\:|\!|\?|\r|\n)(\"*|\'*|\)*|}*|]*)/gm, "|").split("|");
+      var sentences = content.html().replace(/(\.+|:|!|\?|\r|\n)("*|'*|\)*|}*|]*)/gm, '|').split('|')
 
       // Select the first five sentences that contain a <mark>
-      var selectedSentences = [];
+      var selectedSentences = []
       for (var i = 0; i < sentences.length; i++) {
-        if(selectedSentences.length === 5) {
-          break;
+        if (selectedSentences.length === 5) {
+          break
         }
 
-        var sentence = sentences[i].trim();
-        var containsMark = sentence.includes('mark>');
-        if (containsMark && (selectedSentences.indexOf(sentence) == -1)) {
-          selectedSentences.push(sentence);
+        var sentence = sentences[i].trim()
+        var containsMark = sentence.includes('mark>')
+        if (containsMark && (selectedSentences.indexOf(sentence) === -1)) {
+          selectedSentences.push(sentence)
         }
       }
-      if(selectedSentences.length > 0) {
-        output = ' … ' + selectedSentences.join(' … ') + ' … ';
+      if (selectedSentences.length > 0) {
+        output = ' … ' + selectedSentences.join(' … ') + ' … '
       }
-      return output;
+      return output
     }
 
     // Default text is to display the number of search results
-    function updateTitle(text) {
-      if(typeof text == "undefined") {
-        var count = results.length;
-        var text = count + ' results';
+    function updateTitle (text) {
+      if (typeof text === 'undefined') {
+        var count = results.length
+        var resultsText = count + ' results'
       }
-      $searchResultsTitle.text(text);
+      $searchResultsTitle.text(text || resultsText)
     }
 
-    function showResults() {
+    function showResults () {
       $searchResultsWrapper.addClass('is-open')
-      .attr('aria-hidden', 'false');
-      $html.addClass('has-search-results-open');
+        .attr('aria-hidden', 'false')
+      $html.addClass('has-search-results-open')
     }
 
-    function hideResults() {
+    function hideResults () {
       $searchResultsWrapper.removeClass('is-open')
-      .attr('aria-hidden', 'true');
-      $html.removeClass('has-search-results-open');
+        .attr('aria-hidden', 'true')
+      $html.removeClass('has-search-results-open')
     }
 
-    function sendQueryToAnalytics() {
-      if(query === '') {
-        return;
+    function sendQueryToAnalytics () {
+      if (query === '') {
+        return
       }
       var stripped = window.stripPIIFromString(query)
       ga('send', {
@@ -213,18 +211,18 @@
         eventAction: 'type',
         eventLabel: stripped,
         transport: 'beacon'
-      });
+      })
     }
 
-    function replaceStopWordFilter() {
+    function replaceStopWordFilter () {
       // Replace the default stopWordFilter as it excludes useful words like
       // 'get'
       // See: https://lunrjs.com/docs/stop_word_filter.js.html#line43
-      s.lunrIndex.pipeline.remove(lunr.stopWordFilter);
-      s.lunrIndex.pipeline.add(s.govukStopWorldFilter);
+      s.lunrIndex.pipeline.remove(lunr.stopWordFilter)
+      s.lunrIndex.pipeline.add(s.govukStopWorldFilter)
     }
 
-   this.govukStopWorldFilter = lunr.generateStopWordFilter([
+    this.govukStopWorldFilter = lunr.generateStopWordFilter([
       'a',
       'able',
       'about',
@@ -344,24 +342,21 @@
       'you',
       'your'
     ])
-  };
+  }
 
   // Polyfill includes
   if (!String.prototype.includes) {
-    String.prototype.includes = function(search, start) {
-      'use strict';
+    String.prototype.includes = function (search, start) { // eslint-disable-line no-extend-native
+      'use strict'
       if (typeof start !== 'number') {
-        start = 0;
+        start = 0
       }
 
       if (start + search.length > this.length) {
-        return false;
+        return false
       } else {
-        return this.indexOf(search, start) !== -1;
+        return this.indexOf(search, start) !== -1
       }
-    };
+    }
   }
-})(jQuery, window.GOVUK.Modules);
-
-
-
+})(jQuery, window.GOVUK.Modules)