burnbright/gridstructuredcontent

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
This package is abandoned and no longer maintained. The author suggests using the burnbright/silverstripe-gridstructuredcontent package instead.

Allows structuring SilverStripe CMS Content into CSS grid system layouts

dev-master 2019-01-06 04:17 UTC

This package is auto-updated.

Last update: 2019-03-24 07:34:41 UTC


README

The layout-with-tables killer.

Why

Problem: structuring content beyond single columns.

Existing solutions:

  • pre-define template(s) and additional db fields for holding content.
  • use tables within TinyMCE Content editor.
  • define content in seperate DataObjects, eg Page Elements Module
  • SilverStripe Blocks

New solution: use the CSS grids we've come to know and love

This can be done by splitting up 'Content' field with a short delimiter string, and also storing a (sub)grid structure. The grid strucutre could be predefined by a designer, or edited by the user. This means defining the appropriate nesting of rows, columns, and width each column spans.

The same TinyMCE editor interface can be used, with the only difference being that you choose what part of the grid you are working on. On save, the seperate grid sections are concatenated into the 'Content' db field, and are delimited by a front-end invisible string.

When rendering on the front-end, the defined grid structure is traversed (depth first), dropping the delimited Content into the appropriate areas.

This idea relies on the fact that most grid systems are the same. Most have:

  • Predefined number of columns
  • HTML structure & CSS classes for defining grid layout

For example, here is the bootstrap structure

<div class="row">
    <div class="span4">...</div>
    <div class="span8">...</div>
</div>

Converted to a generic SilverStripe template:

<div class="row">
	<% loop Columns %>
		<div class="span{$Width}">
			$Content
		</div>
	<% end_loop %>
</div>

The minor differences between grid systems should be handled by using a slightly different row template.

Benefits:

  • Grid system agnostic: it should would work with different CSS grid systems.
  • Un-obtrusive: it doesn't require any new data objects, or fields.
  • Clever: all content is stored in 'Content' db field, therefore taking full advantage of history, rollback etc.
  • Graceful: the 'Content' field could still be displayed in a single column format with $Content, because delimiters will be hidden. This also means content summaries can still be used.

Research

List of CSS Grid Systems/Frameworks

Javascript Grid Layout Editors

Similar ideas

Screenshots

Editor

Configuration