Skip to main content

A Django CMS plugin that provides responsive, full screen background media with text.

Project description


This is a simple django-cms plugin that provides responsive, full screen background media with text.

A HTML div container is added to the page that can either have a background image or video. Video backgrounds are enabled by making use of the Vide jQuery plugin. Child plugins are enabled, so text and/or hyperlinks etc can be placed on top of the background media, see usage below for more details.


To install:

pip install djangocms-background-media

Then add djangocms-background-media to your installed apps:


If you’re not already using django-filer and easy-thumbnails then these too will need to be added to your installed apps:


And run the migrations:

./ migrate

The package assume that jQuery has been added to the site already. So if you’re not using, please add to you templates/base.html:

<script src=""></script>


The background media plugin is added to a page and configured accordingly. If a background image is all that is required, then an image is uploaded, the container height can be updated, and optional overlay added and that’s all. If a video background is required then a video is uploaded and a video poster should be provided, as this is what will be displayed for mobile browsers. You’re also able to pass a JSON config object if you wish. More details of the video plugin can be viewed on Vide.

I have provided the ability to link an optional style sheet to the page, so that the plugin will work “out of the box”, if you don’t link the style sheet you will need to provide your own styling.

To add text, links or another plugin to the background media plugin, simply add the child plugins you desire.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for djangocms-background-media, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size djangocms_background_media-1.0.0-py2-none-any.whl (416.0 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size djangocms-background-media-1.0.0.tar.gz (401.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page