nzta / promo-overlay
A module for creating promotion pages
Installs: 2 432
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 5
Forks: 2
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- silverstripe/cms: ^4 | ^5
Requires (Dev)
This package is auto-updated.
Last update: 2024-12-04 21:15:38 UTC
README
Requirements
Silverstripe CMS 5.x
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
- You will need to include the
<% include PromoOverlay IsOverlay=true,PromoSlides=$ActivePromoSlides %>template into your page. - You will then need to add the
<% include JSAppData %>to the<head>of your templates. - Add some basic custom styles to make the overlays appear nicely.
Usage
- Login to the CMS and create a 'PromoPage'
- Enter a title and content
- Ensure to tick 'Active Promo page' to enable this promo page on the front-end
- Add a 'PromoSlide' by clicking on the 'Promo Slides' tab and clicking 'Add new promo slide'
- Enter a title, content and embedded video links