1.7.0 release

config/install/localgov_base.settings.yml

@@ -2,3 +2,4 @@ localgov_base_remove_css: FALSE
 localgov_base_remove_js: FALSE
 localgov_base_add_unpublished_background_colour: TRUE
 localgov_base_add_draft_note_to_unpublished_content: FALSE
+localgov_base_header_behaviour: 'default'

config/schema/localgov_base.schema.yml

@@ -14,3 +14,12 @@ localgov_base.settings:
     localgov_base_add_draft_note_to_unpublished_content:
       type: boolean
       label: 'Add "[Draft]" to title of unpublished content.'
+    localgov_base_header_behaviour:
+      type: enum
+      label: 'Header behaviour'
+      description: 'Choose whether the header should be sticky or not.'
+      default: 'default'
+      options:
+        'default': 'Default - scrolls away with the page'
+        'sticky': 'Sticky - remains at the top of the page'
+        'appears_on_scroll': 'Scroll - appears when scrolling up'

css/components/sticky-header.css

@@ -0,0 +1,15 @@
+.sticky-header--sticky .lgd-header {
+  top: var(--lgd-sticky-header-position);
+  width: 100%;
+  z-index: 1000;
+}
+
+.sticky-header--sticky .lgd-header + * {
+  margin-top: calc(var(--lgd-sticky-header-position) + var(--lgd-sticky-header-height));
+  scroll-padding: var(--lgd-sticky-header-height);
+}
+
+.sticky-header-html,
+.sticky-header--sticky {
+  scroll-padding-top: var(--lgd-sticky-header-height);
+}

js/sticky-header.js

@@ -0,0 +1,65 @@
+(function stickyHeaderScript(Drupal) {
+  Drupal.behaviors.stickyHeader = {
+    attach: function (context) {
+      const headers = once('allSticyHeaders', '.lgd-header', context);
+
+      if (!headers) {
+        return;
+      }
+
+      headers.forEach(header => {
+        function calculatePositions() {
+          let tabsHeight = 0;
+          const tabs = header.closest('body').querySelector('.lgd-region--tabs');
+          if (tabs) {
+            tabsHeight = tabs.offsetHeight;
+          }
+
+          let displaceOffsetTop = 0;
+          const displaceOffsetTopValue = parseInt(getComputedStyle(document.documentElement).getPropertyValue('--drupal-displace-offset-top').replace('px', ''));
+          if (displaceOffsetTopValue) {
+            displaceOffsetTop = displaceOffsetTopValue;
+          }
+
+          const headerHeight = header.offsetHeight;
+          const headerPosition = displaceOffsetTop + tabsHeight;
+
+          if (header.closest('body').classList.contains('sticky-header')) {
+            document.documentElement.style.setProperty('--lgd-sticky-header-position', `${headerPosition}px`);
+            document.documentElement.style.setProperty('--lgd-sticky-header-height', `${headerHeight}px`);
+          }
+
+          if (header.closest('body').classList.contains('sticky-header--sticky')) {
+            header.style.position = 'fixed';
+          }
+        }
+
+        // Initialize oldScroll, so we can use it in the scroll event.
+        let oldScroll = window.scrollY;
+
+        function handleScroll() {
+          if (oldScroll > window.scrollY) {
+            header.closest('body').classList.add('sticky-header--sticky');
+          } else {
+            header.closest('body').classList.remove('sticky-header--sticky');
+            header.style.position = 'relative';
+          }
+          // Update oldScroll to the new scroll position after the comparison
+          oldScroll = window.scrollY;
+
+          calculatePositions();
+        }
+
+        if (header.closest('body').classList.contains('sticky-header--scroll')) {
+          window.addEventListener('scroll', handleScroll);
+        }
+
+        setTimeout(() => {
+          calculatePositions();
+        }, 50);
+
+      });
+
+    }
+  };
+})(Drupal);

localgov_base.info.yml

@@ -8,6 +8,9 @@ ckeditor_stylesheets:
 ckeditor5-stylesheets:
   - css/base/ckeditor5.css
 
+dependencies:
+  - localgov_base:localgov_base_helper
+
 regions:
   tabs: "Tabs"
   header: "Header"

localgov_base.libraries.yml

@@ -49,15 +49,14 @@ wysiwyg-styles:
     theme:
       css/components/wysiwyg-styles.css: {}
 
-header:
-  css:
-    theme:
-      css/components/header.css: {}
-
 secondary-menu:
   css:
     theme:
       css/components/secondary-menu.css: {}
+header:
+  css:
+    theme:
+      css/components/header.css: {}
 
 header-js:
   js:
@@ -67,6 +66,17 @@ header-js:
     - core/drupal.debounce
     - core/once
 
+sticky-header:
+  css:
+    theme:
+      css/components/sticky-header.css: {}
+  js:
+    js/sticky-header.js: {}
+  dependencies:
+    - core/drupal
+    - core/drupal.debounce
+    - core/once
+
 footer:
   css:
     theme:

localgov_base.theme

@@ -46,13 +46,52 @@ function localgov_base_form_system_theme_settings_alter(&$form, FormStateInterfa
     '#default_value' => theme_get_setting('localgov_base_add_draft_note_to_unpublished_content'),
     '#description'   => t('This adds the word "Draft" to the title of any unpublished content. This is useful if you have removed the pink background from unpublished content.'),
   ];
-
   $form['localgov_base_show_back_to_top_link'] = [
     '#type'          => 'checkbox',
     '#title'         => t('Display a "Back to Top" link on long pages.'),
     '#default_value' => theme_get_setting('localgov_base_show_back_to_top_link'),
     '#description'   => t('This adds a link to the beginning of the page content (<code>#main-content</code>).'),
   ];
+  $form['localgov_base_header_behaviour'] = [
+    '#type' => 'radios',
+    '#title' => t('Header behaviour'),
+    '#default_value' => theme_get_setting('localgov_base_header_behaviour'),
+    '#options' => [
+      'default' => t('Default - scrolls away with the page'),
+      'sticky' => t('Sticky - remains at the top of the page'),
+      'appears_on_scroll' => t('Scroll - appears when scrolling up the page'),
+    ],
+    '#description' => t('Select how you want the header to behave. This setting only apply to anonymous users.'),
+  ];
+
+}
+
+/**
+ * Implements hook_preprocess_html().
+ */
+function localgov_base_preprocess_html(&$variables) {
+  // Add the 'sticky-header' library if the sticky header setting is enabled.
+  if (theme_get_setting('localgov_base_header_behaviour') !== 'default') {
+
+    // Check if the user is logged out.
+    // We have much fewer calculations if we keep this to anonymous users only.
+    if (\Drupal::currentUser()->isAnonymous()) {
+      $variables['#attached']['library'][] = 'localgov_base/sticky-header';
+      $variables['attributes']['class'][] = 'sticky-header';
+      $variables['html_attributes']['class'] = [];
+      $variables['html_attributes']['class'][] = 'sticky-header-html';
+
+      // If 'sticky' is chosen add a class to the body element.
+      if (theme_get_setting('localgov_base_header_behaviour') === 'sticky') {
+        $variables['attributes']['class'][] = 'sticky-header--sticky';
+      }
+
+      // If 'scroll' is chosen add a class to the body element.
+      if (theme_get_setting('localgov_base_header_behaviour') === 'appears_on_scroll') {
+        $variables['attributes']['class'][] = 'sticky-header--scroll';
+      }
+    }
+  }
 }
 
 /**

modules/localgov_base_helper/README.md

@@ -0,0 +1,8 @@
+## INTRODUCTION
+
+The LocalGov Base Helper module is a module to allow us to add update hooks and other module functionality to LocalGov Base.
+
+## INSTALLATION
+
+Install as you would normally install a contributed Drupal module.
+See: https://www.drupal.org/node/895232 for further information.

modules/localgov_base_helper/localgov_base_helper.info.yml

@@ -0,0 +1,5 @@
+name: 'LocalGov Base Helper'
+type: module
+description: 'Adds update hooks to LocalGov Base.'
+package: LocalGov Drupal
+core_version_requirement: ^10 || ^11

modules/localgov_base_helper/localgov_base_helper.install

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for LocalGov Base Helper.
+ */
+
+/**
+ * Implements hook_install().
+ */
+function localgov_base_helper_install() {
+  $theme_handler = \Drupal::service('theme_handler');
+  // Check if the 'localgov_base' theme is available.
+  if ($theme_handler->themeExists('localgov_base')) {
+    // Now, check if it is enabled.
+    // If not yet enabled, these settings will be taken from the theme's
+    // /config/install directory, instead of here.
+    $theme = $theme_handler->getTheme('localgov_base');
+    if ($theme->status) {
+      // The theme is installed and enabled, proceed to set the config.
+      $config = \Drupal::configFactory()->getEditable('theme.localgov_base.settings');
+      if ($config->get('localgov_base_header_behaviour') === NULL) {
+        $config->set('localgov_base_header_behaviour', 'default');
+      }
+      $config->save();
+    }
+  }
+}

modules/localgov_base_helper/localgov_base_helper.module

@@ -0,0 +1,6 @@
+<?php
+
+/**
+ * @file
+ * Primary module hooks for LocalGov Base Helper module.
+ */