{"id":20380528,"url":"https://github.com/peterbrain/magento2-modal-overlay","last_synced_at":"2026-02-10T08:31:19.970Z","repository":{"id":57038117,"uuid":"432864942","full_name":"PeterBrain/magento2-modal-overlay","owner":"PeterBrain","description":"Display custom content from a static block in a modal","archived":false,"fork":false,"pushed_at":"2025-02-04T13:41:46.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-04T03:51:22.772Z","etag":null,"topics":["magento","magento-2","magento-extension","magento-module","magento2","magento2-extension","magento2-extension-free","magento2-module"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PeterBrain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-29T01:03:30.000Z","updated_at":"2025-02-03T15:35:42.000Z","dependencies_parsed_at":"2025-01-15T06:49:07.292Z","dependency_job_id":"7a503ab0-9388-4fab-80a2-bc7b195f2840","html_url":"https://github.com/PeterBrain/magento2-modal-overlay","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.1428571428571429,"last_synced_commit":"3c9480c59a16e989c9789e545dc70bc002b22a61"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterBrain%2Fmagento2-modal-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterBrain%2Fmagento2-modal-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterBrain%2Fmagento2-modal-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterBrain%2Fmagento2-modal-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PeterBrain","download_url":"https://codeload.github.com/PeterBrain/magento2-modal-overlay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241929767,"owners_count":20044024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magento","magento-2","magento-extension","magento-module","magento2","magento2-extension","magento2-extension-free","magento2-module"],"created_at":"2024-11-15T02:07:41.995Z","updated_at":"2026-02-10T08:31:19.933Z","avatar_url":"https://github.com/PeterBrain.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Magento 2 Module - ModalOverlay\n\nPackage name: `peterbrain/magento2-modal-overlay`\n\n- [Magento 2 Module - ModalOverlay](#magento-2-module---modaloverlay)\n  - [Main Functionalities](#main-functionalities)\n  - [Installation](#installation)\n    - [Method 1: Composer (recommended)](#method-1-composer-recommended)\n    - [Method 2: Zip file (not recommended)](#method-2-zip-file-not-recommended)\n    - [Enable \\\u0026 deploy](#enable--deploy)\n  - [Usage](#usage)\n  - [In-depth information](#in-depth-information)\n\n## Main Functionalities\n\n- Display custom content from a static block in a modal.\n- Show modal after a configurable amount of visited pages.\n\n## Installation\n\n### Method 1: Composer (recommended)\n\n```bash\ncomposer require peterbrain/magento2-modal-overlay\n```\n\n### Method 2: Zip file (not recommended)\n\n- Unzip the zip file in `app/code/PeterBrain`\n\nThis 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.\n\n### Enable \u0026 deploy\n\n```bash\nbin/magento module:enable PeterBrain_ModalOverlay\nbin/magento setup:upgrade\nbin/magento setup:static-content:deploy\nbin/magento cache:flush\n```\n\n## Usage\n\n- Enable module output in `Stores \u003e Configuration \u003e PeterBrain Extensions \u003e Modal Overlay \u003e General Configuration`\n- In Magento 2 admin, navigate to `Content \u003e Blocks` and create a new static block with the identifier `modal-overlay_popup`.\n- If the module is enabled, the static block exists and is enabled, the modal pops up:\n  - when a user visits at least three pages\n  - once per user (stored in local storage - cookieless!)\n\n## In-depth information\nThe visited pages (count) and status of modal are stored in local storage as follows:\n* `mage-cache-storage`: {\"modal-overlay\":{\"displayed\":false,\"visited_pages\":2}}\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterbrain%2Fmagento2-modal-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterbrain%2Fmagento2-modal-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterbrain%2Fmagento2-modal-overlay/lists"}