toastnz/quickblocks

Silverstripe content blocks module

6.0.1 2022-08-05 04:04 UTC

Requires

• axllent/silverstripe-form-fields: ^1.6
• composer/installers: *
• silverstripe/cms: ^4
• silverstripe/framework: ^4
• symbiote/silverstripe-gridfieldextensions: ^3.1
• toastnz/linkable: ^2
• toastnz/youtubefield: ^2
• undefinedoffset/sortablegridfield: ^2.1

BSD-3-Clause

• Jaydn de Graaf
• Danae Miller-Clendon
• Emmanuel Davies

• modular
• silverstripe
• Content Blocks

README

Simple content blocks system. Nothing fancy, easy to implement.

Requirements

• silverstripe/cms 4.0.x
• silverstripe/framework 4.0.x
• symbiote/silverstripe-gridfieldextensions 3.1.1
• edgarindustries/youtubefield 1.1
• sheadawson/silverstripe-linkable 2.0.x-dev

Installation

Add the following to your config.yml:

Page:
  extensions:
    - Toast\QuickBlocks\QuickBlocksExtension

Optionally:

PageController:
  extensions:
    - Toast\QuickBlocks\QuickBlocksControllerExtension

Use Page or other class that extends SiteTree.

In your Layout/Page.ss template, add the following:

<% loop $ContentBlocks %>
    $ForTemplate
<% end_loop %>

Configuration

Add / remove available block classes

Toast\QuickBlocks\QuickBlocksExtension:
  available_blocks:
    - Toast\QuickBlocks\TextBlock

Create a custom block

Extend QuickBlock to create a new block type.

<?php
 
namespace Toast\QuickBlocks;
 
class MyBlock extends QuickBlock
{
    private static $singular_name = 'My Block';
    private static $plural_name = 'My Blocks';
    private static $icon = 'mysite/images/blocks/custom.png';
    
    private static $db = [
        'Content' => 'HTMLText'
    ];

}

/themes/default/templates/Toast/QuickBlocks/MyBlock.ss:

<%-- Your block template here --%>

<h2>$Title</h2>
$Content

Todo:

• Template global providers
• Zoning
• Duplicate handlers
• Tests
• Through tables for more advanced versioning