A Django widget for the Tempus Dominus Bootstrap 4 DateTime picker.

These details have not been verified by PyPI

Project links

Homepage

Project description

Django Tempus Dominus

Django Tempus Dominus provides Django widgets for the Tempus Dominus Bootstrap 4 DateTime date and time picker. Why yet another date and time picker for Django? None supported the Tempus Dominus date and time picker, which is actively developed and feature rich. It is a successor to the popular bootstrap-datetimepicker JavaScript library.

Installation

From PyPI: pip install django-tempus-dominus

Then add tempus_dominus to INSTALLED_APPS in your Django settings.

Usage & Django Settings

The following settings are available:

TEMPUS_DOMINUS_LOCALIZE (default: False): if True, widgets will be translated to the selected browser language and use the localized date and time formats.
TEMPUS_DOMINUS_INCLUDE_ASSETS (default: True): if True, loads Tempus Dominus and moment JS and CSS from Cloudflare's CDN, otherwise loading the JS and CSS are up to you.

Three widgets are provided:

DatePicker
- Defaults to YYYY-MM-DD
- Defaults to L if TEMPUS_DOMINUS_LOCALIZE is True
DateTimePicker
- Defaults to YYYY-MM-DD HH:mm:ss
- Defaults to L LTS if TEMPUS_DOMINUS_LOCALIZE is True
TimePicker
- Defaults to HH:mm:ss
- Defaults to LTS if TEMPUS_DOMINUS_LOCALIZE is True

In your Django form, you can use the widgets like this:

from django import forms
from tempus_dominus.widgets import DatePicker, TimePicker, DateTimePicker

class MyForm(forms.Form):
    date_field = forms.DateField(widget=DatePicker())
    date_field_required_with_min_max_date = forms.DateField(
        required=True,
        widget=DatePicker(
            options={
                'minDate': '2009-01-20',
                'maxDate': '2017-01-20',
            },
        ),
    )
    time_field = forms.TimeField(
        """
        In this example, the date portion of `defaultDate` is irrelevant;
        only the time portion is used. The reason for this is that it has
        to be passed in a valid MomentJS format. This will default the time
        to be 14:56:00 (or 2:56pm).
        """
        widget=TimePicker(
            options={
                'enabledHours': [9, 10, 11, 12, 13, 14, 15, 16],
                'defaultDate': '1970-01-01T14:56:00'
            },
            attrs={
                'input_toggle': True,
                'input_group': False,
            },
        ),
    )
    datetime_field = forms.DateTimeField(
        widget=DateTimePicker(
            options={
                'useCurrent': True,
                'collapse': False,
            },
            attrs={
                'append': 'fa fa-calendar',
                'icon_toggle': True,
            }
        ),
    )

Then in your template, include jQuery, {{ form.media }}, and render the form:

<html>
  <head>
    {# Include FontAwesome; required for icon display #}
    <link rel="stylesheet" href="https://netdna.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.css">

    {# Include Bootstrap 4 and jQuery #}
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>

    {# Django Tempus Dominus assets are included in `{{ form.media }}` #}
    {{ form.media }}
  </head>

  <body>
    <div class="container">
      <div class="row">
        <div class="col">
          <form method="post" action=".">
            {% csrf_token %}
            {{ form.as_p }}
          </form>
        </div>
      </div>
    </div>
  </body>
</html>

Widget Options

options (dictionary): This dictionary will be passed to Tempus Dominus. A full list of options is available here.
input_toggle (boolean, default True): Controls whether clicking on the input field toggles the datepicker popup. Typically is set to False when an icon is in use.
input_group (boolean, default True): Whether to include a Bootstrap 4 input-group around the picker.
size (string): Controls the size of the input group (small or large). Defaults to the default size.
prepend (string): Name of a Font Awesome icon to prepend to the input field (fa fa-calendar).
append (string): Name of a Font Awesome icon to append to the input field (fa fa-calendar).
icon_toggle (boolean, default True): Controls whether clicking on the icon toggles the datepicker popup. Typically is set to False when an icon is in use.

Change Log

5.1.2.4: Add support for disabling the Bootstrap input-group with a new option. Fix an icon.
5.1.2.3: Fix a bug which caused a page lag when switching locales.
5.1.2.2: Fix a bug with duplicate DOM IDs in template.
5.1.2.1: Fix a bug with time formatting to use ISO time format (T12:34:56)
5.1.2.0: Upgrade Tempus Dominus to 5.1.2. Support for new widget attributes (size, prepend, append, input_toggle, icon_toggle, class). DatePicker now closes after losing focus, and widget attributes are properly passed.
5.0.1.5: Fix to ensure options are passed in proper JSON.
5.0.1.4: Include template in the MANIFEST.in file.
5.0.1.3: Add setting to exclude CDN CSS and JS assets. Add initial test suite.
5.0.1.2: Documentation clean up.
5.0.1.1: Option to l10n and i18n to all pickers.
5.0.1.0: Upgrade to Tempus Dominus full release version 5.0.1. Fix bug for populating initial values (thank you, @ianastewart).
0.1.2: UX enhancement: auto-dismiss dialog if the input loses focus.
0.1.1: Bug fixes.
0.1.0: Initial release.

Maintainers

Timothy Allen (https://github.com/FlipperPA)
Ian Stewart (https://github.com/ianastewart)

Contributors & DjangoCon US Sprinters (Thank You!)

Stéphane "Twidi" Angel (https://github.com/twidi)
Jake Bell (https://github.com/theunraveler)
John Carroll (https://github.com/johnnyporkchops)
Bryan Collazo (https://github.com/bcollazo)
Katherine Dey (https://github.com/deyspring)
Tiffany Huang (https://github.com/tiff8433)
Václav 'ax' Hůla (https://github.com/AxTheB)
Kenneth Love (https://github.com/kennethlove)
Donna St. Louis (https://github.com/dcstlouis)
Ryan Sullivan (https://github.com/rgs258)
Kevan Swanberg (https://github.com/kevswanberg)
waymou (https://github.com/waymao)

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

5.1.2.17

Mar 21, 2022

5.1.2.16

Aug 12, 2021

5.1.2.15

Aug 12, 2021

5.1.2.14

May 25, 2021

5.1.2.13

Jan 18, 2020

5.1.2.11

Jan 18, 2020

5.1.2.9

Oct 26, 2019

5.1.2.8

Sep 15, 2019

5.1.2.7

Sep 13, 2019

5.1.2.6.post1

Aug 16, 2019

5.1.2.6

Aug 14, 2019

This version

5.1.2.5

May 14, 2019

5.1.2.4

Mar 15, 2019

5.1.2.3

Mar 9, 2019

5.1.2.2

Jan 24, 2019

5.1.2.1

Dec 15, 2018

5.1.2.0

Nov 16, 2018

5.0.1.4

Oct 28, 2018

5.0.1.3

Oct 21, 2018

5.0.1.2

Sep 10, 2018

5.0.1.1

Sep 9, 2018

5.0.1.0

Aug 13, 2018

0.1.4

May 29, 2018

0.1.3

May 26, 2018

0.1.2

May 26, 2018

0.1.1

Apr 17, 2018

0.1

Apr 17, 2018

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-tempus-dominus-5.1.2.5.tar.gz (8.2 kB view hashes)

Uploaded May 14, 2019 Source

Built Distribution

django_tempus_dominus-5.1.2.5-py3-none-any.whl (10.5 kB view hashes)

Uploaded May 14, 2019 Python 3

Hashes for django-tempus-dominus-5.1.2.5.tar.gz

Hashes for django-tempus-dominus-5.1.2.5.tar.gz
Algorithm	Hash digest
SHA256	`c657b1b868c09523f71aa41a5d5c278bad5523f9313ab452f7325b0f0d882cc7`
MD5	`bfc4a8caf508126bf99420cbee8dd658`
BLAKE2b-256	`948ce3830757dc6e5ef2989dee8650c95976a30c607350eee5ea3d6c0db60fa6`

Hashes for django_tempus_dominus-5.1.2.5-py3-none-any.whl

Hashes for django_tempus_dominus-5.1.2.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`8038ecf7b8ed28568e26d3882066de4715712f057050452bffec952c970b20f7`
MD5	`5b437858b5c84810ac2c6e5e861008d4`
BLAKE2b-256	`240c72f3e67242f8354fa7e01a79c1e2d49508f7be537b556f948ca4f4037ac2`