j1-template 2020.0.22 → 2020.0.24

data/assets/themes/j1/adapter/js/framer.js

@@ -105,63 +105,71 @@ j1.adapter['framer'] = (function (j1, window) {
     // -------------------------------------------------------------------------
     init: function (options) {
 
-      // -----------------------------------------------------------------------
-      // globals
-      // -----------------------------------------------------------------------
-      _this   = j1.adapter.framer;
-      logger  = log4javascript.getLogger('j1.adapter.framer');
-
-      // initialize state flag
-      _this.setState('started');
-      logger.info('state: ' + _this.getState());
-      logger.info('module is being initialized');
-
-      // -----------------------------------------------------------------------
-      // Default module settings
-      // -----------------------------------------------------------------------
-      var settings = $.extend({
-        module_name: 'j1.adapter.example',
-        generated:   '{{site.time}}'
-      }, options);
-
-      {% comment %} Load module config from yml data
-      -------------------------------------------------------------------------- {% endcomment %}
-      // Load  module DEFAULTS|CONFIG
-      /* eslint-disable */
-      moduleOptions = $.extend({}, {{framer_options | replace: '=>', ':' | replace: 'nil', '""'}});
-      /* eslint-enable */
-
-      if (typeof settings !== 'undefined') {
-        moduleOptions = j1.mergeData(moduleOptions, settings);
-      }
-
-      iFrameResize({
-        log:                      moduleOptions.log,
-        autoResize:               moduleOptions.autoResize,
-        bodyBackground:           moduleOptions.bodyBackground,
-        bodyMargin:               moduleOptions.bodyMargin,
-        checkOrigin:              moduleOptions.checkOrigin,
-        inPageLinks:              moduleOptions.inPageLinks,
-        interval:                 moduleOptions.interval,
-        heightCalculationMethod:  moduleOptions.heightCalculationMethod,
-        maxHeight:                moduleOptions.maxHeight,
-        minWidth:                 moduleOptions.minWidth,
-        maxWidth:                 moduleOptions.maxWidth,
-        minHeight:                moduleOptions.minHeight,
-        resizeFrom:               moduleOptions.resizeFrom,
-        scrolling:                moduleOptions.scrolling,
-        sizeHeight:               moduleOptions.sizeHeight,
-        sizeWidth:                moduleOptions.sizeWidth,
-        tolerance:                moduleOptions.tolerance,
-        widthCalculationMethod:   moduleOptions.widthCalculationMethod,
-        targetOrigin:             moduleOptions.checkOrigin
-      });
-
-      _this.setState('finished');
-      logger.info('state: ' + _this.getState());
-      logger.info('initializing module finished');
+      var dependencies_met_page_finished = setInterval (function () {
+        if (j1.getState() === 'finished') {
+            // -----------------------------------------------------------------------
+            // globals
+            // -----------------------------------------------------------------------
+            _this   = j1.adapter.framer;
+            logger  = log4javascript.getLogger('j1.adapter.framer');
+
+            // initialize state flag
+            _this.setState('started');
+            logger.info('state: ' + _this.getState());
+            logger.info('module is being initialized');
+
+            // -----------------------------------------------------------------------
+            // Default module settings
+            // -----------------------------------------------------------------------
+            var settings = $.extend({
+              module_name: 'j1.adapter.example',
+              generated:   '{{site.time}}'
+            }, options);
+
+            {% comment %} Load module config from yml data
+            -------------------------------------------------------------------------- {% endcomment %}
+            // Load  module DEFAULTS|CONFIG
+            /* eslint-disable */
+            moduleOptions = $.extend({}, {{framer_options | replace: '=>', ':' | replace: 'nil', '""'}});
+            /* eslint-enable */
+
+            if (typeof settings !== 'undefined') {
+              moduleOptions = j1.mergeData(moduleOptions, settings);
+            }
+
+            iFrameResize({
+              log:                      moduleOptions.log,
+              autoResize:               moduleOptions.autoResize,
+              bodyBackground:           moduleOptions.bodyBackground,
+              bodyMargin:               moduleOptions.bodyMargin,
+              checkOrigin:              moduleOptions.checkOrigin,
+              inPageLinks:              moduleOptions.inPageLinks,
+              interval:                 moduleOptions.interval,
+              heightCalculationMethod:  moduleOptions.heightCalculationMethod,
+              maxHeight:                moduleOptions.maxHeight,
+              minWidth:                 moduleOptions.minWidth,
+              maxWidth:                 moduleOptions.maxWidth,
+              minHeight:                moduleOptions.minHeight,
+              resizeFrom:               moduleOptions.resizeFrom,
+              scrolling:                moduleOptions.scrolling,
+              sizeHeight:               moduleOptions.sizeHeight,
+              sizeWidth:                moduleOptions.sizeWidth,
+              tolerance:                moduleOptions.tolerance,
+              widthCalculationMethod:   moduleOptions.widthCalculationMethod,
+              targetOrigin:             moduleOptions.checkOrigin
+            });
+
+            _this.setState('finished');
+            logger.info('state: ' + _this.getState());
+            logger.info('initializing module finished');
+
+            clearInterval(dependencies_met_page_finished);
+
+            return true;
+
+        }
+      }, 25);
 
-      return true;
     }, // END init
 
     // -------------------------------------------------------------------------
@@ -191,6 +199,14 @@ j1.adapter['framer'] = (function (j1, window) {
       return true;
     }, // END messageHandler
 
+    // -------------------------------------------------------------------------
+    // setState()
+    // Sets the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    setState: function (stat) {
+      _this.state = stat;
+    }, // END setState
+
     // -------------------------------------------------------------------------
     // getState
     // Returns the current (processing) state of the module

data/assets/themes/j1/adapter/js/gallery_customizer.js

@@ -155,7 +155,8 @@ j1.adapter['gallery_customizer'] = (function (j1, window) {
         xhr_container_id: customizerOptions.xhr_container_id,
         xhr_data_path:    customizerOptions.xhr_data_path },
         'j1.adapter.gallery_customizer',
-        'null');
+        'null'
+      );
 
       // -------------------------------------------------------------------
       // initializer

data/assets/themes/j1/adapter/js/j1.js

@@ -1122,10 +1122,16 @@ var j1 = (function () {
         };
       };
       // see: https://stackoverflow.com/questions/20420577/detect-added-element-to-dom-with-mutation-observer
-      var id = '#' + options.xhr_container_id;
+      var html_data_path;
+      var id        = '#' + options.xhr_container_id;
       var $selector = $(id);
+
       if ( $selector.length ) {
-        var html_data_path = options.xhr_data_path + ' > *';
+        if (options.xhr_data_element) {
+          html_data_path = options.xhr_data_path + ' #' + options.xhr_data_element + ' > *';
+        } else  {
+          html_data_path = options.xhr_data_path + ' > *';
+        }
         $selector.load( html_data_path, cb_load_closure( mod, id ) );
 
         var MutationObserver = window.MutationObserver || window.WebKitMutationObserver;

data/assets/themes/j1/adapter/js/{searcher.js → lunr_search.js}

@@ -1,17 +1,16 @@
 ---
-regenerate:                             false
+regenerate:                             true
 ---
 
 {% capture cache %}
 
 {% comment %}
  # -----------------------------------------------------------------------------
- # ~/assets/themes/j1/adapter/js/searcher.js
- # Liquid template to adapt SimpleJekyllSearch Core functions
+ # ~/assets/themes/j1/adapter/js/lunr_search.js
+ # Liquid template to adapt J1LunrSearch
  #
  # Product/Info:
  # https://jekyll.one
- #
  # Copyright (C) 2020 Juergen Adams
  #
  # J1 Template is licensed under the MIT License.
@@ -22,28 +21,29 @@ regenerate:                             false
  # -----------------------------------------------------------------------------
 {% endcomment %}
 
-{% comment %} Set global settings
+{% comment %} Liquid procedures
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign environment             = site.environment %}
-{% assign template_version        = site.version %}
 
 {% comment %} Process YML config data
 ================================================================================ {% endcomment %}
 
 {% comment %} Set config files
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign template_config         = site.data.j1_config %}
-{% assign blocks                  = site.data.blocks %}
-{% assign modules                 = site.data.modules %}
+{% assign template_config       = site.data.j1_config %}
+{% assign blocks                = site.data.blocks %}
+{% assign modules               = site.data.modules %}
 
 {% comment %} Set config data
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign jekyll_search_defaults = modules.defaults.jekyll_search.defaults %}
-{% assign jekyll_search_settings = modules.jekyll_search.settings %}
+{% assign environment           = site.environment %}
+{% assign template_version      = site.version %}
+
+{% assign lunr_search_defaults  = modules.defaults.lunr_search.defaults %}
+{% assign lunr_search_settings  = modules.lunr_search.settings %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign jekyll_search_options  = jekyll_search_defaults | merge: jekyll_search_settings %}
+{% assign lunr_search_options   = lunr_search_defaults | merge: lunr_search_settings %}
 
 {% assign production = false %}
 {% if environment == 'prod' or environment == 'production' %}
@@ -52,20 +52,16 @@ regenerate:                             false
 
 /*
  # -----------------------------------------------------------------------------
- # ~/assets/themes/j1/adapter/js/searcher.js
- # JS Adapter for J1 Searcher (SimpleJekyllSearch)
+ # ~/assets/themes/j1/adapter/js/lunr_search.js
+ # J1 Adapter for lunr_search
  #
  # Product/Info:
  # https://jekyll.one
- # https://github.com/christian-fei/Simple-Jekyll-Search
  #
  # Copyright (C) 2020 Juergen Adams
- # Copyright (C) 2015 Christian Fei
  #
  # J1 Template is licensed under the MIT License.
  # For details, see https://jekyll.one
- # SimpleJekyllSearch is licensed under the MIT License.
- # For details, see https://github.com/christian-fei/Simple-Jekyll-Search
  # -----------------------------------------------------------------------------
  #  Adapter generated: {{site.time}}
  # -----------------------------------------------------------------------------
@@ -80,16 +76,20 @@ regenerate:                             false
 
 {% comment %} Main
 -------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['searcher'] = (function (j1, window) {
+j1.adapter['lunr_search'] = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
   var environment   = '{{environment}}';
-  var moduleOptions = {};
+  var searchOptions = {};
   var _this;
   var logger;
   var logText;
 
+  // ---------------------------------------------------------------------------
+  // Helper functions
+  // ---------------------------------------------------------------------------
+
   // ---------------------------------------------------------------------------
   // Main object
   // ---------------------------------------------------------------------------
@@ -103,65 +103,68 @@ j1.adapter['searcher'] = (function (j1, window) {
       // -----------------------------------------------------------------------
       // globals
       // -----------------------------------------------------------------------
-      _this   = j1.adapter.searcher;
-      logger  = log4javascript.getLogger('j1.adapter.searcher');
+      _this   = j1.adapter.lunr_search;
+      logger  = log4javascript.getLogger('j1.adapter.lunr_search');
 
       // initialize state flag
-      _this.setState('pending');
+      _this.setState('started');
       logger.info('state: ' + _this.getState());
-      logger.info('Module is being started');
-
+      logger.info('module is being initialized');
 
       // -----------------------------------------------------------------------
-      // Default module settings
+      // defaults
       // -----------------------------------------------------------------------
       var settings = $.extend({
-        module_name: 'j1.adapter.searcher',
+        module_name: 'j1.adapter.lunr_search',
         generated:   '{{site.time}}'
       }, options);
 
-      {% comment %} Load module config from yml data
-      -------------------------------------------------------------------------- {% endcomment %}
-      // Load  module DEFAULTS|CONFIG
+      // -----------------------------------------------------------------------
+      // options loader
+      // -----------------------------------------------------------------------
       /* eslint-disable */
-      moduleOptions = $.extend({}, {{jekyll_search_options | replace: '=>', ':' | replace: 'nil', '""'}});
-      /* eslint-enable */
+      searchOptions = $.extend({}, {{lunr_search_options | replace: '=>', ':' | replace: 'nil', '""'}});
 
-      if (typeof settings !== 'undefined') {
-        moduleOptions = j1.mergeData(moduleOptions, settings);
-      }
+      // -----------------------------------------------------------------------
+      // lunr_search initializer
+      // -----------------------------------------------------------------------
+      var log_text = 'module is being initialized';
+      logger.info(log_text);
 
-      if (moduleOptions.enabled) {
-        _this.setState('started');
-        logger.info('state: ' + _this.getState());
-        logger.info('Module is being initialized');
-
-        var jekyllSearch = SimpleJekyllSearch({
-          searchInput:          document.getElementById(moduleOptions.search_input),
-          resultsOutput:        document.getElementById(moduleOptions.results_output),
-          resultsContainer:     document.getElementById(moduleOptions.results_container),
-          json:                 moduleOptions.index_data,
-          searchResultTemplate: moduleOptions.result_template,
-          results_output:       moduleOptions.results_output,
-          limit:                moduleOptions.result_limit,
-          minSearchItemLen:     moduleOptions.min_search_item_len,
-          fuzzy:                moduleOptions.search_fuzzy,
-          exclude:              moduleOptions.search_exlude,
-          noResultsText:        moduleOptions.no_results_text
-        });
-
-        _this.setState('finished');
-        logger.info('state: ' + _this.getState());
-        logger.info('module initialized successfully');
-      } else {
-        _this.setState('finished');
-        logger.info('state: ' + _this.getState());
-        logger.info('module disabled');
-      }
+      var dependencies_met_j1_finished = setInterval(function() {
+        if (j1.getState() == 'finished') {
+
+          $(searchOptions.search_input).lunrSearch({
+            index_file: searchOptions.index_file,
+            results:    searchOptions.results,
+            template:   searchOptions.template,
+            titleMsg:   searchOptions.titleMsg,
+            emptyMsg:   searchOptions.emptyMsg
+          });
+
+          _this.setState('finished');
+          logger.info('state: ' + _this.getState());
+
+          clearInterval(dependencies_met_j1_finished);
+        } // END dependencies_met_j1_finished
+      }, 25);
+
+       _this.eventHandler();
 
-      return true;
     }, // END init
 
+    // -------------------------------------------------------------------------
+    // event handler
+    // -------------------------------------------------------------------------
+    eventHandler: function () {
+      // hide|clear results from top search
+      $('#clear-topsearch').on('click', function() {
+        $(this).addClass('d-none').prevAll(':input').val('');
+        $('#search-results').hide();
+        $('#search-results').html('');
+      });
+    }, // END eventHandler
+
     // -------------------------------------------------------------------------
     // messageHandler: MessageHandler for J1 CookieConsent module
     // Manage messages send from other J1 modules
@@ -170,7 +173,7 @@ j1.adapter['searcher'] = (function (j1, window) {
       var json_message = JSON.stringify(message, undefined, 2);
 
       logText = 'received message from ' + sender + ': ' + json_message;
-      logger.info(logText);
+      logger.debug(logText);
 
       // -----------------------------------------------------------------------
       //  Process commands|actions

data/assets/themes/j1/adapter/js/toccer.js

@@ -97,8 +97,10 @@ j1.adapter['toccer'] = (function () {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
-  var environment   = '{{environment}}'; // Set environment
-  var moduleOptions = {};
+  var environment         = '{{environment}}';                                  // Set environment
+  var moduleOptions       = {};
+  var toccerOptions       = {};
+  var frontmatterOptions  = {};
   var _this;
   var logger;
   var logText;
@@ -128,31 +130,60 @@ j1.adapter['toccer'] = (function () {
       logger.info('state: ' + _this.getState());
       logger.info('Module is being initialized');
 
-      if (options  !== undefined) {
-        var settings = $.extend({}, options);
-      } else {
-        var settings = false;
-      }
+      // create settings object from frontmatterOptions
+      var frontmatterOptions = options != null ? $.extend({}, options) : {};
 
-      // cast text-based booleans
-      var  isToc = (options.toc === 'true');
-      var  isComments = (options.comments === 'true');
+      // -----------------------------------------------------------------------
+      // defaults
+      // -----------------------------------------------------------------------
+      var settings  = $.extend({
+        module_name: 'j1.adapter.toccer',
+        generated:   '{{site.time}}'
+      }, options);
 
-      if (settings.collapseDepth === undefined) {
-        settings.collapseDepth = {{toccer_options.collapseDepth}};
-      }
+      // -----------------------------------------------------------------------
+      // options loader
+      // -----------------------------------------------------------------------
+      /* eslint-disable */
+      toccerOptions = $.extend({}, {{toccer_options | replace: 'nil', 'null' | replace: '=>', ':' }});
+
+      // Load (individual) frontmatter options (currently NOT used)
+      if (options != null) { frontmatterOptions = $.extend({}, options); }
 
-      if (settings.scrollSmoothOffset === undefined) {
-        settings.scrollSmoothOffset = {{toccer_options.scrollSmoothOffset}};
+      if (typeof frontmatterOptions !== 'undefined') {
+        moduleOptions = j1.mergeData(toccerOptions, frontmatterOptions);
       }
+      /* eslint-enable */
+
+      // save config settings into the toccer object for global access
+      //
+      _this['moduleOptions'] = moduleOptions;
+
+      // if (options  !== undefined) {
+      //   var settings = $.extend({}, options);
+      // } else {
+      //   var settings = false;
+      // }
 
-      if (settings.enabled === undefined) {
-        settings.enabled = true;
+      // cast text-based booleans
+      var  isToc = (moduleOptions.toc === 'true');
+      var  isComments = (moduleOptions.comments === 'true');
+
+      if (moduleOptions.collapseDepth === undefined) {
+        moduleOptions.collapseDepth = 3;
       }
 
+      // if (settings.scrollSmoothOffset === undefined) {
+      //   settings.scrollSmoothOffset = {{toccer_options.scrollSmoothOffset}};
+      // }
+      //
+      // if (settings.enabled === undefined) {
+      //   settings.enabled = true;
+      // }
+
       // save config settings into the toccer object for global|later access
       //
-      _this['moduleOptions'] = settings;
+      // _this['moduleOptions'] = settings;
 
       if (isToc) {
         var dependencies_met_navigator = setInterval(function() {
@@ -212,14 +243,14 @@ j1.adapter['toccer'] = (function () {
         if ($('#toc_mmenu').length) {
           /* eslint-disable */
           tocbot.init({
-            log:                    {{ toccer_options.log | json }},
-            activeLinkColor:        {{ toccer_options.activeLinkColor | json }},
-            tocSelector:            {{ toccer_options.tocSelector | json }},
-            headingSelector:        {{ toccer_options.headingSelector | json }},
-            ignoreSelector:         {{ toccer_options.ignoreSelector | json }},
-            contentSelector:        {{ toccer_options.contentSelector | json }},
-            collapseDepth:          settings.collapseDepth,
-            throttleTimeout:        {{ toccer_options.throttleTimeout | json }},
+            log:                    moduleOptions.log,
+            activeLinkColor:        moduleOptions.activeLinkColor,
+            tocSelector:            moduleOptions.tocSelector,
+            headingSelector:        moduleOptions.headingSelector,
+            ignoreSelector:         moduleOptions.ignoreSelector,
+            contentSelector:        moduleOptions.contentSelector,
+            collapseDepth:          moduleOptions.collapseDepth,
+            throttleTimeout:        moduleOptions.throttleTimeout,
             hasInnerContainers:     false,
             includeHtml:            false,
             linkClass:              'toc-link',
@@ -233,11 +264,12 @@ j1.adapter['toccer'] = (function () {
             positionFixedSelector:  '',
             positionFixedClass:     'is-position-fixed',
             fixedSidebarOffset:     'auto',
-            scrollSmooth:           {{ toccer_options.scrollSmooth | json }},
-            scrollSmoothDuration:   {{ toccer_options.scrollSmoothDuration | json }},
-            scrollSmoothOffset:     settings.scrollSmoothOffset,
+            scrollContainer:        null,
+            scrollSmooth:           moduleOptions.scrollSmooth,
+            scrollSmoothDuration:   moduleOptions.scrollSmoothDuration,
+            scrollSmoothOffset:     moduleOptions.scrollSmoothOffset,
             headingsOffset:         1,
-            throttleTimeout:        {{ toccer_options.throttleTimeout | json }}
+            throttleTimeout:        moduleOptions.throttleTimeout
           });
           /* eslint-enable */
           logger.info('met dependencies for: xhrData');