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
Admin Form
Output
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
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/
SLICK_SLIDER_ACE_THEME
You can change the ACE theme of the edit field in the admin.
Default: json
SLICK_SLIDER_ACE_MODE
You can change the ACE mode of the edit field in the admin.
Default: github
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
Release to PyPi
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
Credits
Tools used in rendering this package:
ToDos
translations
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file djangocms-slick-slider-1.0.7.tar.gz.
File metadata
- Download URL: djangocms-slick-slider-1.0.7.tar.gz
- Upload date:
- Size: 49.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84c5d679ca412dcd12c8941d3964734bd5174d67ebde72bd56961b47810c51dc
|
|
| MD5 |
41bf22e4921dff474b27f9e296f28e63
|
|
| BLAKE2b-256 |
7273f465484b97141b6b86ac8258ab8c74c963e97faeebdb0b6caf1391a87e84
|
