logicbrush/silverstripe-herocontent

A module for the SilverStripe CMS which allows you to add a big block of important content at the top of the page.

v1.1.0 2024-09-25 14:37 UTC

Requires

• php: ^7.4||^8.0
• jonom/focuspoint: *
• silverstripe/asset-admin: *
• silverstripe/cms: ^4.0||^5.0
• symbiote/silverstripe-gridfieldextensions: *

Requires (Dev)

• cmrcx/phptidy: *
• logicbrush/metrics: *
• phpunit/phpunit: ^8.0||^9.5
• silverstripe/sqlite3: *

BSD-3-Clause

• John Learn

• banner
• silverstripe
• hero

README

A module for the SilverStripe CMS which allows you to add a big block of (optionally rotating) content at the top of the page as is typical with landing pages.

Why?

When creating landing pages, we often want to add something flashy at the top of the page to quickly capture visitor interest. This module allows us to configure this using a common backend, but customize display on a client-by-client basis.

Installation

composer require "logicbrush/silverstripe-herocontent"

General Usage

Installation of this module will add a Hero content tab to all of your pages wihin the CMS. Here, you can select a background image and set up zero or more "slides" that will rotate through using Slick.js. Each slide consists of an image and a block of HTML content. You can configure how these are rendered in your theme's template files.

Add $HeroImage or $HeroImage.URL in your template file to reference the hero background image. We frequently like to add it with inline CSS to our body tag, usually with a transparent overlay and background-size: cover and background-attachment: fixed. That way it will appear behind all content on the page and stick to the top of the browser window. You could alternatively apply it to an independent div.

Use $HeroContent in your template to render your slides. If you wish, you can copy the Slides.ss template file into your theme and modify to your liking. You can place this either above or below your regular $Content as you like. Or, you can leave it out entirely if you don't need rotating content.