Skip to content

Latest commit

 

History

History
316 lines (191 loc) · 9.28 KB

README.rst

File metadata and controls

316 lines (191 loc) · 9.28 KB
Raw

django-datetime-widget

https://pypip.in/v/django-datetime-widget/badge.png https://pypip.in/d/django-datetime-widget/badge.png

django-datetime-widget is a simple and clean picker widget for DateField, Timefiled and DateTimeField in Django framework. It is based on Bootstrap datetime picker, supports both Bootstrap 3 and Bootstrap 2 .

django-datetime-widget is perfect when you use a DateField, TimeField or DateTimeField in your model/form where is necessary to display the corresponding picker with a specific date/time format. Now it supports django localization.

Available widgets

  • DateTimeWidget : display the input with the calendar and time picker.
  • DateWidget : display the input only with the calendar picker.
  • TimeWidget : display the input only with the time picker.

See Demo page

Requirements

Screenshots

  • Decade year view

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_decade.png

This view allows the user to select the year in a range of 10 years.

  • Year view

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_year.png

This view allows the user to select the month in the selected year.

  • Month view

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_month.png

This view allows the user to select the day in the selected month.

  • Day view

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_day.png

This view allows the user to select the hour in the selected day.

  • Hour view

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_hour.png

This view allows the user to select the preset of minutes in the selected hour. The range of 5 minutes (by default) has been selected to restrict button quantity to an acceptable value, but it can be overwritten by the <code>minuteStep</code> property.

  • Day view - meridian

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_day_meridian.png

Meridian is supported in both the day and hour views. To use it, just enable the <code>showMeridian</code> property.

  • Hour view - meridian

https://raw.github.com/smalot/bootstrap-datetimepicker/master/screenshot/standard_hour_meridian.png

Installation

  1. Install django-datetime-widget using pip. For example:

    pip install django-datetime-widget

  2. Add datetimewidget to your INSTALLED_APPS.

If you want to use localization:

  1. Set USE_L10N = True, USE_TZ = True and USE_I18N = True in settings.py
  2. Add 'django.middleware.locale.LocaleMiddleware' to MIDDLEWARE_CLASSES in settings.py
  3. When you create the widget add usel10n = True like attribute : DateTimeWidget(usel10n=True)

Basic Configuration

  1. Create your model-form and set DateTimeWidget widget to your DateTimeField

    from datetimewidget.widgets import DateTimeWidget

class yourForm(forms.ModelForm):
    class Meta:
        model = yourModel
        widgets = {
            #Use localization and bootstrap 3
            'datetime': DateTimeWidget(attrs={'id':"yourdatetimeid"}, usel10n = True, bootstrap_version=3)
        }

  2. Download twitter bootstrap to your static file folder.

  3. Add in your form template links to jquery, bootstrap and form.media:

    <head>
....
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
    <link href="{{ STATIC_URL }}css/bootstrap.css" rel="stylesheet" type="text/css"/>
    <script src="{{ STATIC_URL }}js/bootstrap.js"></script>
    {{ form.media }}

....
</head>
<body>
    <form  action="" method="POST">
    {% csrf_token %}
    {{ form.as_table }}
    <input id="submit" type="submit" value="Submit">
    </form>
</body>

  4. Optional: you can add an option dictionary to DatetimeWidget to customize your input. For example, to have date and time with meridian:

    dateTimeOptions = {
'format': 'dd/mm/yyyy HH:ii P',
'autoclose': True,
'showMeridian' : True
}
widgets = {
    #NOT Use localization and set a default format
    'datetime': DateTimeWidget(options = dateTimeOptions)
    }

!!! If you add 'format' into options and in the same time set usel10n as True the first one is ignored. !!!

Options

The options attribute can accept the following: * format

String. Default: 'dd/mm/yyyy hh:ii'

The date format, combination of P, hh, HH , ii, ss, dd, yy, yyyy.

  • P : meridian in upper case ('AM' or 'PM') - according to locale file
  • ss : seconds, 2 digits with leading zeros
  • ii : minutes, 2 digits with leading zeros
  • hh : hour, 2 digits with leading zeros - 24-hour format
  • HH : hour, 2 digits with leading zeros - 12-hour format
  • dd : day of the month, 2 digits with leading zeros
  • yy : two digit representation of a year
  • yyyy : full numeric representation of a year, 4 digits
  • weekStart

Integer. Default: 0

Day of the week start. '0' (Sunday) to '6' (Saturday)

  • startDate

Date. Default: Beginning of time

The earliest date that may be selected; all earlier dates will be disabled.

  • endDate

Date. Default: End of time

The latest date that may be selected; all later dates will be disabled.

  • daysOfWeekDisabled

String. Default: ''

Days of the week that should be disabled. Values are 0 (Sunday) to 6 (Saturday). Multiple values should be comma-separated. Example: disable weekends: '0,6'.

  • autoclose

String. Default: 'true'

Whether or not to close the datetimepicker immediately when a date is selected.

  • startView

Integer. Default: 2

The view that the datetimepicker should show when it is opened. Accepts values of :

  • '0' for the hour view
  • '1' for the day view
  • '2' for month view (the default)
  • '3' for the 12-month overview
  • '4' for the 10-year overview. Useful for date-of-birth datetimepickers.
  • minView

Integer. Default: 0

The lowest view that the datetimepicker should show.

  • maxView

Integer. Default: 4

The highest view that the datetimepicker should show.

  • todayBtn

Boolean. Default: False

If true , displays a "Today" button at the bottom of the datetimepicker to select the current date. If true, the "Today" button will only move the current date into view.

  • todayHighlight

Boolean. Default: False

If true, highlights the current date.

  • minuteStep

Integer. Default: 5

The increment used to build the hour view. A button is created for each <code>minuteStep</code> minutes.

  • pickerPosition

String. Default: 'bottom-right' (other supported value : 'bottom-left')

This option allows you to place the picker just under the input field for the component implementation instead of the default position which is at the bottom right of the button.

  • showMeridian

Boolean. Default: False

This option will enable meridian views for day and hour views.

  • clearBtn

Boolean. Default: False

If true, displays a "Clear" button at the rigth side of the input value.

CHANGELOG

  • 0.9.3V
    • FIX #48
    • Python 3 support
  • 0.9.2V
    • FIX #46
  • 0.9.1V
    • python options are correct converted to the javascript options.
    • FIX #38 #40.
    • code refactor and bug fixes.
  • 0.9V
    • Update bootstrap datetime picker to the last version.
    • CLOSE #20 (support bootstrap 2 and 3).
    • CLOSE #17 TimeWidget.
    • CLOSE #16 DateWidget.
    • new clear button at the rigth side of the input value.
    • add dateTimeExample django project.
  • 0.6V
    • Add Clear button
    • Fix TypeError bug
    • Support localization
    • Update static file with last commit of bootstrap-datetime-picker
    • update js lib, native localization, thanks to @quantum13
    • autoclose is true by default

Contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  • If you feel uncomfortable or uncertain about an issue or your changes, feel free to email @asaglimbeni and he will happily help you via email, Skype, remote pairing or whatever you are comfortable with.
  1. Fork develop branch from the repository on GitHub to start making your changes to the develop branch (or branch off of it).
  2. Please show that the bug was fixed or that the feature works as expected.
  3. Send a pull request and bug the maintainer until it gets merged and published. :)
  4. Your changes will be released on the next version of django_datetime_widget!

TODO

  1. widget for DateTime range.