Clarify sticky nav functionality presented in 7.9.1, Fixes #213

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 9.4.1rc: 2024-03-13
+
+* Clarify sticky nav functionality presented in 7.9.1, Fixes #213 (thanks @semidivine!)
+
 ### 9.4.0: 2024-02-26
 
 * Update unit tests for WordPress Coding Standards 3.0.1

README.md

@@ -234,11 +234,7 @@ Air has a sticky navigation baked in.
 
 ##### How to enable
 
-You can enable the navigation by
-
-1. Adding sticky-nav.js to your gulpfile (already included with [Devpackages](https://github.com/digitoimistodude/devpackages) and bin/newtheme.sh start script)
-2. Uncommeting sticky-nav import in global.scss
-3. Restart gulp and save scripts.js once to compile working combined javascript file
+You can enable the sticky navigation by uncommenting navSticky() in the js/src/front-end.js file.
 
 #### WooCommerce support
 

js/src/front-end.js

@@ -10,7 +10,9 @@ import initAnchors from './modules/anchors';
 import backToTop from './modules/top';
 import initA11ySkipLink from './modules/a11y-skip-link';
 import initA11yFocusSearchField from './modules/a11y-focus-search-field';
-import { navDesktop, navClick, navMobile } from './modules/navigation';
+import {
+  navSticky, navClick, navDesktop, navMobile,
+} from './modules/navigation';
 
 // Define Javascript is active by changing the body class
 document.body.classList.remove('no-js');
@@ -31,6 +33,9 @@ document.addEventListener('DOMContentLoaded', () => {
   // navClick();
   navMobile();
 
+  // Uncomment if you like to use a sticky navigation
+  // navSticky();
+
   // Fit video embeds to container
   reframe('.wp-has-aspect-ratio iframe');
 });