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. :-)
1 maintainer
Release files for fluentcms-countdown 2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fluentcms-countdown-2.0.tar.gz | 42.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fluentcms_countdown-2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.4 kB
Release files / fluentcms-countdown-2.0.tar.gz
| Download URL | fluentcms-countdown-2.0.tar.gz |
|---|---|
| Size | 42.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ade88bf45226eb3cfb497efc5d5d952b2d468c19d03a5c28bef4e499b4d9eca
|
|
BLAKE2b-256 checksum How to use checksums |
a550c69372c78bebd9d43c8848a73e1c53ad74f313543f0ee9b623476e38235e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
|
Release files / fluentcms_countdown-2.0-py3-none-any.whl
| Download URL | fluentcms_countdown-2.0-py3-none-any.whl |
|---|---|
| Size | 71.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e94046ed076fd5961a16b6e7e62eaf68ac3d07e616cb62e103e34634f8b05340
|
|
BLAKE2b-256 checksum How to use checksums |
bd42d8db9eaaba279d1f520e5afca814ce79afd67b98fdcd772b2af5a3bff4f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
|
