PHPackages                             nzta/promo-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. nzta/promo-overlay

ActiveSilverstripe-vendormodule[Utility & Helpers](/categories/utility)

nzta/promo-overlay
==================

A module for creating promotion pages

2.1.1(1y ago)12.6k↓50%2BSD-3-ClausePHPCI passing

Since Sep 10Pushed 1y ago4 watchersCompare

[ Source](https://github.com/NZTA/promo-overlay)[ Packagist](https://packagist.org/packages/nzta/promo-overlay)[ Docs](https://github.com/NZTA/promo-overlay)[ RSS](/packages/nzta-promo-overlay/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (4)Versions (7)Used By (0)

Promo Overlay
=============

[](#promo-overlay)

Requirements
------------

[](#requirements)

Silverstripe CMS 5.x

Features
--------

[](#features)

- Provides a Promo page type where Promo slides can be created
- Promo slides can be a basic slide with a title and content
- Promo slides can also be a video slide with a background video and fullscreen video pop up
- Ability for Promo page to appear as an overlay on initial visit, and when closed will not re-open until session has been reset

Upcoming features
-----------------

[](#upcoming-features)

- Ability to carousel through multiple slides

Ability to add a background image to a slide
============================================

[](#ability-to-add-a-background-image-to-a-slide)

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

[](#installation)

```
`composer require nzta/promo-overlay`

```

Setup
-----

[](#setup)

1. You will need to include the `` template into your page.
2. You will then need to add the `` to the `` of your templates.
3. Add some basic custom styles to make the overlays appear nicely.

Usage
-----

[](#usage)

1. Login to the CMS and create a 'PromoPage'
2. Enter a title and content
3. Ensure to tick 'Active Promo page' to enable this promo page on the front-end
4. Add a 'PromoSlide' by clicking on the 'Promo Slides' tab and clicking 'Add new promo slide'
5. Enter a title, content and embedded video links

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance48

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 50% 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 ~696 days

Total

5

Last Release

385d ago

Major Versions

1.0.1 → 2.0.02018-10-15

### Community

Maintainers

![](https://www.gravatar.com/avatar/ff99459f7f2ca26bdf0fa8e4b43a971c28d8f2bf6f588eda2d239a6a8bf5b7ee?d=identicon)[NZTA](/maintainers/NZTA)

---

Top Contributors

[![pjayme](https://avatars.githubusercontent.com/u/27745093?v=4)](https://github.com/pjayme "pjayme (7 commits)")[![phalkunz](https://avatars.githubusercontent.com/u/318116?v=4)](https://github.com/phalkunz "phalkunz (5 commits)")[![ishannz](https://avatars.githubusercontent.com/u/20032948?v=4)](https://github.com/ishannz "ishannz (2 commits)")

---

Tags

silverstripecmscampaignpromotion

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/nzta-promo-overlay/health.svg)

```
[![Health](https://phpackages.com/badges/nzta-promo-overlay/health.svg)](https://phpackages.com/packages/nzta-promo-overlay)
```

###  Alternatives

[axllent/silverstripe-cms-tweaks

Several CMS usability improvements

1826.2k1](/packages/axllent-silverstripe-cms-tweaks)

PHPackages © 2026

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