A countdown timer for django-fluent-contents
Project description
fluentcms-countdown
A plugin for django-fluent-contents to show a countdown timer on a website.
It’s based on the jQuery plugin found at: http://keith-wood.name/countdown.html
Installation
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install fluentcms-countdown
Backend Configuration
First make sure the project is configured for django-fluent-contents.
Then add the following settings:
INSTALLED_APPS += (
'fluentcms_countdown',
)
The database tables can be created afterwards:
./manage.py syncdb
Now, the CountDownPlugin can be added to your PlaceholderField and PlaceholderEditorAdmin admin screens.
Frontend Configuration
Make sure that all plugin media files are exposed by django-fluent-contents:
{% load fluent_contents_tags %}
{% render_content_items_media %}
This tag should be placed at the bottom of the page, after all plugins are rendered. For more configuration options - e.g. integration with django-compressor - see the template tag documentation.
CSS Code
The stylesheet code is purposefully left out, since authors typically like to provide their own styling.
To get started quickly, include fluentcms_countdown/vendor/jquery.countdown.css in your site.
JavaScript Code
No configuration is required for the JavaScript integration,
By default, the plugin includes all required JavaScript code to run the timer.
The includes can be customized however, using the following settings:
JQUERY_PLUGIN_JS = 'fluentcms_countdown/vendor/jquery.plugin.min.js'
JQUERY_COUNTDOWN_JS = 'fluentcms_countdown/vendor/jquery.countdown.min.js'
JQUERY_COUNTDOWN_LOCALE_JS = 'fluentcms_countdown/vendor/jquery.countdown-{locale}.js'
COUNTDOWN_JS = 'fluentcms_countdown/countdown.js'
For example, if another plugin also uses jquery.plugin.js, redefine the setting, so both plugins use the same file:
JQUERY_PLUGIN_JS = 'mysite/vendor/jquery.plugin.min.js'
If a value is defined as None, it will be excluded from the frontend media.
HTML code
If needed, the HTML code can be overwritten by redefining fluentcms_countdown/countdown.html. Any data-... attributes on the countdown element will be read by the JavaScript code; this can be used to provide custom settings to the countdown init script.
Contributing
If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fluentcms-countdown-1.2.tar.gz.
File metadata
- Download URL: fluentcms-countdown-1.2.tar.gz
- Upload date:
- Size: 41.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f0119fd97c393d1c6c28da1bedffd7cefe3631e8f0b04f297262ede4d38963bb |
|
| MD5 | 063f39c9d05f493b6905640cabff0148 |
|
| BLAKE2b-256 | 7c1e7297d9d43ab9a0ae41e0c98888c8fca729ac19da07c5c7fde4d17d8d41b8 |
File details
Details for the file fluentcms_countdown-1.2-py2.py3-none-any.whl.
File metadata
- Download URL: fluentcms_countdown-1.2-py2.py3-none-any.whl
- Upload date:
- Size: 68.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5e71490fdd62d8883dfd36183f0a5413a3c5e68f4794119e8f26a26e6a3f827 |
|
| MD5 | 360fd5c1e143f9e170a68bc8582e8396 |
|
| BLAKE2b-256 | b13a7a207028af4ebe76507d0034232894346e1e8ca0a78a574d5dd25f0ff25c |
