Skip to main content

A Django CMS Slider Plugin with Slick

Project description

https://badge.fury.io/py/djangocms-slick-slider.svg https://travis-ci.org/oesah/djangocms-slick-slider.svg?branch=master https://codecov.io/gh/oesah/djangocms_slick_slider/branch/master/graph/badge.svg

A Django CMS Slider Plugin with Slick Slider.

Features

  • Add a Slick Slider to any page via Django CMS Plugin
  • Change/set Slick options via JSONField
  • Set some styling options such as color

CMS

alternate text

Admin Form

alternate text

Output

alternate text

Documentation

The full documentation is at https://djangocms-slick-slider.readthedocs.io.

Quickstart

Install djangocms_slick_slider:

pip install djangocms-slick-slider

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'djangocms_slick_slider.apps.DjangocmsSlickSliderConfig',
    ...
)

Example project

You can quickly get an example project up to test / develop the plugin.

If you have virtualenvwrapper installed:

git clone https://github.com/oesah/djangocms_slick_slider.git
cd example
mkvirtualenv my_project_env
pip install -r requirements.txt
python manage.py runserver

Visit your homepage (usually http://localhost:8000).

User: admin Password: adminadmin

You should see some instances of the Slick Slider plugin. You can play around to see, how it works.

Settings

SLICK_SLIDER_VERSION

Version of Slick Slider that should be used. Keep in mind, that this version needs to be in static/vendor/ folder with the appropriate folder name.

If you want to upgrade, download and copy the new version into the before mentioned folder and change the version in the settings.

default: 1.8.0

SLICK_SLICKER_DEFAULT_OPTIONS

ToDo

SLICK_SLIDER_ACE_THEME

ToDo

SLICK_SLIDER_ACE_MODE

ToDo

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

If you have issues with different python versions, please take a look at these docs: https://www.holger-peters.de/using-pyenv-and-tox.html

Credits

Tools used in rendering this package:

ToDos

  • make slider respect the order of SlickSliderImage Plugins
  • add more styling options to plugin
  • translations

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-slick-slider, version 0.7.2
Filename, size File type Python version Upload date Hashes
Filename, size djangocms-slick-slider-0.7.2.tar.gz (48.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page