README

Provides essential, foundational elements for building modular pages using Silverstripe CMS 5 and the Elemental module.

Requirements

Silverstripe CMS version 4 or 5
Silverstripe Elemental

Installation

Install using Composer:

composer require minimalic/silverstripe-fundamental

Refresh your database by navigating to your website's root directory in the shell and running: vendor/bin/sake dev/build "flush=all"

Or, use your base URL with: /dev/build?flush=all

Available Modules

Image Block (ModuleImage) - Block with single image banner
Hero Banner Block (ModuleHeroBanner) - Displays a hero banner featuring text overlayed on an image
Hero Split Block (ModuleHeroSplit) - Displays a hero split with image and text side-by-side. Allows switching the order

Customization

Custom Theme for ModularPage

Create your own ModularPage.ss template inside your theme's template directory at:

minimalic/Fundamental/Pages/Layout/

Custom Themes for Modules

By default the Fundamental extension uses Bootstrap 5 classes for templating.

To override default templates for modules/blocks, create your own template file (e.g., ModuleImage.ss) inside your theme's template directory at:

minimalic/Fundamental/Modules/

Alternatively copy the entire vendor/minimalic/silverstripe-fundamental/templates/ directory to your templates/ directory and customize all template overrides.

Custom options for image upload directory

By default images (modules: "Image Block", "Hero Banner Block"...) will be uploaded to images/parent-class/parent-title, where parent is the page/object holding the module. To change this behavior add to your config (e.g. inside mysite.yml):

minimalic\Fundamental\Modules\ModuleImage:
  image_directory_name: 'images'
  image_directory_sub_struct: 'class/parent'

For the image_directory_name configuration option you can chose the top directory name for uploaded files. The available options for image_directory_sub_struct are:

parent (parent page title)
class/parent (parent page class/title, default)
element (current element title)
class/element (current element class/title)

Global configuration

Set image resize quality

Set the global image quality inside your config (e.g. mysite.yml) and enable forced resampling for not-resized images (optional):

SilverStripe\Assets\File:
  force_resample: true

SilverStripe\Assets\Storage\DBFile:
  force_resample: true

SilverStripe\Core\Injector\Injector:
  SilverStripe\Assets\Image_Backend:
    properties:
      Quality: 70

Remap Local Elemental Extensions (Optional)

This step is necessary if you are already using an ElementalPageExtension and want to replace it with the page type provided by this module.

To remap existing App\Pages\ModularPage or ElementalPage (the class name of your custom Elemental page extension, if any), use the following configuration in your mysite.yml:

SilverStripe\ORM\DatabaseAdmin:
  classname_value_remapping:
    'App\Pages\ModularPage': 'minimalic\Fundamental\Pages\ModularPage'

Replace App\Pages\ModularPage with your class name. Also, ensure your existing table_name is ModularPage; if not, you should rename your table.

After rebuilding your database, you can delete these remap lines from your mysite.yml. Your existing Elemental pages should now use this module.

License

See License

minimalic / silverstripe-fundamental

Maintainers

Details