Skip to main content

Djangocms plugin for owl carousel v1

Project description

djangocms-owl is a reuseable plugin for django-cms that implements the JavaScript carousel library Owl Carousel. Version 1 of Owl Carousel is supported.

Dependencies

  • Djangocms>=3.0

  • Django>=1.6

Installation

Install Djangocms-owl from Pypi.

pip install djangocms-owl

Add Djangocms_owl to INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'djangocms_owl',
    ...
)

Django 1.6 and/or South users will need to add the following to ensure migration compatibility.

SOUTH_MIGRATION_MODULES = {
    ...
    'djangocms_owl': 'djangocms_owl.south_migrations',
    ...
}

Owl Carousel has a dependency on JQuery Docs that is not currently included within this package. Add a copy will need adding to a template such as the base.html.

<script src="jquery.min.js"></script>

Configuration

CSS classes can be added to the plugin via a select box by using the DJANGOCMS_OWL_STYLES settings tuple.

DJANGOCMS_OWL_STYLES = (
    ('style1', 'Style 1'),
    ('style2', 'Style 2'),
)

djangocms_owl/default.html is rendered by default. The user can select custom templates if the following tuple is set as the example below demonstrates.

DJANGOCMS_OWL_TEMPLATES = (
    ('template1', 'Template 1'),
    ('template2', 'Template 2'),
)

Restrict the plugins available to Owl Carousel

DJANGOCMS_OWL_CHILD_CLASSES = (
    'PicturePlugin',
)

Todo

  • Add settings to disable inclusion of CSS

  • Add settings to disable inclusion of JS

  • Add support for owl carousel 2

  • Expand on the included Owl Carousel configuration options

Inspiration

Contributions

  • Lee Solway

History

Bug Fix. 0.1.3 (2015-07-06) 0.1.2 (2015-07-06)

  • Converted README.md to README.rst

  • Added AppConf

  • Added DJANGOCMS_CHILD_CLASSES configuration option

  • Updated the initial Django migration dependency to CMS 0001 initial

Documentation updates. 0.1.1 (2015-07-05)

First release on PyPI. 0.1.0 (2015-07-03)

Project details


Download files

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

Source Distribution

djangocms-owl-0.1.3.zip (33.1 kB view details)

Uploaded Source

File details

Details for the file djangocms-owl-0.1.3.zip.

File metadata

  • Download URL: djangocms-owl-0.1.3.zip
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for djangocms-owl-0.1.3.zip
Algorithm Hash digest
SHA256 3ff1f1953d9b991b4d13fa3e15532661d451f8d6d3522e6260119d2ac3068761
MD5 98f60412e5799867f5a43a5075528532
BLAKE2b-256 cbcb40ddf3dfa5369f6491729b0cf04cb7c7ad04ba7e00964e3c7e81806db18b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page