Hide Header Until Needed using Headroom in Oxygen

le 26/10/2021
JAG

Updated on August 20, 2020
This members-only tutorial provides the steps to implement Headroom.js, a JavaScript library to hide the header until it is needed in Oxygen.
We shall use CSS3 animations to smoothly slide the header up when scrolling down and to slide it down when scrolling up.

Step 1
Install and activate My Custom Functionality plugin.
Connect to your hosting account using a FTP client and navigate to site’s wp-content/plugins/my-custom-functionality-master.

Upload headroom.js to the plugin’s assets/js directory.
Edit plugin.php and replace the content of custom_enqueue_files() function with
wp_enqueue_script( 'headroom', plugin_dir_url( __FILE__ ) . 'assets/js/headroom.js', '', '0.9.4', true );

Step 2
Edit your Main Catch-all Template with Oxygen.
Select the Header Builder element.
Go to Sticky and tick “Enable Sticky Header”.
Set Sticky Background Color to #ffffff.

Step 3
Add a Code Block below all other elements.
PHP & HTML:

CSS:
.animated {
-webkit-animation-duration: .5s;
-moz-animation-duration: .5s;
-o-animation-duration: .5s;
animation-duration: .5s;
-webkit-animation-fill-mode: both;
-moz-animation-fill-mode: both;
-o-animation-fill-mode: both;
animation-fill-mode: both;
will-change: transform, opacity
}

.oxy-nav-menu-prevent-overflow header.animated {
-webkit-animation-duration: 0s;
-moz-animation-duration: 0s;
-o-animation-duration: 0s;
animation-duration: 0s;
-webkit-animation-fill-mode: none;
-moz-animation-fill-mode: none;
-o-animation-fill-mode: none;
animation-fill-mode: none;
will-change: auto
}

@-webkit-keyframes slideDown {
0% {
-webkit-transform: translateY(-100%)
}
100% {
-webkit-transform: translateY(0)
}
}

@-moz-keyframes slideDown {
0% {
-moz-transform: translateY(-100%)
}
100% {
-moz-transform: translateY(0)
}
}

@-o-keyframes slideDown {
0% {
-o-transform: translateY(-100%)
}
100% {
-o-transform: translateY(0)
}
}

@keyframes slideDown {
0% {
transform: translateY(-100%)
}
100% {
transform: translateY(0)
}
}

.animated.slideDown {
-webkit-animation-name: slideDown;
-moz-animation-name: slideDown;
-o-animation-name: slideDown;
animation-name: slideDown
}

@-webkit-keyframes slideUp {
0% {
-webkit-transform: translateY(0)
}
100% {
-webkit-transform: translateY(-100%)
}
}

@-moz-keyframes slideUp {
0% {
-moz-transform: translateY(0)
}
100% {
-moz-transform: translateY(-100%)
}
}

@-o-keyframes slideUp {
0% {
-o-transform: translateY(0)
}
100% {
-o-transform: translateY(-100%)
}
}

@keyframes slideUp {
0% {
transform: translateY(0)
}
100% {
transform: translateY(-100%)
}
}

.animated.slideUp {
-webkit-animation-name: slideUp;
-moz-animation-name: slideUp;
-o-animation-name: slideUp;
animation-name: slideUp
}

.admin-bar .oxy-sticky-header-active.slideUp {
top: 0 !important;
}

JavaScript:
document.addEventListener('DOMContentLoaded', function () {
// grab an element
var myElement = document.querySelector('header');

// construct an instance of Headroom, passing the element
var headroom = new Headroom(myElement, {
tolerance: 5,
classes: {
// when element is initialised
initial: 'animated',

// when scrolling up
pinned: 'slideDown',

// when scrolling down
unpinned: 'slideUp',
},
// callback when pinned, `this` is headroom object
onPin: function () {
document.body.classList.remove('unpinned');
document.body.classList.add('pinned');
},

// callback when unpinned, `this` is headroom object
onUnpin: function () {
document.body.classList.remove('pinned');
document.body.classList.add('unpinned');
},
});

// initialize
headroom.init();
});
That’s it!

References:
http://wicky.nillia.ms/headroom.js/assets/styles/main.css?v=2
http://wicky.nillia.ms/headroom.js/playroom/

Nos experts se tiennent à votre disposition
pour répondre à vos questions et vous conseiller
dans votre projet digital.

Vous souhaitez développer une application ?

Envie d’échanger avec l’un de nos experts ? Besoin d’en savoir plus ?
En savoir plus

Recevez notre newsletter

La protection des données nous tient à cœur. JAG utilise les informations que vous fournissez afin de vous proposer des informations et du contenu pertinent sur nos produits et services. Vous pouvez vous désinscrire de ce type de communications à tout moment. Pour plus d'informations, consultez notre politique de confidentialité
© 2022 JAG Consulting, sas. Tous droits réservés.
© 2022 JAG Consulting, sas. Tous droits réservés.
4.8
Lire les 51 avis
google
Brieuc Pauly
08/09/2022

Créative, dynamique et très professionnelle, c'est à mon sens les piliers qui soutiennent cette équipe talentueuse ! Une agence à taille humaine qui privilégie la qualité et le résultat. Alors si vous souhaitez le meilleur pour votre communication adressez vous les yeux fermés à ces passionnés, plus que compétents ! (Translated by Google) Creative, dynamic and very professional, these are in my opinion the pillars that support this talented team! A human-sized agency that favors quality and results. So if you want the best for your communication, turn your eyes closed to these enthusiasts, who are more than competent!

google
Amaury Tardier
08/09/2022

Merci à Julien et son équipe, plus que satisfait par le travail fourni ! Je recommande vivement ! (Translated by Google) Thanks to Julien and his team, more than satisfied with the work provided! I highly recommend !

Ravi de travailler avec l'équipe JAG pour la gestion de mon site de e-Commerce. Equipe réactive et toujours pleine de bonnes idées pour améliorer les performances du site (Translated by Google) Glad to work with the JAG team for the management of my e-Commerce site. Responsive team always full of good ideas to improve the performance of the site

Merci à Julien pour son accompagnement dans mon projet, je recommande à 200% c est le Top (Translated by Google) Thanks to Julien for his support in my project, I recommend 200% it is the top

Excellente agence. Equipe est très pro, à l'écoute et de bon conseils. (Translated by Google) Excellent agency. The team is very professional, attentive and gives good advice.

Temps de réponse hors pair quand il y a eu un pb sur mon site, je vous recommande chaleureusement Julien :-) (Translated by Google) Unparalleled response time when there was a problem on my site, I warmly recommend Julien :-)

Charger plus
listarrow-right
Julien

Julien

Votre conseiller

I will be back soon

Une question ?

Julien
Bonjour ! Je suis Julien.
Comment puis-je vous aider?
Démarrer la conversation:
chat Live Chat