03baeb34a2008c94491295b71b0168d64cd2c2e1
2 * MediaWiki Widgets – DateInputWidget class.
4 * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
5 * @license The MIT License (MIT); see LICENSE.txt
11 * Creates an mw.widgets.DateInputWidget object.
14 * // Date input widget showcase
15 * var fieldset = new OO.ui.FieldsetLayout( {
17 * new OO.ui.FieldLayout(
18 * new mw.widgets.DateInputWidget(),
21 * label: 'Select date'
24 * new OO.ui.FieldLayout(
25 * new mw.widgets.DateInputWidget( { precision: 'month' } ),
28 * label: 'Select month'
31 * new OO.ui.FieldLayout(
32 * new mw.widgets.DateInputWidget( {
33 * inputFormat: 'DD.MM.YYYY',
34 * displayFormat: 'Do [of] MMMM [anno Domini] YYYY'
38 * label: 'Select date (custom formats)'
43 * $( 'body' ).append( fieldset.$element );
45 * The value is stored in 'YYYY-MM-DD' or 'YYYY-MM' format:
48 * // Accessing values in a date input widget
49 * var dateInput = new mw.widgets.DateInputWidget();
50 * var $label = $( '<p>' );
51 * $( 'body' ).append( $label, dateInput.$element );
52 * dateInput.on( 'change', function () {
53 * // The value will always be a valid date or empty string, malformed input is ignored
54 * var date = dateInput.getValue();
55 * $label.text( 'Selected date: ' + ( date || '(none)' ) );
59 * @extends OO.ui.InputWidget
60 * @mixins OO.ui.mixin.IndicatorElement
63 * @param {Object} [config] Configuration options
64 * @cfg {string} [precision='day'] Date precision to use, 'day' or 'month'
65 * @cfg {string} [value] Day or month date (depending on `precision`), in the format 'YYYY-MM-DD'
66 * or 'YYYY-MM'. If not given or empty string, no date is selected.
67 * @cfg {string} [inputFormat] Date format string to use for the textual input field. Displayed
68 * while the widget is active, and the user can type in a date in this format. Should be short
69 * and easy to type. When not given, defaults to 'YYYY-MM-DD' or 'YYYY-MM', depending on
71 * @cfg {string} [displayFormat] Date format string to use for the clickable label. Displayed
72 * while the widget is inactive. Should be as unambiguous as possible (for example, prefer to
73 * spell out the month, rather than rely on the order), even if that makes it longer. When not
74 * given, the default is language-specific.
75 * @cfg {string} [placeholderLabel=No date selected] Placeholder text shown when the widget is not
76 * selected. Default text taken from message `mw-widgets-dateinput-no-date`.
77 * @cfg {string} [placeholderDateFormat] User-visible date format string displayed in the textual input
78 * field when it's empty. Should be the same as `inputFormat`, but translated to the user's
79 * language. When not given, defaults to a translated version of 'YYYY-MM-DD' or 'YYYY-MM',
80 * depending on `precision`.
81 * @cfg {boolean} [required=false] Mark the field as required. Implies `indicator: 'required'`.
82 * @cfg {string} [mustBeAfter] Validates the date to be after this. In the 'YYYY-MM-DD' format.
83 * @cfg {string} [mustBeBefore] Validates the date to be before this. In the 'YYYY-MM-DD' format.
84 * @cfg {jQuery} [$overlay] Render the calendar into a separate layer. This configuration is
85 * useful in cases where the expanded calendar is larger than its container. The specified
86 * overlay layer is usually on top of the container and has a larger area. By default, the
87 * calendar uses relative positioning.
89 mw
.widgets
.DateInputWidget
= function MWWDateInputWidget( config
) {
90 // Config initialization
94 placeholderLabel
: mw
.msg( 'mw-widgets-dateinput-no-date' )
96 if ( config
.required
) {
97 if ( config
.indicator
=== undefined ) {
98 config
.indicator
= 'required';
102 var placeholderDateFormat
, mustBeAfter
, mustBeBefore
;
103 if ( config
.placeholderDateFormat
) {
104 placeholderDateFormat
= config
.placeholderDateFormat
;
105 } else if ( config
.inputFormat
) {
106 // We have no way to display a translated placeholder for custom formats
107 placeholderDateFormat
= '';
109 // Messages: mw-widgets-dateinput-placeholder-day, mw-widgets-dateinput-placeholder-month
110 placeholderDateFormat
= mw
.msg( 'mw-widgets-dateinput-placeholder-' + config
.precision
);
113 // Properties (must be set before parent constructor, which calls #setValue)
114 this.$handle
= $( '<div>' );
115 this.label
= new OO
.ui
.LabelWidget();
116 this.textInput
= new OO
.ui
.TextInputWidget( {
117 required
: config
.required
,
118 placeholder
: placeholderDateFormat
,
119 validate
: this.validateDate
.bind( this )
121 this.calendar
= new mw
.widgets
.CalendarWidget( {
122 // Can't pass `$floatableContainer: this.$element` here, the latter is not set yet.
123 // Instead we call setFloatableContainer() below.
124 precision
: config
.precision
127 this.inTextInput
= 0;
128 this.inputFormat
= config
.inputFormat
;
129 this.displayFormat
= config
.displayFormat
;
130 this.required
= config
.required
;
131 this.placeholderLabel
= config
.placeholderLabel
;
133 // Validate and set min and max dates as properties
134 if ( config
.mustBeAfter
!== undefined ) {
135 mustBeAfter
= moment( config
.mustBeAfter
, 'YYYY-MM-DD' );
136 if ( mustBeAfter
.isValid() ) {
137 this.mustBeAfter
= mustBeAfter
;
140 if ( config
.mustBeBefore
!== undefined ) {
141 mustBeBefore
= moment( config
.mustBeBefore
, 'YYYY-MM-DD' );
142 if ( mustBeBefore
.isValid() ) {
143 this.mustBeBefore
= mustBeBefore
;
147 // Parent constructor
148 mw
.widgets
.DateInputWidget
.parent
.call( this, config
);
150 // Mixin constructors
151 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
154 this.calendar
.connect( this, {
155 change
: 'onCalendarChange'
157 this.textInput
.connect( this, {
159 change
: 'onTextInputChange'
162 focusout
: this.onBlur
.bind( this )
164 this.calendar
.$element
.on( {
165 click
: this.onCalendarClick
.bind( this ),
166 keypress
: this.onCalendarKeyPress
.bind( this )
169 click
: this.onClick
.bind( this ),
170 keypress
: this.onKeyPress
.bind( this )
174 // Move 'tabindex' from this.$input (which is invisible) to the visible handle
175 this.setTabIndexedElement( this.$handle
);
177 .append( this.label
.$element
, this.$indicator
)
178 .addClass( 'mw-widget-dateInputWidget-handle' );
179 this.calendar
.$element
180 .addClass( 'mw-widget-dateInputWidget-calendar' );
182 .addClass( 'mw-widget-dateInputWidget' )
183 .append( this.$handle
, this.textInput
.$element
, this.calendar
.$element
);
185 if ( config
.$overlay
) {
186 this.calendar
.setFloatableContainer( this.$element
);
187 config
.$overlay
.append( this.calendar
.$element
);
189 // The text input and calendar are not in DOM order, so fix up focus transitions.
190 this.textInput
.$input
.on( 'keydown', function ( e
) {
191 if ( e
.which
=== OO
.ui
.Keys
.TAB
) {
193 // Tabbing backward from text input: normal browser behavior
196 // Tabbing forward from text input: just focus the calendar
197 this.calendar
.$element
.focus();
202 this.calendar
.$element
.on( 'keydown', function ( e
) {
203 if ( e
.which
=== OO
.ui
.Keys
.TAB
) {
205 // Tabbing backward from calendar: just focus the text input
206 this.textInput
.$input
.focus();
209 // Tabbing forward from calendar: focus the text input, then allow normal browser
210 // behavior to move focus to next focusable after it
211 this.textInput
.$input
.focus();
217 // Set handle label and hide stuff
219 this.textInput
.toggle( false );
220 this.calendar
.toggle( false );
225 OO
.inheritClass( mw
.widgets
.DateInputWidget
, OO
.ui
.InputWidget
);
226 OO
.mixinClass( mw
.widgets
.DateInputWidget
, OO
.ui
.mixin
.IndicatorElement
);
234 mw
.widgets
.DateInputWidget
.prototype.getInputElement = function () {
235 return $( '<input>' ).attr( 'type', 'hidden' );
239 * Respond to calendar date change events.
243 mw
.widgets
.DateInputWidget
.prototype.onCalendarChange = function () {
245 if ( !this.inTextInput
) {
246 // If this is caused by user typing in the input field, do not set anything.
247 // The value may be invalid (see #onTextInputChange), but displayable on the calendar.
248 this.setValue( this.calendar
.getDate() );
254 * Respond to text input value change events.
258 mw
.widgets
.DateInputWidget
.prototype.onTextInputChange = function () {
261 value
= this.textInput
.getValue(),
262 valid
= this.isValidDate( value
);
265 if ( value
=== '' ) {
267 widget
.setValue( '' );
268 } else if ( valid
) {
269 // Well-formed date value, parse and set it
270 mom
= moment( value
, widget
.getInputFormat() );
271 // Use English locale to avoid number formatting
272 widget
.setValue( mom
.locale( 'en' ).format( widget
.getInternalFormat() ) );
274 // Not well-formed, but possibly partial? Try updating the calendar, but do not set the
275 // internal value. Generally this only makes sense when 'inputFormat' is little-endian (e.g.
276 // 'YYYY-MM-DD'), but that's hard to check for, and might be difficult to handle the parsing
277 // right for weird formats. So limit this trick to only when we're using the default
278 // 'inputFormat', which is the same as the internal format, 'YYYY-MM-DD'.
279 if ( widget
.getInputFormat() === widget
.getInternalFormat() ) {
280 widget
.calendar
.setDate( widget
.textInput
.getValue() );
283 widget
.inTextInput
--;
290 mw
.widgets
.DateInputWidget
.prototype.setValue = function ( value
) {
291 var oldValue
= this.value
;
293 if ( !moment( value
, this.getInternalFormat() ).isValid() ) {
297 mw
.widgets
.DateInputWidget
.parent
.prototype.setValue
.call( this, value
);
299 if ( this.value
!== oldValue
) {
301 this.setValidityFlag();
308 * Handle text input and calendar blur events.
312 mw
.widgets
.DateInputWidget
.prototype.onBlur = function () {
314 setTimeout( function () {
315 var $focussed
= $( ':focus' );
316 // Deactivate unless the focus moved to something else inside this widget
318 !OO
.ui
.contains( widget
.$element
[ 0 ], $focussed
[ 0 ], true ) &&
319 // Calendar might be in an $overlay
320 !OO
.ui
.contains( widget
.calendar
.$element
[ 0 ], $focussed
[ 0 ], true )
330 mw
.widgets
.DateInputWidget
.prototype.focus = function () {
338 mw
.widgets
.DateInputWidget
.prototype.blur = function () {
344 * Update the contents of the label, text input and status of calendar to reflect selected value.
348 mw
.widgets
.DateInputWidget
.prototype.updateUI = function () {
350 if ( this.getValue() === '' ) {
351 this.textInput
.setValue( '' );
352 this.calendar
.setDate( null );
353 this.label
.setLabel( this.placeholderLabel
);
354 this.$element
.addClass( 'mw-widget-dateInputWidget-empty' );
356 moment
= this.getMoment();
357 if ( !this.inTextInput
) {
358 this.textInput
.setValue( moment
.format( this.getInputFormat() ) );
360 if ( !this.inCalendar
) {
361 this.calendar
.setDate( this.getValue() );
363 this.label
.setLabel( moment
.format( this.getDisplayFormat() ) );
364 this.$element
.removeClass( 'mw-widget-dateInputWidget-empty' );
369 * Deactivate this input field for data entry. Closes the calendar and hides the text field.
373 mw
.widgets
.DateInputWidget
.prototype.deactivate = function () {
374 this.$element
.removeClass( 'mw-widget-dateInputWidget-active' );
376 this.textInput
.toggle( false );
377 this.calendar
.toggle( false );
378 this.setValidityFlag();
382 * Activate this input field for data entry. Opens the calendar and shows the text field.
386 mw
.widgets
.DateInputWidget
.prototype.activate = function () {
387 this.calendar
.resetUI();
388 this.$element
.addClass( 'mw-widget-dateInputWidget-active' );
390 this.textInput
.toggle( true );
391 this.calendar
.toggle( true );
393 this.textInput
.$input
.focus();
397 * Get the date format to be used for handle label when the input is inactive.
400 * @return {string} Format string
402 mw
.widgets
.DateInputWidget
.prototype.getDisplayFormat = function () {
403 if ( this.displayFormat
!== undefined ) {
404 return this.displayFormat
;
407 if ( this.calendar
.getPrecision() === 'month' ) {
410 // The formats Moment.js provides:
411 // * ll: Month name, day of month, year
412 // * lll: Month name, day of month, year, time
413 // * llll: Month name, day of month, day of week, year, time
415 // The format we want:
416 // * ????: Month name, day of month, day of week, year
418 // We try to construct it as 'llll - (lll - ll)' and hope for the best.
419 // This seems to work well for many languages (maybe even all?).
421 var localeData
= moment
.localeData( moment
.locale() ),
422 llll
= localeData
.longDateFormat( 'llll' ),
423 lll
= localeData
.longDateFormat( 'lll' ),
424 ll
= localeData
.longDateFormat( 'll' ),
425 format
= llll
.replace( lll
.replace( ll
, '' ), '' );
432 * Get the date format to be used for the text field when the input is active.
435 * @return {string} Format string
437 mw
.widgets
.DateInputWidget
.prototype.getInputFormat = function () {
438 if ( this.inputFormat
!== undefined ) {
439 return this.inputFormat
;
445 }[ this.calendar
.getPrecision() ];
449 * Get the date format to be used internally for the value. This is not configurable in any way,
450 * and always either 'YYYY-MM-DD' or 'YYYY-MM'.
453 * @return {string} Format string
455 mw
.widgets
.DateInputWidget
.prototype.getInternalFormat = function () {
459 }[ this.calendar
.getPrecision() ];
463 * Get the Moment object for current value.
465 * @return {Object} Moment object
467 mw
.widgets
.DateInputWidget
.prototype.getMoment = function () {
468 return moment( this.getValue(), this.getInternalFormat() );
472 * Handle mouse click events.
475 * @param {jQuery.Event} e Mouse click event
477 mw
.widgets
.DateInputWidget
.prototype.onClick = function ( e
) {
478 if ( !this.isDisabled() && e
.which
=== 1 ) {
485 * Handle key press events.
488 * @param {jQuery.Event} e Key press event
490 mw
.widgets
.DateInputWidget
.prototype.onKeyPress = function ( e
) {
491 if ( !this.isDisabled() &&
492 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
500 * Handle calendar key press events.
503 * @param {jQuery.Event} e Key press event
505 mw
.widgets
.DateInputWidget
.prototype.onCalendarKeyPress = function ( e
) {
506 if ( !this.isDisabled() && e
.which
=== OO
.ui
.Keys
.ENTER
) {
508 this.$handle
.focus();
514 * Handle calendar click events.
517 * @param {jQuery.Event} e Mouse click event
519 mw
.widgets
.DateInputWidget
.prototype.onCalendarClick = function ( e
) {
521 !this.isDisabled() &&
523 $( e
.target
).hasClass( 'mw-widget-calendarWidget-day' )
526 this.$handle
.focus();
532 * Handle text input enter events.
536 mw
.widgets
.DateInputWidget
.prototype.onEnter = function () {
538 this.$handle
.focus();
543 * @param {string} date Date string, to be valid, must be in 'YYYY-MM-DD' or 'YYYY-MM' format or
544 * (unless the field is required) empty
547 mw
.widgets
.DateInputWidget
.prototype.validateDate = function ( date
) {
550 isValid
= !this.required
;
552 isValid
= this.isValidDate( date
) && this.isInRange( date
);
559 * @param {string} date Date string, to be valid, must be in 'YYYY-MM-DD' or 'YYYY-MM' format
562 mw
.widgets
.DateInputWidget
.prototype.isValidDate = function ( date
) {
563 // "Half-strict mode": for example, for the format 'YYYY-MM-DD', 2015-1-3 instead of 2015-01-03
564 // is okay, but 2015-01 isn't, and neither is 2015-01-foo. Use Moment's "fuzzy" mode and check
565 // parsing flags for the details (stolen from implementation of moment#isValid).
567 mom
= moment( date
, this.getInputFormat() ),
568 flags
= mom
.parsingFlags();
570 return mom
.isValid() && flags
.charsLeftOver
=== 0 && flags
.unusedTokens
.length
=== 0;
574 * Validates if the date is within the range configured with {@link #cfg-mustBeAfter}
575 * and {@link #cfg-mustBeBefore}.
578 * @param {string} date Date string, to be valid, must be empty (no date selected) or in
579 * 'YYYY-MM-DD' or 'YYYY-MM' format to be valid
582 mw
.widgets
.DateInputWidget
.prototype.isInRange = function ( date
) {
583 var momentDate
, isAfter
, isBefore
;
584 if ( this.mustBeAfter
=== undefined && this.mustBeBefore
=== undefined ) {
587 momentDate
= moment( date
, 'YYYY-MM-DD' );
588 isAfter
= ( this.mustBeAfter
=== undefined || momentDate
.isAfter( this.mustBeAfter
) );
589 isBefore
= ( this.mustBeBefore
=== undefined || momentDate
.isBefore( this.mustBeBefore
) );
590 return isAfter
&& isBefore
;
594 * Get the validity of current value.
596 * This method returns a promise that resolves if the value is valid and rejects if
597 * it isn't. Uses {@link #validateDate}.
599 * @return {jQuery.Promise} A promise that resolves if the value is valid, rejects if not.
601 mw
.widgets
.DateInputWidget
.prototype.getValidity = function () {
602 var isValid
= this.validateDate( this.getValue() );
605 return $.Deferred().resolve().promise();
607 return $.Deferred().reject().promise();
612 * Sets the 'invalid' flag appropriately.
614 * @param {boolean} [isValid] Optionally override validation result
616 mw
.widgets
.DateInputWidget
.prototype.setValidityFlag = function ( isValid
) {
618 setFlag = function ( valid
) {
620 widget
.$input
.attr( 'aria-invalid', 'true' );
622 widget
.$input
.removeAttr( 'aria-invalid' );
624 widget
.setFlags( { invalid
: !valid
} );
627 if ( isValid
!== undefined ) {
630 this.getValidity().then( function () {
638 }( jQuery
, mediaWiki
) );