mediawiki-skins-Vector/resources/skins.vector.js/collapsibleTabs.js

225 lines
7.6 KiB
JavaScript
Raw Normal View History

( function () {
var boundEvent,
isRTL = document.documentElement.dir === 'rtl',
rAF = window.requestAnimationFrame || setTimeout;
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
/**
* A jQuery plugin that makes collapsible tabs for the Vector skin.
*
* @class jQuery.plugin.collapsibleTabs
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
* @param {Object} [options]
* @param {string} [options.expandedContainer=#p-views ul] List of tabs
* @param {string} [options.collapsedContainer=#p-cactions ul] List of menu items
* @param {string} [options.collapsible=li.collapsible] Match tabs that are collapsible
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
* @param {Function} [options.expandCondition]
* @param {Function} [options.collapseCondition]
*/
$.fn.collapsibleTabs = function ( options ) {
// Merge options into the defaults
var settings = $.extend( {}, $.collapsibleTabs.defaults, options );
// return if the function is called on an empty jquery object
if ( !this.length ) {
return this;
}
this.each( function () {
var $el = $( this );
// add the element to our array of collapsible managers
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
$.collapsibleTabs.instances.push( $el );
// attach the settings to the elements
$el.data( 'collapsibleTabsSettings', settings );
// attach data to our collapsible elements
$el.children( settings.collapsible ).each( function () {
$.collapsibleTabs.addData( $( this ) );
} );
} );
// if we haven't already bound our resize handler, bind it now
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
if ( !boundEvent ) {
boundEvent = true;
$( window ).on( 'resize', mw.util.debounce( 10, function () {
rAF( $.collapsibleTabs.handleResize );
} ) );
}
// call our resize handler to setup the page
rAF( $.collapsibleTabs.handleResize );
return this;
};
$.collapsibleTabs = {
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
instances: [],
defaults: {
expandedContainer: '#p-views ul',
collapsedContainer: '#p-cactions ul',
collapsible: 'li.collapsible',
shifting: false,
expandCondition: function ( eleWidth ) {
// If there are at least eleWidth + 1 pixels of free space, expand.
// We add 1 because .width() will truncate fractional values but .offset() will not.
return $.collapsibleTabs.calculateTabDistance() >= eleWidth + 1;
},
collapseCondition: function () {
// If there's an overlap, collapse.
return $.collapsibleTabs.calculateTabDistance() < 0;
}
},
addData: function ( $collapsible ) {
var settings = $collapsible.parent().data( 'collapsibleTabsSettings' );
if ( settings ) {
$collapsible.data( 'collapsibleTabsSettings', {
expandedContainer: settings.expandedContainer,
collapsedContainer: settings.collapsedContainer,
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
expandedWidth: $collapsible.width()
} );
}
},
getSettings: function ( $collapsible ) {
var settings = $collapsible.data( 'collapsibleTabsSettings' );
if ( !settings ) {
$.collapsibleTabs.addData( $collapsible );
settings = $collapsible.data( 'collapsibleTabsSettings' );
}
return settings;
},
handleResize: function () {
$.collapsibleTabs.instances.forEach( function ( $el ) {
var $tab,
data = $.collapsibleTabs.getSettings( $el );
if ( data.shifting ) {
return;
}
// if the two navigations are colliding
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
if ( $el.children( data.collapsible ).length && data.collapseCondition() ) {
/**
* Fired before tabs are moved to "collapsedContainer".
*
* @event beforeTabCollapse
* @memberof jQuery.plugin.collapsibleTabs
*/
$el.trigger( 'beforeTabCollapse' );
// Move the element to the dropdown menu.
$.collapsibleTabs.moveToCollapsed( $el.children( data.collapsible ).last() );
}
$tab = $( data.collapsedContainer ).children( data.collapsible ).first();
// if there are still moveable items in the dropdown menu,
// and there is sufficient space to place them in the tab container
if (
$( data.collapsedContainer + ' ' + data.collapsible ).length &&
data.expandCondition(
$.collapsibleTabs.getSettings( $tab ).expandedWidth
)
) {
/**
* Fired before tabs are moved to "expandedContainer".
*
* @event beforeTabExpand
* @memberof jQuery.plugin.collapsibleTabs
*/
$el.trigger( 'beforeTabExpand' );
$.collapsibleTabs.moveToExpanded( $tab );
}
} );
},
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
moveToCollapsed: function ( $moving ) {
var outerData, expContainerSettings, target;
outerData = $.collapsibleTabs.getSettings( $moving );
if ( !outerData ) {
return;
}
expContainerSettings = $.collapsibleTabs.getSettings(
$( outerData.expandedContainer )
);
if ( !expContainerSettings ) {
return;
}
expContainerSettings.shifting = true;
// Remove the element from where it's at and put it in the dropdown menu
target = outerData.collapsedContainer;
// eslint-disable-next-line no-jquery/no-animate
$moving.css( 'position', 'relative' )
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
.css( ( isRTL ? 'left' : 'right' ), 0 )
.animate( { width: '1px' }, 'normal', function () {
$( this ).hide();
// add the placeholder
$( '<span>' ).addClass( 'placeholder' ).css( 'display', 'none' ).insertAfter( this );
$( this ).detach().prependTo( target ).data( 'collapsibleTabsSettings', outerData );
$( this ).attr( 'style', 'display: list-item;' );
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
expContainerSettings.shifting = false;
rAF( $.collapsibleTabs.handleResize );
} );
},
moveToExpanded: function ( $moving ) {
var data, expContainerSettings, $target, expandedWidth;
data = $.collapsibleTabs.getSettings( $moving );
if ( !data ) {
return;
}
expContainerSettings = $.collapsibleTabs.getSettings( $( data.expandedContainer ) );
if ( !expContainerSettings ) {
return;
}
expContainerSettings.shifting = true;
// grab the next appearing placeholder so we can use it for replacing
$target = $( data.expandedContainer ).find( 'span.placeholder' ).first();
expandedWidth = data.expandedWidth;
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
$moving.css( 'position', 'relative' ).css( ( isRTL ? 'right' : 'left' ), 0 ).css( 'width', '1px' );
$target.replaceWith(
// eslint-disable-next-line no-jquery/no-animate
$moving
.detach()
.css( 'width', '1px' )
.data( 'collapsibleTabsSettings', data )
.animate( { width: expandedWidth + 'px' }, 'normal', function () {
$( this ).attr( 'style', 'display: block;' );
rAF( function () {
// Update the 'expandedWidth' in case someone was brazen enough to
// change the tab's contents after the page load *gasp* (T71729). This
// doesn't prevent a tab from collapsing back and forth once, but at
// least it won't continue to do that forever.
data.expandedWidth = $moving.width();
$moving.data( 'collapsibleTabsSettings', data );
expContainerSettings.shifting = false;
$.collapsibleTabs.handleResize();
} );
} )
);
},
/**
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
* Get the amount of horizontal distance between the two tabs groups in pixels.
*
* Uses `#left-navigation` and `#right-navigation`. If negative, this
* means that the tabs overlap, and the value is the width of overlapping
* parts.
*
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
* Used in default `expandCondition` and `collapseCondition` options.
*
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
* @return {number} distance/overlap in pixels
*/
calculateTabDistance: function () {
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
var leftTab, rightTab, leftEnd, rightStart;
// In RTL, #right-navigation is actually on the left and vice versa.
// Hooray for descriptive naming.
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
if ( !isRTL ) {
leftTab = document.getElementById( 'left-navigation' );
rightTab = document.getElementById( 'right-navigation' );
} else {
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
leftTab = document.getElementById( 'right-navigation' );
rightTab = document.getElementById( 'left-navigation' );
}
collapsibleTabs: Clean up and simplify code * Rename 'rtl' to 'isRTL' and use DOM to compute its value. * Document code with JSDuck similar to other extensions. * Remove unused 'prevElement' property. Not used in Vector nor anywhere else in Wikimedia Git. * Make 'boundEvent' property private. Not used anywhere in Wikimedia Git outside this file. * Simplify 'instances' tracking. The jQuery object stored in this property wasn't used beyond calling each(). Convert to a plain array. Preserve and re-use the jQuery object first created by collapsibleTabs(). * Simplify calculateTabDistance() by using getElementById() and getBoundingClientRect(). Its support includes IE 5. The "new" version (since Firefox 3.5 and IE 9) also includes 'height' and 'width' properties and is supported in all browsers supported by the MediaWiki 1.28 startup feature test. This helps avoid code in offset() and width(), which is fairly expensive in jQuery 1.x. * moveToCollapsed() - Remove redundant jQuery object creation (only caller passes a jQuery object already). - Remove redundant re-receiving of expContainerSettings inside the animate() callback. Already in the main scope. Relates to a bunch of patches that work around a problem caused by use of remove() instead of detach() in an earlier version of the code. Which was only a problem because the other settings object was also not used from the main scope. (See pre-Gerrit commits 1f93310e and e7900807.) Change-Id: I48d542580d767df2d17ce4c6668e9e233a0f7902
2016-11-28 23:14:33 +00:00
leftEnd = leftTab.getBoundingClientRect().right;
rightStart = rightTab.getBoundingClientRect().left;
return rightStart - leftEnd;
}
};
}() );