From 39e91575af4bac9b37872cd0aa4fa3a3007374b9 Mon Sep 17 00:00:00 2001 From: Samuel Georges Date: Sun, 24 Apr 2016 09:43:26 +1000 Subject: [PATCH] Write docs for datepicker plugin --- .../datepicker/assets/js/datepicker.js | 21 +++++++++++++++++++ .../datepicker/partials/_picker_time.htm | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/modules/backend/formwidgets/datepicker/assets/js/datepicker.js b/modules/backend/formwidgets/datepicker/assets/js/datepicker.js index 2fb27b0bd..e00277090 100644 --- a/modules/backend/formwidgets/datepicker/assets/js/datepicker.js +++ b/modules/backend/formwidgets/datepicker/assets/js/datepicker.js @@ -1,3 +1,24 @@ +/* + * DatePicker plugin + * + * Data attributes: + * - data-control="datepicker" - enables the plugin on an element + * - data-format="value" - display format + * - data-min-date="value" - minimum date to allow + * - data-max-date="value" - maximum date to allow + * - data-year-range="value" - range of years to display + * + * JavaScript API: + * $('a#someElement').datePicker({ option: 'value' }) + * + * Dependences: + * - Pikaday plugin (pikaday.js) + * - Pikaday jQuery addon (pikaday.jquery.js) + * - Clockpicker plugin (jquery-clockpicker.js) + * - Moment library (moment.js) + * - Moment Timezone library (moment.timezone.js) + */ + +function ($) { "use strict"; var Base = $.oc.foundation.base, BaseProto = Base.prototype diff --git a/modules/backend/formwidgets/datepicker/partials/_picker_time.htm b/modules/backend/formwidgets/datepicker/partials/_picker_time.htm index 97f8d86b7..0e5c57968 100644 --- a/modules/backend/formwidgets/datepicker/partials/_picker_time.htm +++ b/modules/backend/formwidgets/datepicker/partials/_picker_time.htm @@ -1,4 +1,4 @@ - +