Plugins/features/alphabetSearch/dataTables.alphabetSearch.js

/*! © SpryMedia Ltd - datatables.net/license */

(function( factory ){
	if ( typeof define === 'function' && define.amd ) {
		// AMD
		define( ['jquery', 'datatables.net'], function ( $ ) {
			return factory( $, window, document );
		} );
	}
	else if ( typeof exports === 'object' ) {
		// CommonJS
		module.exports = function (root, $) {
			if ( ! root ) {
				// CommonJS environments without a window global must pass a
				// root. This will give an error otherwise
				root = window;
			}

			if ( ! $ ) {
				$ = typeof window !== 'undefined' ? // jQuery's factory checks for a global window
					require('jquery') :
					require('jquery')( root );
			}

			if ( ! $.fn.dataTable ) {
				require('datatables.net')(root, $);
			}

			return factory( $, root, root.document );
		};
	}
	else {
		// Browser
		factory( jQuery, window, document );
	}
}(function( $, window, document, undefined ) {
'use strict';
var DataTable = $.fn.dataTable;


/**
 * @summary     AlphabetSearch
 * @description Show an set of alphabet buttons alongside a table providing
 *     search input options
 * @version     1.1.0
 * @file        dataTables.alphabetSearch.js
 * @author      SpryMedia Ltd (www.sprymedia.co.uk)
 * @contact     www.sprymedia.co.uk/contact
 * @copyright   Copyright SpryMedia Ltd.
 *
 * License      MIT - http://datatables.net/license/mit
 *
 * For more detailed information please see:
 *     http://datatables.net/blog/2014-09-22
 */
// Search function
DataTable.Api.register('alphabetSearch()', function (searchTerm) {
    this.iterator('table', function (context) {
        context.alphabetSearch = searchTerm;
    });
    return this;
});
// Recalculate the alphabet display for updated data
DataTable.Api.register('alphabetSearch.recalc()', function () {
    this.iterator('table', function (context) {
        draw(new DataTable.Api(context), context._alphabet, context._alphabetOptions);
    });
    return this;
});
DataTable.Api.register('alphabetSearch.node()', function () {
    return this._context.length
        ? this._context._alphabet
        : null;
    ;
});
// Search plug-in
DataTable.ext.search.push(function (context, searchData) {
    // Ensure that there is a search applied to this table before running it
    if (!context.alphabetSearch) {
        return true;
    }
    var columnId = 0;
    var caseSensitive = false;
    if (context.oInit.alphabet !== undefined) {
        columnId =
            context.oInit.alphabet.column !== undefined
                ? context.oInit.alphabet.column
                : 0;
        caseSensitive =
            context.oInit.alphabet.caseSensitive !== undefined
                ? context.oInit.alphabet.caseSensitive
                : false;
    }
    if (caseSensitive) {
        if (searchData[columnId].charAt(0) === context.alphabetSearch) {
            return true;
        }
    }
    else {
        if (searchData[columnId].charAt(0).toUpperCase() === context.alphabetSearch) {
            return true;
        }
    }
    return false;
});
// Private support methods
function bin(data, options) {
    var letter, bins = {};
    for (var i = 0, ien = data.length; i < ien; i++) {
        if (options.caseSensitive) {
            letter = data[i].toString().replace(/<.*?>/g, '').charAt(0);
        }
        else {
            letter = data[i].toString().replace(/<.*?>/g, '').charAt(0).toUpperCase();
        }
        if (bins[letter]) {
            bins[letter]++;
        }
        else {
            bins[letter] = 1;
        }
    }
    return bins;
}
function draw(table, alphabet, options) {
    alphabet.empty();
    alphabet.append('Search: ');
    var columnData = table.column(options.column).data();
    var bins = bin(columnData, options);
    $('<span class="clear active"/>')
        .data('letter', '')
        .data('match-count', columnData.length)
        .html('None')
        .appendTo(alphabet);
    if (options.numbers) {
        for (var i = 0; i < 10; i++) {
            var letter = String.fromCharCode(48 + i);
            $('<span/>')
                .data('letter', letter)
                .data('match-count', bins[letter] || 0)
                .addClass(!bins[letter] ? 'empty' : '')
                .html(letter)
                .appendTo(alphabet);
        }
    }
    for (var i = 0; i < 26; i++) {
        var letter = String.fromCharCode(65 + i);
        $('<span/>')
            .data('letter', letter)
            .data('match-count', bins[letter] || 0)
            .addClass(!bins[letter] ? 'empty' : '')
            .html(letter)
            .appendTo(alphabet);
    }
    if (options.caseSensitive) {
        for (var i = 0; i < 26; i++) {
            var letter = String.fromCharCode(97 + i);
            $('<span/>')
                .data('letter', letter)
                .data('match-count', bins[letter] || 0)
                .addClass(!bins[letter] ? 'empty' : '')
                .html(letter)
                .appendTo(alphabet);
        }
    }
    $('<div class="alphabetInfo"></div>').appendTo(alphabet);
}
DataTable.AlphabetSearch = function (context) {
    var table = new DataTable.Api(context);
    var alphabet = $('<div class="alphabet"/>');
    var options = $.extend({
        column: 0,
        caseSensitive: false,
        numbers: false,
    }, table.init().alphabet);
    draw(table, alphabet, options);
    context._alphabet = alphabet;
    context._alphabetOptions = options;
    // Trigger a search
    alphabet.on('click', 'span', function () {
        alphabet.find('.active').removeClass('active');
        $(this).addClass('active');
        table.alphabetSearch($(this).data('letter')).draw();
    });
    // Mouse events to show helper information
    alphabet
        .on('mouseenter', 'span', function () {
        alphabet
            .find('div.alphabetInfo')
            .css({
            opacity: 1,
            left: $(this).position().left,
            width: $(this).width(),
        }) // unsure why it needs any
            .html($(this).data('match-count'));
    })
        .on('mouseleave', 'span', function () {
        alphabet.find('div.alphabetInfo').css('opacity', 0);
    });
};
// Register a search plug-in
DataTable.ext.feature.push({
    fnInit: function (settings) {
        var search = new DataTable.AlphabetSearch(settings);
        return search.node();
    },
    cFeature: 'A',
});


return DataTable;
}));