README

Warning

This module is DEPRECATED. The main issue this module addressed (bfcache compatibility in Magento 2) is being solved in the Magento core via Pull Request #40750. We recommend migrating to the official Magento solution or using the patch provided in the PR.

Deprecation & Migration Guide

This project is no longer maintained. The core functionality is now better served by the upcoming official Magento 2 implementation.

Why Deprecate?

The primary goal of this module was to enable Back/Forward Cache (bfcache) support and modern browser features in Magento 2. These are now being addressed directly in the Magento core:

• Magento Core PR: magento/magento2#40750
• Patch Suggestion: You can apply the fix manually using the patch suggested here.
• Hyvä Docs: The solution is also documented on the Hyvä Docs which points to the Magento 2 PR.
• Mage Script: This patch is also applied automatically via the Mage Script until it is merged into the Magento core.

Migration

If you are currently using this module, we recommend:

1. Uninstalling this module:

   bin/magento module:disable Siteation_Pagespeed
   composer remove siteation/magento2-pagespeed

2. Applying the official Magento 2 patch (as linked above) to your project until it is officially merged into a stable release.
3. Review the Hyvä Docs on bfcache for additional frontend-specific optimizations.

A Magento 2 module that leverages modern web performance technologies including Back/Forward Cache (bfcache), Page Prerendering, and View Transitions API to dramatically improve Core Web Vitals and overall page speed performance.

This module provides optimizations to enhance your store's loading times and create seamless user experiences.

Installation

Install the package via;

composer require siteation/magento2-pagespeed
bin/magento module:enable Siteation_Pagespeed

How to use

The Pagespeed has the bfcache feature enabled by default.

For the speculation rules and view transitions you need to enable them from the configuration.

each option can be found in the Magento admin panel under Stores > Configuration > Siteation > Pagespeed.

Use with Hyvä Themes

This module is fully compatible with Hyvä Themes, allowing you to take advantage of its performance optimizations while using this modern frontend solution.

But do note Hyvä Themes has its own speculation rules and view transitions, so for Hyvä it is best to disable the default speculation rules and view transitions provided by Hyvä in favor of this module.

Improved UX with bfcache

While this module makes sure to reload the customer data, it can not close the menus and other modals automatically.

This requires a update in the code of this component to handle the closing of these elements when the page is restored from the bfcache.

For this you can use the following snippets:

<nav
    x-data="initMenuMobile<?= $escaper->escapeHtml($uniqueId) ?>()"
    @keydown.window.escape="closeMenu()"
    class="z-20 order-2 sm:order-1 lg:order-2 navigation lg:hidden w-12 h-12"
    aria-label="<?= $escaper->escapeHtmlAttr(__('Site navigation')) ?>"
    role="navigation"
+++ x-bind="eventListeners"
>

const initMenuMobile<?= $escaper->escapeHtml($uniqueId) ?> = () => {
    return {
        mobilePanelActiveId: null,
        open: false,
        init() {
            this.setActiveMenu(this.$root);
        },
+++     eventListeners: {
+++		    ['@pageshow.window'](event) {
+++             if (event.persisted) {
+++                 this.open = false
+++             };
+++         }
+++     },

    this._on(document, 'keydown', e => {
        if (e.key === 'Escape' && $('html').hasClass('nav-open')) {
            this.close();
        }
    });

+++ this._on(window, "pageshow", e => {
+++     if (e.persisted) {
+++         this.close();
+++     }
+++ });
},

For Luma sadly we have no equivalent solution available at this time.