mediawiki-extensions-Catego.../modules/ext.categoryTree.js
Timo Tijhof 1f21d2998a Minor clean up of css/js
* Trim trailing whitespace on lines.
* Remove css that has been commented for 5 years (63e25672).
* Remove comment about $wgCategoryTreeVersion which was
  removed 2 years ago (e77ae54).
* Add missing spaces in CSS and JS.

Change-Id: Icb28293b445880246f2b4273daab2fb21c2638df
2013-10-10 00:52:39 +02:00

175 lines
4.2 KiB
JavaScript

/**
* JavaScript for the CategoryTree extension.
*
* @file
* @ingroup Extensions
* @author Daniel Kinzler, brightbyte.de
* @copyright © 2006 Daniel Kinzler
* @licence GNU General Public Licence 2.0 or later
*/
( function ( $, mw ) {
var categoryTree = {
/**
* Sets display inline to tree toggle
*/
showToggles: function () {
$( 'span.CategoryTreeToggle' ).css( 'display', 'inline' );
},
/**
* Handles clicks on the expand buttons, and calls the appropriate function
*
* @context {Element} CategoryTreeToggle
* @param e {jQuery.Event}
*/
handleNode: function ( e ) {
var $link = $( this );
if ( $link.data( 'ct-state' ) === 'collapsed' ) {
categoryTree.expandNode( $link );
} else {
categoryTree.collapseNode( $link );
}
},
/**
* Expands a given node (loading it's children if not loaded)
*
* @param {jQuery} $link
*/
expandNode: function ( $link ) {
// Show the children node
var $children = $link.parents( '.CategoryTreeItem' )
.siblings( '.CategoryTreeChildren' );
$children.show();
$link
.html( mw.msg( 'categorytree-collapse-bullet' ) )
.attr( 'title', mw.msg( 'categorytree-collapse' ) )
.data( 'ct-state', 'expanded' );
if ( !$link.data( 'ct-loaded' ) ) {
categoryTree.loadChildren( $link, $children );
}
},
/**
* Collapses a node
*
* @param {jQuery} $link
*/
collapseNode: function ( $link ) {
// Hide the children node
$link.parents( '.CategoryTreeItem' )
.siblings( '.CategoryTreeChildren' ).hide();
$link
.html( mw.msg( 'categorytree-expand-bullet' ) )
.attr( 'title', mw.msg( 'categorytree-expand' ) )
.data( 'ct-state', 'collapsed' );
},
/**
* Loads children for a node via an HTTP call
*
* @param {jQuery} $link
* @param {jQuery} $children
*/
loadChildren: function ( $link, $children ) {
var $linkParentCTTag, ctTitle, ctMode, ctOptions;
/**
* Error callback
*/
function error() {
var $retryLink;
$retryLink = $( '<a>' )
.text( mw.msg( 'categorytree-retry' ) )
.attr( 'href', '#' )
.click( function ( e ) {
e.preventDefault();
categoryTree.loadChildren( $link, $children );
} );
$children
.text( mw.msg( 'categorytree-error' ) + ' ' )
.append( $retryLink );
}
$link.data( 'ct-loaded', true );
$children.html(
$( '<i class="CategoryTreeNotice"></i>' )
.text( mw.msg( 'categorytree-loading' ) )
);
$linkParentCTTag = $link.parents( '.CategoryTreeTag' );
// Element may not have a .CategoryTreeTag parent, fallback to defauls
// Probably a CategoryPage (@todo: based on what?)
ctTitle = $link.data( 'ct-title' );
ctMode = $linkParentCTTag.data( 'ct-mode' );
ctMode = typeof ctMode === 'number' ? ctMode : undefined;
ctOptions = $linkParentCTTag.data( 'ct-options' ) || mw.config.get( 'wgCategoryTreePageCategoryOptions' );
// Mode and options have defaults or fallbacks, title does not.
// Don't make a request if there is no title.
if ( typeof ctTitle !== 'string' ) {
error();
return;
}
$.get(
mw.util.wikiScript(), {
action: 'ajax',
rs: 'efCategoryTreeAjaxWrapper',
rsargs: [ctTitle, ctOptions, 'json'] // becomes &rsargs[]=arg1&rsargs[]=arg2...
}
)
.success( function ( data ) {
data = data.replace(/^\s+|\s+$/, '');
data = data.replace(/##LOAD##/g, mw.msg( 'categorytree-expand' ) );
if ( data === '' ) {
switch ( ctMode ) {
// CT_MODE_CATEGORIES = 0
case 0:
data = mw.msg( 'categorytree-no-subcategories' );
break;
// CT_MODE_PAGES = 10
case 10:
data = mw.msg( 'categorytree-no-pages' );
break;
// CT_MODE_PARENTS = 100
case 100:
data = mw.msg( 'categorytree-no-parent-categories' );
break;
// CT_MODE_ALL = 20
default:
data = mw.msg( 'categorytree-nothing-found' );
}
data = $( '<i class="CategoryTreeNotice"></i>' ).text( data );
}
$children
.html( data )
.find( '.CategoryTreeToggle' )
.click( categoryTree.handleNode );
categoryTree.showToggles();
} )
.error( error );
}
};
// Register click events and show toggle buttons
$( function ( $ ) {
$( '.CategoryTreeToggle' ).click( categoryTree.handleNode );
categoryTree.showToggles();
} );
}( jQuery, mediaWiki ) );