j1-template 2020.0.3 → 2020.0.4

data/lib/starter_web/_data/modules/defaults/toccer.yml

@@ -169,4 +169,4 @@ defaults:
 
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/modules/navigator.yml

@@ -44,24 +44,179 @@ settings:
     delay_open_menu:                    250
 
   # ----------------------------------------------------------------------------
-  # NavMenu (Mobile)
+  # NavMenu (MMobile)
   #
   nav_mmenu:
     enabled:                            true
 
+    # --------------------------------------------------------------------------
+    # INSTANCE configuration (drawers|menus)
+    # --------------------------------------------------------------------------
+    menus:
+
+      # ------------------------------------------------------------------------
+      # NAVIGATION Main
+      #
+      - menu:
+          enabled:                      true
+
+          xhr_container_id:             navigator_nav_mmenu
+          xhr_data_path:                /assets/data/mmenu/index.html
+
+          drawer:
+            position:                   right
+
+          content:
+            type:                       navigation
+            title:                      Starter Web
+            theme:                      dark
+            toggler:                    "#navbar-toggler"
+
+      # ------------------------------------------------------------------------
+      # DRAWER Sidebar
+      #
+      - menu:
+          enabled:                      true
+
+          xhr_container_id:             navigator_sidebar_mmenu
+          xhr_data_path:                /assets/data/mmenu_sidebar/index.html
+
+          drawer:
+            position:                   left
+
+          content:
+            type:                       drawer
+            title:                      Site Info
+            theme:                      dark
+            toggler:                    "#navbar-brand"
+            toggler_animation:          rotateIn
+            toggler_activated:          always
+
+            boxes:
+
+              - box:
+                  enabled:              true
+                  type:                 user_info
+                  title:                User
+
+                  links:
+                    - title:            Provider
+                      value:            ??provider
+                      href:             ??provider-site-url
+                      target:           _blank
+                      icon:             domain
+                    - title:            User
+                      icon:             account
+                      value:            ??user-name
+                      href:             ??provider_member_url
+                      target:           none
+                    - title:            Permissions
+                      icon:             account-check
+                      value:            ??provider-permissions
+                      href:             ??provider_member_url
+                      target:           none
+                    - title:            Membership
+                      icon:             account-settings
+                      value:            ??provider-membership
+                      href:             ??provider_member_url
+                      target:           none
+                    - title:            Cookies
+                      icon:             cookie
+                      value:            ??cookie-state
+                      href:             ??provider_privacy_url
+                      target:           none
+
+              - box:
+                  enabled:              true
+                  type:                 theme_info
+                  title:                Theme
+
+                  links:
+                    - title:            Name
+                      icon:             face
+                      value:            ??theme-name
+                      href:             /pages/public/previewer/theme/
+                      target:           none
+                    - title:            Author
+                      icon:             grease-pencil
+                      value:            ??theme-author
+                      href:             ??theme-author-url
+                      target:           _blank
+                    - title:            Version
+                      icon:             numeric
+                      value:            ??theme-version
+                      href:             /pages/public/previewer/theme/
+                      target:           none
+
+              - box:
+                  enabled:              true
+                  type:                 site_info
+                  title:                Site
+
+                  links:
+                    - title:            About
+                      icon:             home-outline
+                      href:             /pages/public/about/site/
+                      target:           none
+
+#                   - title:            Become a Patron
+#                     icon:             patreon
+#                     href:             /pages/public/about/become_a_patron/
+#                     target:           _blank
+
+                    - title:            Impress
+                      icon:             alert-outline
+                      href:             /pages/public/legal/en/impress/
+                      target:           none
+                    - title:            Privacy
+                      icon:             heart
+                      href:             /pages/public/legal/en/privacy/
+                      target:           none
+                    - title:            License
+                      icon:             checkbox-multiple-marked-circle-outline
+                      href:             /pages/public/legal/en/license_agreement/
+                      target:           none
+
+#                   - title:            Contact
+#                     icon:             contact-mail
+#                     href:             mailto:contact@jekyll.one
+#                     target:           none
+
+      # ------------------------------------------------------------------------
+      # DRAWER Toc
+      #
+      - menu:
+          enabled:                      true
+
+          xhr_container_id:             navigator_toc_mmenu
+          xhr_data_path:                /assets/data/mmenu_toc/index.html
+
+          drawer:
+            position:                   right
+
+          content:
+            type:                       drawer
+            title:                      Table of Contents
+            theme:                      light
+            toggler:                    "#toc-toggler"
+            toggler_animation:          rotateIn
+            toggler_activated:          "js-toc-content"
+
   # ----------------------------------------------------------------------------
   # NavQuicklinks
   #
   nav_quicklinks:
     enabled:                            true
 
-    home_url:                           none                                    # none | URL
+    home_url:                           /                                       # none | URL
     back_url:                           none                                    # none | URL
 
+    toc_toggler:                        true
+
     r_text_sizer:                       false                                   # true | false
 
-    disqus_url:                         https://disqus.com/
     github_url:                         https://github.com/jekyll-one
+    disqus_url:                         none                                    # https://disqus.com/
     patreon_url:                        none                                    # https://www.patreon.com/jekyll_one/posts
 
   # ----------------------------------------------------------------------------
@@ -70,99 +225,5 @@ settings:
   nav_topsearch:
     enabled:                            true
 
-  # ----------------------------------------------------------------------------
-  # NavSidebar
-  #
-  nav_sidebar:
-    enabled:                            true
-
-    boxes:
-
-      - box:
-          enabled:                      true
-          type:                         user_info
-          title:                        User
-
-          links:
-            - title:                    Provider
-              value:                    ??provider
-              href:                     ??provider-site-url
-              target:                   _blank
-              icon:                     domain
-            - title:                    User
-              icon:                     account
-              value:                    ??user-name
-              href:                     ??provider_member_url
-              target:                   none
-
-            - title:                    Permissions
-              icon:                     account-check
-              value:                    ??provider-permissions
-              href:                     ??provider_member_url
-              target:                   none
-            - title:                    Membership
-              icon:                     account-settings
-              value:                    ??provider-membership
-              href:                     ??provider_member_url
-              target:                   none
-            - title:                    Cookies
-              icon:                     cookie
-              value:                    ??cookie-state
-              href:                     ??provider_privacy_url
-              target:                   none
-
-      - box:
-          enabled:                      true
-          type:                         theme_info
-          title:                        Theme
-          links:
-            - title:                    Name
-              icon:                     face
-              value:                    ??theme-name
-              href:                     /pages/public/previewer/theme/
-              target:                   none
-            - title:                    Author
-              icon:                     grease-pencil
-              value:                    ??theme-author
-              href:                     ??theme-author-url
-              target:                   _blank
-            - title:                    Version
-              icon:                     numeric
-              value:                    ??theme-version
-              href:                     /pages/public/previewer/theme/
-              target:                   none
-
-      - box:
-          enabled:                      true
-          type:                         site_info
-          title:                        Site
-          links:
-            - title:                    About
-              icon:                     home-outline
-              href:                     /pages/public/about/site/
-              target:                   none
-            # - title:                    Become a Patron
-            #   icon:                     patreon
-            #   href:                     /pages/public/about/become_a_patron/
-            #   target:                   _blank
-            - title:                    Impress
-              icon:                     alert-outline
-              href:                     /pages/public/legal/en/impress/
-              target:                   none
-            - title:                    Privacy
-              icon:                     heart
-              href:                     /pages/public/legal/en/privacy/
-              target:                   none
-            - title:                    License
-              icon:                     checkbox-multiple-marked-circle-outline
-              href:                     /pages/public/legal/en/license_agreement/
-              target:                   none
-
-          # - title:                    Contact
-          #   icon:                     contact-mail
-          #   href:                     mailto:contact@jekyll.one
-          #   target:                   none
-
-
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/modules/toccer.yml

@@ -45,6 +45,7 @@ settings:
   # ----------------------------------------------------------------------------
   enabled:                              true
   log:                                  false
+  delay:                                400                                     
 
   # ----------------------------------------------------------------------------
   # MODULE settings
@@ -169,4 +170,4 @@ settings:
 
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/resources.yml

@@ -712,9 +712,15 @@ resources:
       dependencies:                     false
       pass_init_data:                   false
       data:
-        css:                            [ extensions/mmenu-light/css/mmenu-light ]
+        css:                            [                                          
+                                          extensions/mmenu-light/css/mmenu-light,
+                                          extensions/mmenu-light/css/themes/uno
+                                        ]
         files:                          [ adapter/js/mmenu.js]
-        js:                             [ extensions/mmenu-light/js/mmenu-light]
+        js:                             [
+                                          extensions/mmenu-light/js/mmenu-light,
+                                          extensions/mmenu-light/js/mmenu-light.polyfills
+                                        ]
         init_function:                  [ j1.adapter.mmenu.init ]
 
 # ==============================================================================

data/lib/starter_web/assets/themes/j1/adapter/js/mmenu.js

@@ -92,9 +92,13 @@ j1.adapter['mmenu'] = (function (j1, window) {
   // ---------------------------------------------------------------------------
   // globals
   // ---------------------------------------------------------------------------
-  var environment                 = '{{environment}}';
-  var dclFinished                 = false;
-  var moduleOptions               = {};
+  var environment         = '{{environment}}';
+  var dclFinished         = false;
+  var moduleOptions       = {};
+  var cookie_names        = j1.getCookieNames();
+  var user_state;
+  var user_session;
+  var user_data;
   var _this;
   var logger;
   var logText;
@@ -123,15 +127,19 @@ j1.adapter['mmenu'] = (function (j1, window) {
         module_name: 'j1.adapter.mmenu',
         generated:   '{{site.time}}'
       }, options);
+
+      // -----------------------------------------------------------------------
+      // globals
+      // -----------------------------------------------------------------------
       _this         = j1.adapter.mmenu;
       logger        = log4javascript.getLogger('j1.adapter.mmenu');
 
       // -----------------------------------------------------------------------
       // options loader
       // -----------------------------------------------------------------------
-      var navMenuOptions = {};
-
-      navMenuOptions     = $.extend({}, {{nav_mmenu_options | replace: '=>', ':' }});
+      var navMenuOptions = $.extend({}, {{nav_mmenu_options | replace: '=>', ':' }});
+      var xhr_data_path;
+      var menu_id;
 
       // save config settings into the mmenu object for global access
       //
@@ -139,80 +147,235 @@ j1.adapter['mmenu'] = (function (j1, window) {
 
       // Load (individual) frontmatter options (currently NOT used)
       //
-      if (options  != null) { var frontmatterOptions = $.extend({}, options) }
+      if (options != null) { var frontmatterOptions = $.extend({}, options) }
 
       _this.setState('started');
       logger.info('state: ' + _this.getState());
       logger.info('module is being initialized');
 
+      // jadams, 2020-06-24: Set max_count to 100 what cause to wait 2.5s
+      // for J1 Navigator to finish (init)
+      //
+      var interval_count = 0;
+      var max_count      = 100;
+
+      var dependencies_met_navigator = setInterval(function() {
+        interval_count += 1;
+        if ( j1.adapter.navigator.getState() == 'finished' ) {
+          logger.info('dependencies of module navigator met for: mmenu');
+          logger.info('dependencies of module navigator met after: ' + interval_count * 25 + ' ms');
+          j1.adapter.mmenu.mmenuLoader(navMenuOptions);
+          clearInterval(dependencies_met_navigator);
+        }
+        if (interval_count > max_count) {
+          logger.warn('dependency check failed for module: navigator');
+          logger.warn('dependencies of module navigator met after: ' + interval_count * 25 + ' ms');
+          clearInterval(dependencies_met_navigator);
+          j1.adapter.mmenu.mmenuLoader(navMenuOptions);
+        }
+      }, 25);
+
+    }, // END init
+
+    // -------------------------------------------------------------------------
+    // MMenu Loader
+    // -------------------------------------------------------------------------
+    mmenuLoader: function (mmOptions) {
+      var menu_id;
+      var xhr_data_path;
+
+      _this.setState('loading');
+      logger.info('status: ' + _this.getState());
+      logger.info('load HTML data for navs and drawers');
+
+      {% assign id_list = "" %}
+
       // -----------------------------------------------------------------------
-      // data loader
+      // Load HTML data (AJAX)
       // -----------------------------------------------------------------------
+      // jadams, 202-06-24: Promise (chain) if $.when seems NOT to work correctly.
+      // It semms a chain using .then will be a better solution to make it sure
+      // that the last Deferred set the state to 'data_loaded'.
+      // Found the final state randomly set to 'null' what prevent the module
+      // to run mmenuInitializer.
+      // Workaround: Set 'data_loaded' to be returned by all Deferred in
+      // the chain.
+      // See: https://stackoverflow.com/questions/5436327/jquery-deferreds-and-promises-then-vs-done
+      //
+      {% comment %} Modify chain
+      --------------------------------------------------------------------------
+        {% if forloop.last %}'data_loaded'{% else %}'null'{% endif %}){% if forloop.last %}{% else %},{% endif %}
+      to
+        {% if forloop.last %}'data_loaded'{% else %}'data_loaded'{% endif %}){% if forloop.last %}{% else %},{% endif %}
+      -------------------------------------------------------------------------- {% endcomment %}
       $.when (
-        j1.xhrData ( // mmenu
-          'j1.adapter.mmenu', {
-          xhr_container_id: navMenuOptions.xhr_container_id,
-          xhr_data_path:    navMenuOptions.xhr_data_path },
-          'mmenu_loaded'))
-      .done (function (mmenu) {
-      // -----------------------------------------------------------------------
-      // core initializer
-      // -----------------------------------------------------------------------
-        var dependencies_met_mmenu_loaded = setInterval (function () {
-          if (mmenu && _this.getState() === 'mmenu_loaded') {
-            const menu_selector = document.querySelector( '#' + navMenuOptions.xhr_container_id );
-            const navbar_toggler = document.querySelector( "#navbar-toggler" );
+      {% for item in nav_mmenu_options.menus %} {% if item.menu.enabled %}
+      {% assign menu_id       = item.menu.xhr_container_id %}
+      {% assign xhr_data_path = item.menu.xhr_data_path %}
 
+        j1.xhrData (
+          'j1.adapter.mmenu', {
+          xhr_container_id: "{{menu_id}}",
+          xhr_data_path:    "{{xhr_data_path}}" },
+          {% if forloop.last %}'data_loaded'{% else %}'data_loaded'{% endif %}){% if forloop.last %}{% else %},{% endif %}
+
+      {% endif %}
+      {% capture id_list %}{{id_list}}{{menu_id}}{% if forloop.last %}{% else %},{% endif %} {% endcapture %}
+      {% endfor %} // ENDFOR menus
+      ).done (function ({{id_list}}) {
+        // ---------------------------------------------------------------------
+        // Initialize MMenu Navs and Drawers
+        // ---------------------------------------------------------------------
+        var dependencies_met_mmenu_initialized = setInterval (function () {
+          if (_this.getState() === 'data_loaded') {
+            logger.info('load HTML data (AJAX): finished');
             _this.setState('processing');
             logger.info('status: ' + _this.getState());
-            logger.info('initialize mmenu core');
+            logger.info('initialize navs and drawers');
+            j1.adapter.mmenu.mmenuInitializer(mmOptions);
+            clearInterval(dependencies_met_mmenu_initialized);
+          }
+        }); // END dependencies_met_mmenu_loaded
+      }); // END done
+    }, // END dataLoader
 
-            const menu = new MmenuLight (
+    // -------------------------------------------------------------------------
+    // MMenu Initializer
+    // -------------------------------------------------------------------------
+    mmenuInitializer: function (mmOptions) {
+      var menu_id;
+      var xhr_data_path;
+
+      {% for item in nav_mmenu_options.menus %} {% if item.menu.enabled %}
+
+      {% assign menu_id = item.menu.xhr_container_id %}
+      menu_id           = "{{menu_id}}";
+      xhr_data_path     = "{{item.menu.xhr_data_path}}";
+
+      // Create an mmenu instance if id exists: {{menu_id}}
+      if ($('#{{menu_id}}').length) {
+
+        logger.info('mmenu is being initialized on id: {{menu_id}}');
+
+        {% if item.menu.content.type == "navigation" %}
+        // Create an mmenu instance of type NAVIGATION
+        logger.info('found content type: NAVIGATION');
+        // ---------------------------------------------------------------------
+        // menu initializer (NAVIGATION)
+        // ---------------------------------------------------------------------
+        logger.info('initialize mmenu on id: #{{menu_id}}');
+        var dependencies_met_{{menu_id}}_loaded = setInterval (function () {
+          if ({{menu_id}}) {
+            const menu_selector = document.querySelector('#{{menu_id}}');
+            const mmenu_{{menu_id}} = new MmenuLight (
               menu_selector,
-              '(max-width: ' + navMenuOptions.mmenu_plugin.max_width +'px)', {
+              '(max-width: ' + mmOptions.mmenu_plugin.max_width +'px)', {
               // plugin options
-              node:             navMenuOptions.mmenu_plugin.node,
-              mediaQuery:       navMenuOptions.mmenu_plugin.mediaQuery
+              node:             mmOptions.mmenu_plugin.node,
+              mediaQuery:       mmOptions.mmenu_plugin.mediaQuery
             });
 
-            const navigator = menu.navigation ({
-              // navigator options
-              selected:         navMenuOptions.mmenu_navigator.selected,
-              slidingSubmenus:  navMenuOptions.mmenu_navigator.slidingSubmenus,
-              title:            navMenuOptions.mmenu_navigator.title,
-              theme:            navMenuOptions.mmenu_navigator.theme
+            const drawer_{{menu_id}} = mmenu_{{menu_id}}.offcanvas ({
+              // drawer options
+              position: mmOptions.mmenu_drawer.position
             });
 
-            const drawer = menu.offcanvas ({
-              // drawer options
-              position: navMenuOptions.mmenu_drawer.position
+            const navigator_{{menu_id}} = mmenu_{{menu_id}}.navigation ({
+              // navigator options
+              selected:         mmOptions.mmenu_navigator.selected,
+              slidingSubmenus:  mmOptions.mmenu_navigator.slidingSubmenus,
+              title:            mmOptions.mmenu_navigator.title,
+              theme:            mmOptions.mmenu_navigator.theme
             });
 
             // Toggle Bars (Hamburger) for the NavBar to open|close
             // the mmenu drawer
-            $('button.navigator.navbar-toggler').each(function(e) {
+            $('{{item.menu.content.toggler}}').each(function(e) {
               var $this = $(this);
 
               $this.on('click', function(e){
-                var toggler = this;
+                const toggler_{{menu_id}} = this;
 
                 // TODO: Animated toggle button
                 //
-                $('button.navigator.navbar-toggler.animated').toggleClass('fadeIn');
-                $('button.navigator.navbar-toggler.animated').toggleClass('rotateIn')
+                $('{{item.menu.content.toggler}}').toggleClass('fadeIn');
+                $('{{item.menu.content.toggler}}').toggleClass('rotateIn')
 
                 $('.mdi', this).toggleClass('mdi-menu');
                 $('.mdi', this).toggleClass('mdi-close');
                 e.preventDefault();
-                (toggler.t = !toggler.t) ? drawer.open() : drawer.close();
+                (toggler_{{menu_id}}.t = !toggler_{{menu_id}}.t)
+                  ? drawer_{{menu_id}}.open()
+                  : drawer_{{menu_id}}.close();
               });
             });
-            clearInterval(dependencies_met_mmenu_loaded);
-
+            clearInterval(dependencies_met_{{menu_id}}_loaded);
+            logger.info('initializing mmenu finished on id: #{{menu_id}}');
           }; // END mmenu_loaded
         }); // END dependencies_met_mmenu_loaded
-      }); // END done
-    }, // END init
+        {% endif %} // ENDIF content_type: NAVIGATION
+
+        {% if item.menu.content.type == "drawer" %}
+          // Create an mmenu instance of type HTML
+          logger.info('found content type: DRAWER');
+          // -------------------------------------------------------------------
+          // menu initializer (DRAWER)
+          // -------------------------------------------------------------------
+          logger.info('initialize mmenu on id: #{{menu_id}}');
+          var dependencies_met_{{menu_id}}_loaded = setInterval (function () {
+            if ({{menu_id}}) {
+              const menu_selector = document.querySelector('#{{menu_id}}');
+
+              const mmenu_{{menu_id}} = new MmenuLight (
+                menu_selector,
+                '(max-width: ' + mmOptions.mmenu_plugin.max_width +'px)', {
+                // plugin options
+                node:             mmOptions.mmenu_plugin.node,
+                mediaQuery:       mmOptions.mmenu_plugin.mediaQuery
+              });
+
+              const drawer_{{menu_id}} = mmenu_{{menu_id}}.offcanvas ({
+                // drawer options
+                position: "{{item.menu.drawer.position}}"
+              });
+
+              // Toggler for the MMenu tocbar to open|close the toc drawer
+              $('{{item.menu.content.toggler}}').each(function(e) {
+                var $this = $(this);
+
+                $this.on('click', function(e) {
+                  var toggler_{{menu_id}} = this;
+                  var hasClass;
+
+                  // check if the toggler should be activated
+                  // e.g for TOC only if clas js-toc-content is found
+                  //
+                  if ('{{item.menu.content.toggler_activated}}' != 'always') {
+                    hasClass = $('main').hasClass('{{item.menu.content.toggler_activated}}');
+                  } else {
+                    hasClass = true;
+                  }
+                  if (hasClass) {
+                    // Toggle button animation
+                    $('{{item.menu.content.toggler}}').toggleClass('{{item.menu.content.toggler_animation}}')
+
+                    e.preventDefault();
+                    (toggler_{{menu_id}}.t = !toggler_{{menu_id}}.t)
+                      ? drawer_{{menu_id}}.open()
+                      : drawer_{{menu_id}}.close();
+                  } // END if hasclass
+                });
+              });
+              clearInterval(dependencies_met_{{menu_id}}_loaded);
+          }; // END if menu_loaded
+        }); // END dependencies_met_mmenu_loaded
+        logger.info('initializing mmenu finished on id: #{{menu_id}}');
+        {% endif %} // ENDIF content_type: DRAWER
+        } // END menus|drawers
+
+      {% endif %} // ENDIF menu enabled
+      {% endfor %} // ENDFOR menus
+    }, // END mmenuInitializer
 
     // -------------------------------------------------------------------------
     // messageHandler