A Django CMS Slider Plugin with Slick Slider.
- 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
Admin Form
Output
The full documentation is at https://djangocms-slick-slider.readthedocs.io.
Install djangocms_slick_slider:
pip install djangocms-slick-slider
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'djangocms_slick_slider.apps.DjangocmsSlickSliderConfig',
...
)
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.
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
You can adjust the default options by setting SLICK_SLICKER_DEFAULT_OPTIONS
to a dictionary.
Default:
SLICK_SLICKER_DEFAULT_OPTIONS = { 'dots': True, 'slidesToShow': 2, 'mobileFirst': False, 'slidesToScroll': 1, 'autoplay': True, 'autoplaySpeed': 1500 }
You can set any option that slick-slider offers. You can find them here: https://kenwheeler.github.io/slick/
You can change the ACE theme of the edit field in the admin.
Default: json
You can change the ACE mode of the edit field in the admin.
Default: github
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
For versioning, you need to have standard-version installed:
yarn install
Once you are ready and everything has been commited to git, you can run:
yarn run release
This will:
- Bump the version in the according files
- Commit everything to git and create a git tag
- Create a package for PyPi and upload it
- Push everything to Git including tags
Tools used in rendering this package:
- translations
This project is maintained by Mathison AG | Mobile & Web Development.