nzta/promo-overlay

A module for creating promotion pages

Maintainers

Details

github.com/NZTA/promo-overlay

Homepage

Source

Issues

Installs: 2 286

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 5

Forks: 2

Open Issues: 0

Language:JavaScript

Type:silverstripe-vendormodule

2.0.1 2023-05-04 22:54 UTC

Requires

Requires (Dev)

BSD-3-Clause 4ce8242d28249e4583c025f425d13f0a930cdbc9

cmssilverstripecampaignpromotion

This package is auto-updated.

Last update: 2024-04-05 00:46:16 UTC

README

Requirements

SilverStripe 4.x

Version info

The master branch of this module is currently aiming for SilverStripe 4.x compatibility

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

  • Ability to carousel through multiple slides

Ability to add a background image to a slide

Installation

`composer require nzta/promo-overlay`

Setup

  1. You will need to include the <% include PromoOverlay IsOverlay=true,PromoSlides=$ActivePromoSlides %> template into your page.
  2. You will then need to add the <% include JSAppData %> to the <head> of your templates.
  3. Add some basic custom styles to make the overlays appear nicely.

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