2 * MediaWiki Widgets – CalendarWidget 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.CalendarWidget object.
13 * You will most likely want to use mw.widgets.DateInputWidget instead of CalendarWidget directly.
16 * @extends OO.ui.Widget
17 * @mixins OO.ui.mixin.TabIndexedElement
20 * @param {Object} [config] Configuration options
21 * @cfg {string} [precision='day'] Date precision to use, 'day' or 'month'
22 * @cfg {string|null} [date=null] Day or month date (depending on `precision`), in the format
23 * 'YYYY-MM-DD' or 'YYYY-MM'. When null, the calendar will show today's date, but not select
26 mw
.widgets
.CalendarWidget
= function MWWCalendarWidget( config
) {
27 // Config initialization
28 config
= config
|| {};
31 mw
.widgets
.CalendarWidget
.parent
.call( this, config
);
34 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$element
} ) );
37 this.precision
= config
.precision
|| 'day';
38 // Currently selected date (day or month)
40 // Current UI state (date and precision we're displaying right now)
42 this.displayLayer
= this.getDisplayLayers()[ 0 ]; // 'month', 'year', 'duodecade'
44 this.$header
= $( '<div>' ).addClass( 'mw-widget-calendarWidget-header' );
45 this.$bodyOuterWrapper
= $( '<div>' ).addClass( 'mw-widget-calendarWidget-body-outer-wrapper' );
46 this.$bodyWrapper
= $( '<div>' ).addClass( 'mw-widget-calendarWidget-body-wrapper' );
47 this.$body
= $( '<div>' ).addClass( 'mw-widget-calendarWidget-body' );
48 this.labelButton
= new OO
.ui
.ButtonWidget( {
52 classes
: [ 'mw-widget-calendarWidget-labelButton' ]
54 this.upButton
= new OO
.ui
.ButtonWidget( {
58 classes
: [ 'mw-widget-calendarWidget-upButton' ]
60 this.prevButton
= new OO
.ui
.ButtonWidget( {
64 classes
: [ 'mw-widget-calendarWidget-prevButton' ]
66 this.nextButton
= new OO
.ui
.ButtonWidget( {
70 classes
: [ 'mw-widget-calendarWidget-nextButton' ]
74 this.labelButton
.connect( this, { click
: 'onUpButtonClick' } );
75 this.upButton
.connect( this, { click
: 'onUpButtonClick' } );
76 this.prevButton
.connect( this, { click
: 'onPrevButtonClick' } );
77 this.nextButton
.connect( this, { click
: 'onNextButtonClick' } );
79 focus
: this.onFocus
.bind( this ),
80 mousedown
: this.onClick
.bind( this ),
81 keydown
: this.onKeyDown
.bind( this )
86 .addClass( 'mw-widget-calendarWidget' )
87 .append( this.$header
, this.$bodyOuterWrapper
.append( this.$bodyWrapper
.append( this.$body
) ) );
89 this.prevButton
.$element
,
90 this.nextButton
.$element
,
91 this.upButton
.$element
,
92 this.labelButton
.$element
94 this.setDate( config
.date
!== undefined ? config
.date
: null );
99 OO
.inheritClass( mw
.widgets
.CalendarWidget
, OO
.ui
.Widget
);
100 OO
.mixinClass( mw
.widgets
.CalendarWidget
, OO
.ui
.mixin
.TabIndexedElement
);
107 * A change event is emitted when the chosen date changes.
109 * @param {string} date Day or month date, in the format 'YYYY-MM-DD' or 'YYYY-MM'
115 * Get the date format ('YYYY-MM-DD' or 'YYYY-MM', depending on precision), which is used
116 * internally and for dates accepted by #setDate and returned by #getDate.
119 * @returns {string} Format
121 mw
.widgets
.CalendarWidget
.prototype.getDateFormat = function () {
129 * Get the date precision this calendar uses, 'day' or 'month'.
132 * @returns {string} Precision, 'day' or 'month'
134 mw
.widgets
.CalendarWidget
.prototype.getPrecision = function () {
135 return this.precision
;
139 * Get list of possible display layers.
142 * @returns {string[]} Layers
144 mw
.widgets
.CalendarWidget
.prototype.getDisplayLayers = function () {
145 return [ 'month', 'year', 'duodecade' ].slice( this.precision
=== 'month' ? 1 : 0 );
149 * Update the calendar.
152 * @param {string|null} [fade=null] Direction in which to fade out current calendar contents,
153 * 'previous', 'next', 'up' or 'down'; or 'auto', which has the same result as 'previous' or
154 * 'next' depending on whether the current date is later or earlier than the previous.
156 mw
.widgets
.CalendarWidget
.prototype.updateUI = function ( fade
) {
157 var items
, today
, selected
, currentMonth
, currentYear
, currentDay
, i
, needsFade
,
158 $bodyWrapper
= this.$bodyWrapper
;
161 this.displayLayer
=== this.previousDisplayLayer
&&
162 this.date
=== this.previousDate
&&
163 this.previousMoment
&&
164 this.previousMoment
.isSame( this.moment
, this.precision
=== 'month' ? 'month' : 'day' )
170 if ( fade
=== 'auto' ) {
171 if ( !this.previousMoment
) {
173 } else if ( this.previousMoment
.isBefore( this.moment
, this.precision
=== 'month' ? 'month' : 'day' ) ) {
175 } else if ( this.previousMoment
.isAfter( this.moment
, this.precision
=== 'month' ? 'month' : 'day' ) ) {
183 if ( this.$oldBody
) {
184 this.$oldBody
.remove();
186 this.$oldBody
= this.$body
.addClass( 'mw-widget-calendarWidget-old-body' );
187 // Clone without children
188 this.$body
= $( this.$body
[ 0 ].cloneNode( false ) )
189 .removeClass( 'mw-widget-calendarWidget-old-body' )
190 .toggleClass( 'mw-widget-calendarWidget-body-month', this.displayLayer
=== 'month' )
191 .toggleClass( 'mw-widget-calendarWidget-body-year', this.displayLayer
=== 'year' )
192 .toggleClass( 'mw-widget-calendarWidget-body-duodecade', this.displayLayer
=== 'duodecade' );
195 selected
= moment( this.getDate(), this.getDateFormat() );
197 switch ( this.displayLayer
) {
199 this.labelButton
.setLabel( this.moment
.format( 'MMMM YYYY' ) );
200 this.upButton
.toggle( true );
202 // First week displayed is the first week spanned by the month, unless it begins on Monday, in
203 // which case first week displayed is the previous week. This makes the calendar "balanced"
204 // and also neatly handles 28-day February sometimes spanning only 4 weeks.
205 currentDay
= moment( this.moment
).startOf( 'month' ).subtract( 1, 'day' ).startOf( 'week' );
207 // Day-of-week labels. Localisation-independent: works with weeks starting on Saturday, Sunday
209 for ( i
= 0; i
< 7; i
++ ) {
212 .addClass( 'mw-widget-calendarWidget-day-heading' )
213 .text( currentDay
.format( 'dd' ) )
215 currentDay
.add( 1, 'day' );
217 currentDay
.subtract( 7, 'days' );
219 // Actual calendar month. Always displays 6 weeks, for consistency (months can span 4 to 6
221 for ( i
= 0; i
< 42; i
++ ) {
224 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-day' )
225 .toggleClass( 'mw-widget-calendarWidget-day-additional', !currentDay
.isSame( this.moment
, 'month' ) )
226 .toggleClass( 'mw-widget-calendarWidget-day-today', currentDay
.isSame( today
, 'day' ) )
227 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentDay
.isSame( selected
, 'day' ) )
228 .text( currentDay
.format( 'D' ) )
229 .data( 'date', currentDay
.date() )
230 .data( 'month', currentDay
.month() )
231 .data( 'year', currentDay
.year() )
233 currentDay
.add( 1, 'day' );
238 this.labelButton
.setLabel( this.moment
.format( 'YYYY' ) );
239 this.upButton
.toggle( true );
241 currentMonth
= moment( this.moment
).startOf( 'year' );
242 for ( i
= 0; i
< 12; i
++ ) {
245 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-month' )
246 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentMonth
.isSame( selected
, 'month' ) )
247 .text( currentMonth
.format( 'MMMM' ) )
248 .data( 'month', currentMonth
.month() )
250 currentMonth
.add( 1, 'month' );
252 // Shuffle the array to display months in columns rather than rows.
254 items
[ 0 ], items
[ 6 ], // | January | July |
255 items
[ 1 ], items
[ 7 ], // | February | August |
256 items
[ 2 ], items
[ 8 ], // | March | September |
257 items
[ 3 ], items
[ 9 ], // | April | October |
258 items
[ 4 ], items
[ 10 ], // | May | November |
259 items
[ 5 ], items
[ 11 ] // | June | December |
264 this.labelButton
.setLabel( null );
265 this.upButton
.toggle( false );
267 currentYear
= moment( { year
: Math
.floor( this.moment
.year() / 20 ) * 20 } );
268 for ( i
= 0; i
< 20; i
++ ) {
271 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-year' )
272 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentYear
.isSame( selected
, 'year' ) )
273 .text( currentYear
.format( 'YYYY' ) )
274 .data( 'year', currentYear
.year() )
276 currentYear
.add( 1, 'year' );
281 this.$body
.append
.apply( this.$body
, items
);
284 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-up' )
285 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-down' )
286 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-previous' )
287 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-next' );
289 needsFade
= this.previousDisplayLayer
!== this.displayLayer
;
290 if ( this.displayLayer
=== 'month' ) {
291 needsFade
= needsFade
|| !this.moment
.isSame( this.previousMoment
, 'month' );
292 } else if ( this.displayLayer
=== 'year' ) {
293 needsFade
= needsFade
|| !this.moment
.isSame( this.previousMoment
, 'year' );
294 } else if ( this.displayLayer
=== 'duodecade' ) {
295 needsFade
= needsFade
|| (
296 Math
.floor( this.moment
.year() / 20 ) * 20 !==
297 Math
.floor( this.previousMoment
.year() / 20 ) * 20
301 if ( fade
&& needsFade
) {
302 this.$oldBody
.find( '.mw-widget-calendarWidget-item-selected' )
303 .removeClass( 'mw-widget-calendarWidget-item-selected' );
304 if ( fade
=== 'previous' || fade
=== 'up' ) {
305 this.$body
.insertBefore( this.$oldBody
);
306 } else if ( fade
=== 'next' || fade
=== 'down' ) {
307 this.$body
.insertAfter( this.$oldBody
);
309 setTimeout( function () {
310 $bodyWrapper
.addClass( 'mw-widget-calendarWidget-body-wrapper-fade-' + fade
);
313 this.$oldBody
.replaceWith( this.$body
);
316 this.previousMoment
= moment( this.moment
);
317 this.previousDisplayLayer
= this.displayLayer
;
318 this.previousDate
= this.date
;
320 this.$body
.on( 'click', this.onBodyClick
.bind( this ) );
324 * Handle click events on the "up" button, switching to less precise view.
328 mw
.widgets
.CalendarWidget
.prototype.onUpButtonClick = function () {
330 layers
= this.getDisplayLayers(),
331 currentLayer
= layers
.indexOf( this.displayLayer
);
332 if ( currentLayer
!== layers
.length
- 1 ) {
334 this.displayLayer
= layers
[ currentLayer
+ 1 ];
335 this.updateUI( 'up' );
342 * Handle click events on the "previous" button, switching to previous pane.
346 mw
.widgets
.CalendarWidget
.prototype.onPrevButtonClick = function () {
347 switch ( this.displayLayer
) {
349 this.moment
.subtract( 1, 'month' );
352 this.moment
.subtract( 1, 'year' );
355 this.moment
.subtract( 20, 'years' );
358 this.updateUI( 'previous' );
362 * Handle click events on the "next" button, switching to next pane.
366 mw
.widgets
.CalendarWidget
.prototype.onNextButtonClick = function () {
367 switch ( this.displayLayer
) {
369 this.moment
.add( 1, 'month' );
372 this.moment
.add( 1, 'year' );
375 this.moment
.add( 20, 'years' );
378 this.updateUI( 'next' );
382 * Handle click events anywhere in the body of the widget, which contains the matrix of days,
383 * months or years to choose. Maybe change the pane or switch to more precise view, depending on
388 mw
.widgets
.CalendarWidget
.prototype.onBodyClick = function ( e
) {
390 $target
= $( e
.target
),
391 layers
= this.getDisplayLayers(),
392 currentLayer
= layers
.indexOf( this.displayLayer
);
393 if ( $target
.data( 'year' ) !== undefined ) {
394 this.moment
.year( $target
.data( 'year' ) );
396 if ( $target
.data( 'month' ) !== undefined ) {
397 this.moment
.month( $target
.data( 'month' ) );
399 if ( $target
.data( 'date' ) !== undefined ) {
400 this.moment
.date( $target
.data( 'date' ) );
402 if ( currentLayer
=== 0 ) {
403 this.setDateFromMoment();
404 this.updateUI( 'auto' );
407 this.displayLayer
= layers
[ currentLayer
- 1 ];
408 this.updateUI( 'down' );
415 * @param {string|null} [date=null] Day or month date, in the format 'YYYY-MM-DD' or 'YYYY-MM'.
416 * When null, the calendar will show today's date, but not select it. When invalid, the date
419 mw
.widgets
.CalendarWidget
.prototype.setDate = function ( date
) {
420 var mom
= date
!== null ? moment( date
, this.getDateFormat() ) : moment();
421 if ( mom
.isValid() ) {
423 if ( date
!== null ) {
424 this.setDateFromMoment();
425 } else if ( this.date
!== null ) {
427 this.emit( 'change', this.date
);
429 this.displayLayer
= this.getDisplayLayers()[ 0 ];
435 * Reset the user interface of this widget to reflect selected date.
437 mw
.widgets
.CalendarWidget
.prototype.resetUI = function () {
438 this.moment
= this.getDate() !== null ? moment( this.getDate(), this.getDateFormat() ) : moment();
439 this.displayLayer
= this.getDisplayLayers()[ 0 ];
444 * Set the date from moment object.
448 mw
.widgets
.CalendarWidget
.prototype.setDateFromMoment = function () {
449 // Switch to English locale to avoid number formatting. We want the internal value to be
450 // '2015-07-24' and not '٢٠١٥-٠٧-٢٤' even if the UI language is Arabic.
451 var newDate
= moment( this.moment
).locale( 'en' ).format( this.getDateFormat() );
452 if ( this.date
!== newDate
) {
454 this.emit( 'change', this.date
);
459 * Get current date, in the format 'YYYY-MM-DD' or 'YYYY-MM', depending on precision. Digits will
462 * @returns {string|null} Date string
464 mw
.widgets
.CalendarWidget
.prototype.getDate = function () {
469 * Handle focus events.
473 mw
.widgets
.CalendarWidget
.prototype.onFocus = function () {
474 this.displayLayer
= this.getDisplayLayers()[ 0 ];
475 this.updateUI( 'down' );
479 * Handle mouse click events.
482 * @param {jQuery.Event} e Mouse click event
484 mw
.widgets
.CalendarWidget
.prototype.onClick = function ( e
) {
485 if ( !this.isDisabled() && e
.which
=== 1 ) {
486 // Prevent unintended focussing
492 * Handle key down events.
495 * @param {jQuery.Event} e Key down event
497 mw
.widgets
.CalendarWidget
.prototype.onKeyDown = function ( e
) {
500 dir
= OO
.ui
.Element
.static.getDir( this.$element
),
502 nextDirectionKey
= dir
=== 'ltr' ? OO
.ui
.Keys
.RIGHT
: OO
.ui
.Keys
.LEFT
,
503 prevDirectionKey
= dir
=== 'ltr' ? OO
.ui
.Keys
.LEFT
: OO
.ui
.Keys
.RIGHT
,
506 if ( !this.isDisabled() ) {
508 case prevDirectionKey
:
509 this.moment
.subtract( 1, this.precision
=== 'month' ? 'month' : 'day' );
511 case nextDirectionKey
:
512 this.moment
.add( 1, this.precision
=== 'month' ? 'month' : 'day' );
515 this.moment
.subtract( 1, this.precision
=== 'month' ? 'month' : 'week' );
517 case OO
.ui
.Keys
.DOWN
:
518 this.moment
.add( 1, this.precision
=== 'month' ? 'month' : 'week' );
520 case OO
.ui
.Keys
.PAGEUP
:
521 this.moment
.subtract( 1, this.precision
=== 'month' ? 'year' : 'month' );
523 case OO
.ui
.Keys
.PAGEDOWN
:
524 this.moment
.add( 1, this.precision
=== 'month' ? 'year' : 'month' );
532 this.displayLayer
= this.getDisplayLayers()[ 0 ];
533 this.setDateFromMoment();
534 this.updateUI( 'auto' );
540 }( jQuery
, mediaWiki
) );