4 * Copyright 2010, AUTHORS.txt (http://jqueryui.com/about)
5 * Dual licensed under the MIT or GPL Version 2 licenses.
6 * http://jquery.org/license
8 * http://docs.jquery.com/UI/Tabs
14 (function( $, undefined ) {
19 function getNextTabId() {
23 function getNextListId() {
27 $.widget( "ui.tabs", {
32 cookie: null, // e.g. { expires: 7, path: '/', domain: 'jquery.com', secure: true }
38 fx: null, // e.g. { height: 'toggle', opacity: 'toggle', duration: 200 }
41 panelTemplate: "<div></div>",
45 spinner: "<em>Loading…</em>",
46 tabTemplate: "<li><a href='#{href}'><span>#{label}</span></a></li>"
53 _setOption: function( key, value ) {
54 if ( key == "selected" ) {
55 if (this.options.collapsible && value == this.options.selected ) {
60 this.options[ key ] = value;
65 _tabId: function( a ) {
66 return a.title && a.title.replace( /\s/g, "_" ).replace( /[^A-Za-z0-9\-_:\.]/g, "" ) ||
67 this.options.idPrefix + getNextTabId();
70 _sanitizeSelector: function( hash ) {
71 // we need this because an id may contain a ":"
72 return hash.replace( /:/g, "\\:" );
76 var cookie = this.cookie ||
77 ( this.cookie = this.options.cookie.name || "ui-tabs-" + getNextListId() );
78 return $.cookie.apply( null, [ cookie ].concat( $.makeArray( arguments ) ) );
81 _ui: function( tab, panel ) {
85 index: this.anchors.index( tab )
89 _cleanup: function() {
90 // restore all former loading tabs labels
91 this.lis.filter( ".ui-state-processing" )
92 .removeClass( "ui-state-processing" )
93 .find( "span:data(label.tabs)" )
96 el.html( el.data( "label.tabs" ) ).removeData( "label.tabs" );
100 _tabify: function( init ) {
103 fragmentId = /^#.+/; // Safari 2 reports '#' for an empty hash
105 this.list = this.element.find( "ol,ul" ).eq( 0 );
106 this.lis = $( "li:has(a[href])", this.list );
107 this.anchors = this.lis.map(function() {
108 return $( "a", this )[ 0 ];
110 this.panels = $( [] );
112 this.anchors.each(function( i, a ) {
113 var href = $( a ).attr( "href" );
114 // For dynamically created HTML that contains a hash as href IE < 8 expands
115 // such href to the full page url with hash and then misinterprets tab as ajax.
116 // Same consideration applies for an added tab with a fragment identifier
117 // since a[href=#fragment-identifier] does unexpectedly not match.
118 // Thus normalize href attribute...
119 var hrefBase = href.split( "#" )[ 0 ],
121 if ( hrefBase && ( hrefBase === location.toString().split( "#" )[ 0 ] ||
122 ( baseEl = $( "base" )[ 0 ]) && hrefBase === baseEl.href ) ) {
128 if ( fragmentId.test( href ) ) {
129 self.panels = self.panels.add( self._sanitizeSelector( href ) );
131 // prevent loading the page itself if href is just "#"
132 } else if ( href !== "#" ) {
133 // required for restore on destroy
134 $.data( a, "href.tabs", href );
136 // TODO until #3808 is fixed strip fragment identifier from url
137 // (IE fails to load from such url)
138 $.data( a, "load.tabs", href.replace( /#.*$/, "" ) );
140 var id = self._tabId( a );
142 var $panel = $( "#" + id );
143 if ( !$panel.length ) {
144 $panel = $( o.panelTemplate )
146 .addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom" )
147 .insertAfter( self.panels[ i - 1 ] || self.list );
148 $panel.data( "destroy.tabs", true );
150 self.panels = self.panels.add( $panel );
153 o.disabled.push( i );
157 // initialization from scratch
159 // attach necessary classes for styling
160 this.element.addClass( "ui-tabs ui-widget ui-widget-content ui-corner-all" );
161 this.list.addClass( "ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" );
162 this.lis.addClass( "ui-state-default ui-corner-top" );
163 this.panels.addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom" );
166 // use "selected" option or try to retrieve:
167 // 1. from fragment identifier in url
169 // 3. from selected class attribute on <li>
170 if ( o.selected === undefined ) {
171 if ( location.hash ) {
172 this.anchors.each(function( i, a ) {
173 if ( a.hash == location.hash ) {
179 if ( typeof o.selected !== "number" && o.cookie ) {
180 o.selected = parseInt( self._cookie(), 10 );
182 if ( typeof o.selected !== "number" && this.lis.filter( ".ui-tabs-selected" ).length ) {
183 o.selected = this.lis.index( this.lis.filter( ".ui-tabs-selected" ) );
185 o.selected = o.selected || ( this.lis.length ? 0 : -1 );
186 } else if ( o.selected === null ) { // usage of null is deprecated, TODO remove in next release
190 // sanity check - default to first tab...
191 o.selected = ( ( o.selected >= 0 && this.anchors[ o.selected ] ) || o.selected < 0 )
195 // Take disabling tabs via class attribute from HTML
196 // into account and update option properly.
197 // A selected tab cannot become disabled.
198 o.disabled = $.unique( o.disabled.concat(
199 $.map( this.lis.filter( ".ui-state-disabled" ), function( n, i ) {
200 return self.lis.index( n );
204 if ( $.inArray( o.selected, o.disabled ) != -1 ) {
205 o.disabled.splice( $.inArray( o.selected, o.disabled ), 1 );
208 // highlight selected tab
209 this.panels.addClass( "ui-tabs-hide" );
210 this.lis.removeClass( "ui-tabs-selected ui-state-active" );
211 // check for length avoids error when initializing empty list
212 if ( o.selected >= 0 && this.anchors.length ) {
213 this.panels.eq( o.selected ).removeClass( "ui-tabs-hide" );
214 this.lis.eq( o.selected ).addClass( "ui-tabs-selected ui-state-active" );
216 // seems to be expected behavior that the show callback is fired
217 self.element.queue( "tabs", function() {
218 self._trigger( "show", null,
219 self._ui( self.anchors[ o.selected ], self.panels[ o.selected ] ) );
222 this.load( o.selected );
225 // clean up to avoid memory leaks in certain versions of IE 6
226 // TODO: namespace this event
227 $( window ).bind( "unload", function() {
228 self.lis.add( self.anchors ).unbind( ".tabs" );
229 self.lis = self.anchors = self.panels = null;
231 // update selected after add/remove
233 o.selected = this.lis.index( this.lis.filter( ".ui-tabs-selected" ) );
236 // update collapsible
237 // TODO: use .toggleClass()
238 this.element[ o.collapsible ? "addClass" : "removeClass" ]( "ui-tabs-collapsible" );
240 // set or update cookie after init and add/remove respectively
242 this._cookie( o.selected, o.cookie );
246 for ( var i = 0, li; ( li = this.lis[ i ] ); i++ ) {
247 $( li )[ $.inArray( i, o.disabled ) != -1 &&
248 // TODO: use .toggleClass()
249 !$( li ).hasClass( "ui-tabs-selected" ) ? "addClass" : "removeClass" ]( "ui-state-disabled" );
252 // reset cache if switching from cached to not cached
253 if ( o.cache === false ) {
254 this.anchors.removeData( "cache.tabs" );
257 // remove all handlers before, tabify may run on existing tabs after add or option change
258 this.lis.add( this.anchors ).unbind( ".tabs" );
260 if ( o.event !== "mouseover" ) {
261 var addState = function( state, el ) {
262 if ( el.is( ":not(.ui-state-disabled)" ) ) {
263 el.addClass( "ui-state-" + state );
266 var removeState = function( state, el ) {
267 el.removeClass( "ui-state-" + state );
269 this.lis.bind( "mouseover.tabs" , function() {
270 addState( "hover", $( this ) );
272 this.lis.bind( "mouseout.tabs", function() {
273 removeState( "hover", $( this ) );
275 this.anchors.bind( "focus.tabs", function() {
276 addState( "focus", $( this ).closest( "li" ) );
278 this.anchors.bind( "blur.tabs", function() {
279 removeState( "focus", $( this ).closest( "li" ) );
286 if ( $.isArray( o.fx ) ) {
290 hideFx = showFx = o.fx;
294 // Reset certain styles left over from animation
295 // and prevent IE's ClearType bug...
296 function resetStyle( $el, fx ) {
297 $el.css( "display", "" );
298 if ( !$.support.opacity && fx.opacity ) {
299 $el[ 0 ].style.removeAttribute( "filter" );
305 ? function( clicked, $show ) {
306 $( clicked ).closest( "li" ).addClass( "ui-tabs-selected ui-state-active" );
307 $show.hide().removeClass( "ui-tabs-hide" ) // avoid flicker that way
308 .animate( showFx, showFx.duration || "normal", function() {
309 resetStyle( $show, showFx );
310 self._trigger( "show", null, self._ui( clicked, $show[ 0 ] ) );
313 : function( clicked, $show ) {
314 $( clicked ).closest( "li" ).addClass( "ui-tabs-selected ui-state-active" );
315 $show.removeClass( "ui-tabs-hide" );
316 self._trigger( "show", null, self._ui( clicked, $show[ 0 ] ) );
319 // Hide a tab, $show is optional...
321 ? function( clicked, $hide ) {
322 $hide.animate( hideFx, hideFx.duration || "normal", function() {
323 self.lis.removeClass( "ui-tabs-selected ui-state-active" );
324 $hide.addClass( "ui-tabs-hide" );
325 resetStyle( $hide, hideFx );
326 self.element.dequeue( "tabs" );
329 : function( clicked, $hide, $show ) {
330 self.lis.removeClass( "ui-tabs-selected ui-state-active" );
331 $hide.addClass( "ui-tabs-hide" );
332 self.element.dequeue( "tabs" );
335 // attach tab event handler, unbind to avoid duplicates from former tabifying...
336 this.anchors.bind( o.event + ".tabs", function() {
338 $li = $(el).closest( "li" ),
339 $hide = self.panels.filter( ":not(.ui-tabs-hide)" ),
340 $show = $( self._sanitizeSelector( el.hash ) );
342 // If tab is already selected and not collapsible or tab disabled or
343 // or is already loading or click callback returns false stop here.
344 // Check if click handler returns false last so that it is not executed
345 // for a disabled or loading tab!
346 if ( ( $li.hasClass( "ui-tabs-selected" ) && !o.collapsible) ||
347 $li.hasClass( "ui-state-disabled" ) ||
348 $li.hasClass( "ui-state-processing" ) ||
349 self._trigger( "select", null, self._ui( this, $show[ 0 ] ) ) === false ) {
354 o.selected = self.anchors.index( this );
358 // if tab may be closed
359 if ( o.collapsible ) {
360 if ( $li.hasClass( "ui-tabs-selected" ) ) {
364 self._cookie( o.selected, o.cookie );
367 self.element.queue( "tabs", function() {
368 hideTab( el, $hide );
369 }).dequeue( "tabs" );
373 } else if ( !$hide.length ) {
375 self._cookie( o.selected, o.cookie );
378 self.element.queue( "tabs", function() {
379 showTab( el, $show );
382 // TODO make passing in node possible, see also http://dev.jqueryui.com/ticket/3171
383 self.load( self.anchors.index( this ) );
391 self._cookie( o.selected, o.cookie );
395 if ( $show.length ) {
396 if ( $hide.length ) {
397 self.element.queue( "tabs", function() {
398 hideTab( el, $hide );
401 self.element.queue( "tabs", function() {
402 showTab( el, $show );
405 self.load( self.anchors.index( this ) );
407 throw "jquery UI Tabs: Mismatching fragment identifier.";
410 // Prevent IE from keeping other link focussed when using the back button
411 // and remove dotted border from clicked link. This is controlled via CSS
412 // in modern browsers; blur() removes focus from address bar in Firefox
413 // which can become a usability and annoying problem with tabs('rotate').
414 if ( $.browser.msie ) {
419 // disable click in any case
420 this.anchors.bind( "click.tabs", function(){
425 _getIndex: function( index ) {
426 // meta-function to give users option to provide a href string instead of a numerical index.
427 // also sanitizes numerical indexes to valid values.
428 if ( typeof index == "string" ) {
429 index = this.anchors.index( this.anchors.filter( "[href$=" + index + "]" ) );
435 destroy: function() {
436 var o = this.options;
442 .removeClass( "ui-tabs ui-widget ui-widget-content ui-corner-all ui-tabs-collapsible" )
443 .removeData( "tabs" );
445 this.list.removeClass( "ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" );
447 this.anchors.each(function() {
448 var href = $.data( this, "href.tabs" );
452 var $this = $( this ).unbind( ".tabs" );
453 $.each( [ "href", "load", "cache" ], function( i, prefix ) {
454 $this.removeData( prefix + ".tabs" );
458 this.lis.unbind( ".tabs" ).add( this.panels ).each(function() {
459 if ( $.data( this, "destroy.tabs" ) ) {
462 $( this ).removeClass([
479 this._cookie( null, o.cookie );
485 add: function( url, label, index ) {
486 if ( index === undefined ) {
487 index = this.anchors.length;
492 $li = $( o.tabTemplate.replace( /#\{href\}/g, url ).replace( /#\{label\}/g, label ) ),
493 id = !url.indexOf( "#" ) ? url.replace( "#", "" ) : this._tabId( $( "a", $li )[ 0 ] );
495 $li.addClass( "ui-state-default ui-corner-top" ).data( "destroy.tabs", true );
497 // try to find an existing element before creating a new one
498 var $panel = $( "#" + id );
499 if ( !$panel.length ) {
500 $panel = $( o.panelTemplate )
502 .data( "destroy.tabs", true );
504 $panel.addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom ui-tabs-hide" );
506 if ( index >= this.lis.length ) {
507 $li.appendTo( this.list );
508 $panel.appendTo( this.list[ 0 ].parentNode );
510 $li.insertBefore( this.lis[ index ] );
511 $panel.insertBefore( this.panels[ index ] );
514 o.disabled = $.map( o.disabled, function( n, i ) {
515 return n >= index ? ++n : n;
520 if ( this.anchors.length == 1 ) {
522 $li.addClass( "ui-tabs-selected ui-state-active" );
523 $panel.removeClass( "ui-tabs-hide" );
524 this.element.queue( "tabs", function() {
525 self._trigger( "show", null, self._ui( self.anchors[ 0 ], self.panels[ 0 ] ) );
531 this._trigger( "add", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
535 remove: function( index ) {
536 index = this._getIndex( index );
537 var o = this.options,
538 $li = this.lis.eq( index ).remove(),
539 $panel = this.panels.eq( index ).remove();
541 // If selected tab was removed focus tab to the right or
542 // in case the last tab was removed the tab to the left.
543 if ( $li.hasClass( "ui-tabs-selected" ) && this.anchors.length > 1) {
544 this.select( index + ( index + 1 < this.anchors.length ? 1 : -1 ) );
548 $.grep( o.disabled, function(n, i) {
552 return n >= index ? --n : n;
557 this._trigger( "remove", null, this._ui( $li.find( "a" )[ 0 ], $panel[ 0 ] ) );
561 enable: function( index ) {
562 index = this._getIndex( index );
563 var o = this.options;
564 if ( $.inArray( index, o.disabled ) == -1 ) {
568 this.lis.eq( index ).removeClass( "ui-state-disabled" );
569 o.disabled = $.grep( o.disabled, function( n, i ) {
573 this._trigger( "enable", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
577 disable: function( index ) {
578 index = this._getIndex( index );
579 var self = this, o = this.options;
580 // cannot disable already selected tab
581 if ( index != o.selected ) {
582 this.lis.eq( index ).addClass( "ui-state-disabled" );
584 o.disabled.push( index );
587 this._trigger( "disable", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
593 select: function( index ) {
594 index = this._getIndex( index );
596 if ( this.options.collapsible && this.options.selected != -1 ) {
597 index = this.options.selected;
602 this.anchors.eq( index ).trigger( this.options.event + ".tabs" );
606 load: function( index ) {
607 index = this._getIndex( index );
610 a = this.anchors.eq( index )[ 0 ],
611 url = $.data( a, "load.tabs" );
615 // not remote or from cache
616 if ( !url || this.element.queue( "tabs" ).length !== 0 && $.data( a, "cache.tabs" ) ) {
617 this.element.dequeue( "tabs" );
621 // load remote from here on
622 this.lis.eq( index ).addClass( "ui-state-processing" );
625 var span = $( "span", a );
626 span.data( "label.tabs", span.html() ).html( o.spinner );
629 this.xhr = $.ajax( $.extend( {}, o.ajaxOptions, {
631 success: function( r, s ) {
632 $( self._sanitizeSelector( a.hash ) ).html( r );
634 // take care of tab labels
638 $.data( a, "cache.tabs", true );
641 self._trigger( "load", null, self._ui( self.anchors[ index ], self.panels[ index ] ) );
643 o.ajaxOptions.success( r, s );
647 error: function( xhr, s, e ) {
648 // take care of tab labels
651 self._trigger( "load", null, self._ui( self.anchors[ index ], self.panels[ index ] ) );
653 // Passing index avoid a race condition when this method is
654 // called after the user has selected another tab.
655 // Pass the anchor that initiated this request allows
656 // loadError to manipulate the tab content panel via $(a.hash)
657 o.ajaxOptions.error( xhr, s, index, a );
663 // last, so that load event is fired before show...
664 self.element.dequeue( "tabs" );
670 // stop possibly running animations
671 this.element.queue( [] );
672 this.panels.stop( false, true );
674 // "tabs" queue must not contain more than two elements,
675 // which are the callbacks for the latest clicked tab...
676 this.element.queue( "tabs", this.element.queue( "tabs" ).splice( -2, 2 ) );
678 // terminate pending requests from other tabs
684 // take care of tab labels
689 url: function( index, url ) {
690 this.anchors.eq( index ).removeData( "cache.tabs" ).data( "load.tabs", url );
695 return this.anchors.length;
699 $.extend( $.ui.tabs, {
710 $.extend( $.ui.tabs.prototype, {
712 rotate: function( ms, continuing ) {
716 var rotate = self._rotate || ( self._rotate = function( e ) {
717 clearTimeout( self.rotation );
718 self.rotation = setTimeout(function() {
720 self.select( ++t < self.anchors.length ? t : 0 );
728 var stop = self._unrotate || ( self._unrotate = !continuing
730 if (e.clientX) { // in case of a true click
741 this.element.bind( "tabsshow", rotate );
742 this.anchors.bind( o.event + ".tabs", stop );
746 clearTimeout( self.rotation );
747 this.element.unbind( "tabsshow", rotate );
748 this.anchors.unbind( o.event + ".tabs", stop );
750 delete this._unrotate;