Date Picker¶
Last Updated: August 10, 2015
- class tethys_sdk.gizmos.DatePicker(name, display_text='', autoclose=False, calendar_weeks=False, clear_button=False, days_of_week_disabled='', end_date='', format='', min_view_mode='days', multidate=1, start_date='', start_view='month', today_button=False, today_highlight=False, week_start=0, initial='', disabled=False, error='', attributes={}, classes='')¶
Date pickers are used to make the input of dates streamlined and easy. Rather than typing the date, the user is presented with a calendar to select the date. This date picker was implemented using Bootstrap Datepicker.
- name¶
str, required
Name of the input element that will be used for form submission.
- display_text¶
str
Display text for the label that accompanies date picker.
- autoclose¶
bool
Set whether datepicker auto closes when a date is selected.
- calendar_weeks¶
bool
Set whether calendar week numbers are shown on the left of the datepicker.
bool
Set whether the clear button is displayed or not.
- days_of_week_disabled¶
str
Days of the week that are disabled 0-6 with 0 being Sunday and 6 being Saturday. Multiple days are comma separated (e.g.: ‘0,6’).
- end_date¶
str
Last date that can be selected. All other dates after this date are shown as disabled.
- format¶
str
String representing date format. For valid formats see Bootstrap Datepicker documentation here.
- min_view_mode¶
str
Set the minimum view mode. Possible values are ‘days’, ‘months’, ‘years’.
- multidate¶
int
Enables multi-selection of dates up to the number given.
- start_date¶
str
First date that can be selected. All other dates before this date are shown as disabled.
- start_view¶
str
View the date picker starts on. Valid values include ‘month’, ‘year’, and ‘decade’.
bool
Set whether a today button is displayed or not.
- today_highlight¶
bool
Set whether to highlight the current date.
- week_start¶
int
Set the day the week starts on 0-6, where 0 is Sunday and 6 is Saturday.
- initial¶
str
Initial date to appear in date picker.
- disabled¶
bool
Disabled state of the date picker.
- error¶
str
Error message for form validation.
- attributes¶
dict
A dictionary representing additional HTML attributes to add to the primary element (e.g. {“onclick”: “run_me();”}).
- classes¶
str
Additional classes to add to the primary HTML element (e.g. “example-class another-class”).
Example
# CONTROLLER from tethys_sdk.gizmos import DatePicker # Date Picker Options date_picker = DatePicker(name='date1', display_text='Date', autoclose=True, format='MM d, yyyy', start_date='2/15/2014', start_view='decade', today_button=True, initial='February 15, 2014') date_picker_error = DatePicker(name='data2', display_text='Date', initial='10/2/2013', disabled=True, error='Here is my error text.') # TEMPLATE {% gizmo date_picker date_picker %} {% gizmo date_picker date_picker_error %}