PHPackages                             peterbrain/magento2-modal-overlay - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. peterbrain/magento2-modal-overlay

ActiveMagento2-module[Utility & Helpers](/categories/utility)

peterbrain/magento2-modal-overlay
=================================

Display custom content from a static block in a modal

0.1.2(1y ago)141OSL-3.0PHP

Since Nov 29Pushed 1y ago1 watchersCompare

[ Source](https://github.com/PeterBrain/magento2-modal-overlay)[ Packagist](https://packagist.org/packages/peterbrain/magento2-modal-overlay)[ RSS](/packages/peterbrain-magento2-modal-overlay/feed)WikiDiscussions main Synced 4w ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

Magento 2 Module - ModalOverlay
===============================

[](#magento-2-module---modaloverlay)

Package name: `peterbrain/magento2-modal-overlay`

- [Magento 2 Module - ModalOverlay](#magento-2-module---modaloverlay)
    - [Main Functionalities](#main-functionalities)
    - [Installation](#installation)
        - [Method 1: Composer (recommended)](#method-1-composer-recommended)
        - [Method 2: Zip file (not recommended)](#method-2-zip-file-not-recommended)
        - [Enable & deploy](#enable--deploy)
    - [Usage](#usage)
    - [In-depth information](#in-depth-information)

Main Functionalities
--------------------

[](#main-functionalities)

- Display custom content from a static block in a modal.
- Show modal after a configurable amount of visited pages.

Installation
------------

[](#installation)

### Method 1: Composer (recommended)

[](#method-1-composer-recommended)

```
composer require peterbrain/magento2-modal-overlay
```

### Method 2: Zip file (not recommended)

[](#method-2-zip-file-not-recommended)

- Unzip the zip file in `app/code/PeterBrain`

This extension requires [PeterBrain Core](https://github.com/PeterBrain/magento2-peterbrain-core). Ensure that you have it installed prior to installing this module. Use Composer to install it automatically with this module.

### Enable & deploy

[](#enable--deploy)

```
bin/magento module:enable PeterBrain_ModalOverlay
bin/magento setup:upgrade
bin/magento setup:static-content:deploy
bin/magento cache:flush
```

Usage
-----

[](#usage)

- Enable module output in `Stores > Configuration > PeterBrain Extensions > Modal Overlay > General Configuration`
- In Magento 2 admin, navigate to `Content > Blocks` and create a new static block with the identifier `modal-overlay_popup`.
- If the module is enabled, the static block exists and is enabled, the modal pops up:
    - when a user visits at least three pages
    - once per user (stored in local storage - cookieless!)

In-depth information
--------------------

[](#in-depth-information)

The visited pages (count) and status of modal are stored in local storage as follows:

- `mage-cache-storage`: {"modal-overlay":{"displayed":false,"visited\_pages":2}}

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance45

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~290 days

Total

5

Last Release

460d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/82a4dff352f84e30fcf369255490dc281e9eec294691e0afef4c4a5c88443d7f?d=identicon)[PeterBrain](/maintainers/PeterBrain)

---

Top Contributors

[![PeterBrain](https://avatars.githubusercontent.com/u/3484124?v=4)](https://github.com/PeterBrain "PeterBrain (9 commits)")

---

Tags

magentomagento-2magento-extensionmagento-modulemagento2magento2-extensionmagento2-extension-freemagento2-module

### Embed Badge

![Health badge](/badges/peterbrain-magento2-modal-overlay/health.svg)

```
[![Health](https://phpackages.com/badges/peterbrain-magento2-modal-overlay/health.svg)](https://phpackages.com/packages/peterbrain-magento2-modal-overlay)
```

###  Alternatives

[knplabs/knp-menu

An object oriented menu library

1.4k55.8M285](/packages/knplabs-knp-menu)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)