cmsplugin-css-background 0.1.0

django CMS plugin for configuring background images in edit mode via CSS rules.

Requirements

• Django 1.8+
• django CMS 3.3+

Installation

In your Python environment run

$ pip install cmsplugin-css-background

This will install the latest stable version of the plugin package. To install the package’s latest repository snapshot run

$ pip install -e git+https://github.com/alexmalykh/cmsplugin-css-background.git@master#egg=cmsplugin-css-background

Then add the plugin to INSTALLED_APPS list:

INSTALLED_APPS = [
    ...,
    'cmsplugin_css_background',
]

and finally, roll database migrations:

$ python manage.py migrate cmsplugin_css_background

Usage

1. Define a placeholder in your template this way:

   {% with css_selector = '#some-element' %}
       {% placeholder 'some_element_background' %}
   {% endwith %}
   

   The placeholder might be located almost anywhere, not necessarily within/beside the element you want to change background. But it is recommended to keep both together for convenience.

   Optionally, you might add an entry for your placeholder to PLACEHOLDER_CONF settings dictionary to restrict allowed plugin types to CSS Background and assign a readable title to the placeholder’s dragbar instead of generated Some_Element_Background.

2. Add an instance of CSS Background from Generic plugin group to the placeholder in CMS admin.

   Note

   This package is aware of cmsplugin-filer. If the latter is installed and enabled, then you also get extra CSS Background plugin available in Filer plugins group. This option allows you to use images managed by Filer.

The plugin is rendered as <style /> HTML element in-place, like this:

<style type="text/css">
#some-element {
    /* here 'background-' CSS rules go */
    ...
}
</style>

There is a single template, located at cms/plugins/css-background.html and it takes a single extra context variable css_selector which defines the element(s) to assign background settings.

By default, background properties are rendered as a list of separate rules, but there is one-liner option too. To change the way plugin rendered override the plugin template and replace

{{ instance.as_separate_rules }}

with

{{ instance.as_single_rule }}