Build Single Page Applications using the Django-CMS plugin system
The Swiss army knife for working with Django-CMS plugins.
DjangoCMS-Cascade is a collection of plugins for Django-CMS placeholders. Instead of creating one database model for each CMS plugin, Cascade shares one database model for all of them. The payload then is stored inside a JSON field instead of declaring each attribute explicitly. This furthermore prevents us to handle all kind of nasty database migration problems.
Version 2.0 only supports Django versions 3.1 and higher.
Backward compatibility had to be dropped, because version 2.0 now fully supports the native internal
JSONFieldas offered by Django version 3.1. It hence is not possible to run a version of Cascade which can switch between those field types.
From a functional point of view, there is no difference to version 1.3.7.
After upgrading, run
./manage.py migrate cmsplugin_cascade. It will rewrite the field type of all
JSONFields to Django's internal
JSONFieldwithout modifying its content. For safety reasons, it is highly recommended to backup the database before migrating.
Since Cascade keeps track on the widths of all columns,
and elements can be rendered in a responsive way, so that the browser only loads the image required for the visible viewport.
Using a JSON field to store the payload gives us much more flexibility. We can for instance enrich our plugins with additional attributes, configured during runtime. This can be used to optionally share attributes across different plugins (referenced by an alias name), add CSS classes and styles, or offer alternative rendering templates.
Another nice aspect of this approach is, that we can override the functionality used to set links onto pages which are not part of the CMS. This is specially useful, since we do not want to re-implement this functionality for all plugins, which require links, ie. images, pictures, buttons and text-links.
Since the payload of plugins is already serialized, we can even copy them from one site to another site supporting djangocms-cascade.
Find detailed documentation on ReadTheDocs.
Please see the Release Notes before upgrading from an older version.
DjangoCMS-Cascade is very modular, keeping its CMS modules in functional groups. These groups have to be activated independently in the project's
settings.py. It also is possible to activate only certain plugins out of a group. Currently there are two such groups,
cmsplugin_cascade.bootstrap4, but this list could be extended by say, Foundation, Angular Material or whatever other CSS framework you prefer.
Each Cascade plugin can be styled individually. The site-administrator can specify which CSS styles and CSS classes can be added to each plugin. Then the page-editor can pick one of the allowed styles to adopt his elements accordingly.
Each Cascade plugin can be configured by the site-administrator to share some or all of its data fields. This for instance is handy, to keep references onto external URLs in a central place. Or is can be used to resize all images sharing a cetrain property in one go.
It is even possible to group plugins into seperate evaluation contexts. This for instance is used to render different Plugins, depending on whether a user is authenticated or anonymous.
In modern web development, images must adopt to the column width in which they are rendered. Therefore the
tag, in addition to the well known
srcattribute, also accepts additional
srcset's, one for each media query. Here djangocms-cascade calculates the required widths for each image, depending on the current column layout considering all media breakpoints.
This is also implemented for theelement with all of it's children, normally .
It also supports resolutions of more than one physical pixel per logical pixel as found in Retina displays.
and elements in a responsive way, so that more than one image URL points onto the resized sources, one for each viewport using the
srcsettags or the elements.
In addition to easily implement any kind of plugin, DjangoCMS-Cascade makes it possible to add reusable helpers. Such a helper enriches a plugin with an additional, configurable functionality:
idtag, CSS classes and inline styles. This is configurable on a plugin and site base.
If someone wants to start a subproject for a CSS framework, other than Bootstrap-3/4.
If you are a native English speaker, please check the documentation for spelling mistakes and grammar, since English is not my mother tongue.