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.
155 * @returns {string} Format
157 mw
.widgets
.CalendarWidget
.prototype.updateUI = function ( fade
) {
158 var items
, today
, selected
, currentMonth
, currentYear
, currentDay
, i
, needsFade
,
159 $bodyWrapper
= this.$bodyWrapper
;
162 this.displayLayer
=== this.previousDisplayLayer
&&
163 this.date
=== this.previousDate
&&
164 this.previousMoment
&&
165 this.previousMoment
.isSame( this.moment
, this.precision
=== 'month' ? 'month' : 'day' )
171 if ( fade
=== 'auto' ) {
172 if ( !this.previousMoment
) {
174 } else if ( this.previousMoment
.isBefore( this.moment
, this.precision
=== 'month' ? 'month' : 'day' ) ) {
176 } else if ( this.previousMoment
.isAfter( this.moment
, this.precision
=== 'month' ? 'month' : 'day' ) ) {
184 if ( this.$oldBody
) {
185 this.$oldBody
.remove();
187 this.$oldBody
= this.$body
.addClass( 'mw-widget-calendarWidget-old-body' );
188 // Clone without children
189 this.$body
= $( this.$body
[ 0 ].cloneNode( false ) )
190 .removeClass( 'mw-widget-calendarWidget-old-body' )
191 .toggleClass( 'mw-widget-calendarWidget-body-month', this.displayLayer
=== 'month' )
192 .toggleClass( 'mw-widget-calendarWidget-body-year', this.displayLayer
=== 'year' )
193 .toggleClass( 'mw-widget-calendarWidget-body-duodecade', this.displayLayer
=== 'duodecade' );
196 selected
= moment( this.getDate(), this.getDateFormat() );
198 switch ( this.displayLayer
) {
200 this.labelButton
.setLabel( this.moment
.format( 'MMMM YYYY' ) );
201 this.upButton
.toggle( true );
203 // First week displayed is the first week spanned by the month, unless it begins on Monday, in
204 // which case first week displayed is the previous week. This makes the calendar "balanced"
205 // and also neatly handles 28-day February sometimes spanning only 4 weeks.
206 currentDay
= moment( this.moment
).startOf( 'month' ).subtract( 1, 'day' ).startOf( 'week' );
208 // Day-of-week labels. Localisation-independent: works with weeks starting on Saturday, Sunday
210 for ( i
= 0; i
< 7; i
++ ) {
213 .addClass( 'mw-widget-calendarWidget-day-heading' )
214 .text( currentDay
.format( 'dd' ) )
216 currentDay
.add( 1, 'day' );
218 currentDay
.subtract( 7, 'days' );
220 // Actual calendar month. Always displays 6 weeks, for consistency (months can span 4 to 6
222 for ( i
= 0; i
< 42; i
++ ) {
225 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-day' )
226 .toggleClass( 'mw-widget-calendarWidget-day-additional', !currentDay
.isSame( this.moment
, 'month' ) )
227 .toggleClass( 'mw-widget-calendarWidget-day-today', currentDay
.isSame( today
, 'day' ) )
228 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentDay
.isSame( selected
, 'day' ) )
229 .text( currentDay
.format( 'D' ) )
230 .data( 'date', currentDay
.date() )
231 .data( 'month', currentDay
.month() )
232 .data( 'year', currentDay
.year() )
234 currentDay
.add( 1, 'day' );
239 this.labelButton
.setLabel( this.moment
.format( 'YYYY' ) );
240 this.upButton
.toggle( true );
242 currentMonth
= moment( this.moment
).startOf( 'year' );
243 for ( i
= 0; i
< 12; i
++ ) {
246 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-month' )
247 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentMonth
.isSame( selected
, 'month' ) )
248 .text( currentMonth
.format( 'MMMM' ) )
249 .data( 'month', currentMonth
.month() )
251 currentMonth
.add( 1, 'month' );
253 // Shuffle the array to display months in columns rather than rows.
255 items
[ 0 ], items
[ 6 ], // | January | July |
256 items
[ 1 ], items
[ 7 ], // | February | August |
257 items
[ 2 ], items
[ 8 ], // | March | September |
258 items
[ 3 ], items
[ 9 ], // | April | October |
259 items
[ 4 ], items
[ 10 ], // | May | November |
260 items
[ 5 ], items
[ 11 ] // | June | December |
265 this.labelButton
.setLabel( null );
266 this.upButton
.toggle( false );
268 currentYear
= moment( { year
: Math
.floor( this.moment
.year() / 20 ) * 20 } );
269 for ( i
= 0; i
< 20; i
++ ) {
272 .addClass( 'mw-widget-calendarWidget-item mw-widget-calendarWidget-year' )
273 .toggleClass( 'mw-widget-calendarWidget-item-selected', currentYear
.isSame( selected
, 'year' ) )
274 .text( currentYear
.format( 'YYYY' ) )
275 .data( 'year', currentYear
.year() )
277 currentYear
.add( 1, 'year' );
282 this.$body
.append
.apply( this.$body
, items
);
285 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-up' )
286 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-down' )
287 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-previous' )
288 .removeClass( 'mw-widget-calendarWidget-body-wrapper-fade-next' );
290 needsFade
= this.previousDisplayLayer
!== this.displayLayer
;
291 if ( this.displayLayer
=== 'month' ) {
292 needsFade
= needsFade
|| !this.moment
.isSame( this.previousMoment
, 'month' );
293 } else if ( this.displayLayer
=== 'year' ) {
294 needsFade
= needsFade
|| !this.moment
.isSame( this.previousMoment
, 'year' );
295 } else if ( this.displayLayer
=== 'duodecade' ) {
296 needsFade
= needsFade
|| (
297 Math
.floor( this.moment
.year() / 20 ) * 20 !==
298 Math
.floor( this.previousMoment
.year() / 20 ) * 20
302 if ( fade
&& needsFade
) {
303 this.$oldBody
.find( '.mw-widget-calendarWidget-item-selected' )
304 .removeClass( 'mw-widget-calendarWidget-item-selected' );
305 if ( fade
=== 'previous' || fade
=== 'up' ) {
306 this.$body
.insertBefore( this.$oldBody
);
307 } else if ( fade
=== 'next' || fade
=== 'down' ) {
308 this.$body
.insertAfter( this.$oldBody
);
310 setTimeout( function () {
311 $bodyWrapper
.addClass( 'mw-widget-calendarWidget-body-wrapper-fade-' + fade
);
314 this.$oldBody
.replaceWith( this.$body
);
317 this.previousMoment
= moment( this.moment
);
318 this.previousDisplayLayer
= this.displayLayer
;
319 this.previousDate
= this.date
;
321 this.$body
.on( 'click', this.onBodyClick
.bind( this ) );
325 * Handle click events on the "up" button, switching to less precise view.
329 mw
.widgets
.CalendarWidget
.prototype.onUpButtonClick = function () {
331 layers
= this.getDisplayLayers(),
332 currentLayer
= layers
.indexOf( this.displayLayer
);
333 if ( currentLayer
!== layers
.length
- 1 ) {
335 this.displayLayer
= layers
[ currentLayer
+ 1 ];
336 this.updateUI( 'up' );
343 * Handle click events on the "previous" button, switching to previous pane.
347 mw
.widgets
.CalendarWidget
.prototype.onPrevButtonClick = function () {
348 switch ( this.displayLayer
) {
350 this.moment
.subtract( 1, 'month' );
353 this.moment
.subtract( 1, 'year' );
356 this.moment
.subtract( 20, 'years' );
359 this.updateUI( 'previous' );
363 * Handle click events on the "next" button, switching to next pane.
367 mw
.widgets
.CalendarWidget
.prototype.onNextButtonClick = function () {
368 switch ( this.displayLayer
) {
370 this.moment
.add( 1, 'month' );
373 this.moment
.add( 1, 'year' );
376 this.moment
.add( 20, 'years' );
379 this.updateUI( 'next' );
383 * Handle click events anywhere in the body of the widget, which contains the matrix of days,
384 * months or years to choose. Maybe change the pane or switch to more precise view, depending on
389 mw
.widgets
.CalendarWidget
.prototype.onBodyClick = function ( e
) {
391 $target
= $( e
.target
),
392 layers
= this.getDisplayLayers(),
393 currentLayer
= layers
.indexOf( this.displayLayer
);
394 if ( $target
.data( 'year' ) !== undefined ) {
395 this.moment
.year( $target
.data( 'year' ) );
397 if ( $target
.data( 'month' ) !== undefined ) {
398 this.moment
.month( $target
.data( 'month' ) );
400 if ( $target
.data( 'date' ) !== undefined ) {
401 this.moment
.date( $target
.data( 'date' ) );
403 if ( currentLayer
=== 0 ) {
404 this.setDateFromMoment();
405 this.updateUI( 'auto' );
408 this.displayLayer
= layers
[ currentLayer
- 1 ];
409 this.updateUI( 'down' );
416 * @param {string|null} [date=null] Day or month date, in the format 'YYYY-MM-DD' or 'YYYY-MM'.
417 * When null, the calendar will show today's date, but not select it. When invalid, the date
420 mw
.widgets
.CalendarWidget
.prototype.setDate = function ( date
) {
421 var mom
= date
!== null ? moment( date
, this.getDateFormat() ) : moment();
422 if ( mom
.isValid() ) {
424 if ( date
!== null ) {
425 this.setDateFromMoment();
426 } else if ( this.date
!== null ) {
428 this.emit( 'change', this.date
);
430 this.displayLayer
= this.getDisplayLayers()[ 0 ];
436 * Reset the user interface of this widget to reflect selected date.
438 mw
.widgets
.CalendarWidget
.prototype.resetUI = function () {
439 this.moment
= this.getDate() !== null ? moment( this.getDate(), this.getDateFormat() ) : moment();
440 this.displayLayer
= this.getDisplayLayers()[ 0 ];
445 * Set the date from moment object.
449 mw
.widgets
.CalendarWidget
.prototype.setDateFromMoment = function () {
450 // Switch to English locale to avoid number formatting. We want the internal value to be
451 // '2015-07-24' and not '٢٠١٥-٠٧-٢٤' even if the UI language is Arabic.
452 var newDate
= moment( this.moment
).locale( 'en' ).format( this.getDateFormat() );
453 if ( this.date
!== newDate
) {
455 this.emit( 'change', this.date
);
460 * Get current date, in the format 'YYYY-MM-DD' or 'YYYY-MM', depending on precision. Digits will
463 * @returns {string|null} Date string
465 mw
.widgets
.CalendarWidget
.prototype.getDate = function () {
470 * Handle focus events.
474 mw
.widgets
.CalendarWidget
.prototype.onFocus = function () {
475 this.displayLayer
= this.getDisplayLayers()[ 0 ];
476 this.updateUI( 'down' );
480 * Handle mouse click events.
483 * @param {jQuery.Event} e Mouse click event
485 mw
.widgets
.CalendarWidget
.prototype.onClick = function ( e
) {
486 if ( !this.isDisabled() && e
.which
=== 1 ) {
487 // Prevent unintended focussing
493 * Handle key down events.
496 * @param {jQuery.Event} e Key down event
498 mw
.widgets
.CalendarWidget
.prototype.onKeyDown = function ( e
) {
501 dir
= OO
.ui
.Element
.static.getDir( this.$element
),
503 nextDirectionKey
= dir
=== 'ltr' ? OO
.ui
.Keys
.RIGHT
: OO
.ui
.Keys
.LEFT
,
504 prevDirectionKey
= dir
=== 'ltr' ? OO
.ui
.Keys
.LEFT
: OO
.ui
.Keys
.RIGHT
,
507 if ( !this.isDisabled() ) {
509 case prevDirectionKey
:
510 this.moment
.subtract( 1, this.precision
=== 'month' ? 'month' : 'day' );
512 case nextDirectionKey
:
513 this.moment
.add( 1, this.precision
=== 'month' ? 'month' : 'day' );
516 this.moment
.subtract( 1, this.precision
=== 'month' ? 'month' : 'week' );
518 case OO
.ui
.Keys
.DOWN
:
519 this.moment
.add( 1, this.precision
=== 'month' ? 'month' : 'week' );
521 case OO
.ui
.Keys
.PAGEUP
:
522 this.moment
.subtract( 1, this.precision
=== 'month' ? 'year' : 'month' );
524 case OO
.ui
.Keys
.PAGEDOWN
:
525 this.moment
.add( 1, this.precision
=== 'month' ? 'year' : 'month' );
533 this.displayLayer
= this.getDisplayLayers()[ 0 ];
534 this.setDateFromMoment();
535 this.updateUI( 'auto' );
541 }( jQuery
, mediaWiki
) );