Introduction

The Google Search Blogbar functionality can easily be added to a division. It displays a set of blog links based on provided search terms. The default search term is 'jquery'.

Google places some restrictions on your use of this service, including obtaining a key specific to a target URL providing the service, making the Web site freely accessible, and showing included Google branding. See the link above for more details.

You can also remove the GSBlogbar widget if it is no longer required.

Default blogbar:

  

$('#defaultBlogbar').gsblogbar();

$('#removeBlogbar').click(function() {
	var destroy = $(this).text() === 'Remove';
	$(this).text(destroy ? 'Re-attach' : 'Remove');
	$('#defaultBlogbar').gsblogbar(destroy ? 'destroy' : {});
});

You can override the defaults globally as shown below:

$.gsblogbar.setDefaults({horizontal: true});

Processed fields are marked with a class of is-gsblogbar and are not re-processed if targeted a second time.

Formatting Options

You have some control over the appearance of the blogbar. The settings marked with an asterisk (*) only apply to the vertical layout.

Formatting:

 

 

  

$('#formatBlogbar').gsblogbar();
		
var targets = [$.gsblogbar.targetSelf, $.gsblogbar.targetBlank,
	$.gsblogbar.targetTop, $.gsblogbar.targetParent];
var orders = [$.gsblogbar.orderRelevance, $.gsblogbar.orderDate];
		
$('#format input,#format select').change(function() {
	$('#formatBlogbar').gsblogbar('option',
		{title: $('#title').val(),
		horizontal: $('#orientation').val() === 'true',
		verticalCompressed: $('#compressed').val() === 'true',
		manyResults: $('#results').val() === 'true',
		linkTarget: targets[$('#target').val()],
		order: orders[$('#order').val()]});
});

Miscellaneous

You can restrict the search to a single blog Web site.

Restricted search: Web site  

  

$('#restrictBlogbar').gsblogbar(
	{siteRestriction: 'https://googleajaxsearchapi.blogspot.com/'});
		
$('#restrict').click(function() {
	$('#restrictBlogbar').gsblogbar('option',
		{siteRestriction: $('#site').val()});
});

You can show more detail about a blog entry when in horizontal mode by providing the jQuery selector for a container.

Extra info:

  

$('#extraBlogbar').gsblogbar({currentResult: '#extraInfo'});

Cycling Searches

You can set the blogbar up to cycle automatically through a set of search terms, with control over the interval between cycles and the order. Just pass an array of search terms when attaching the blogbar.

For horizontal blogbars, the cycle time is the interval between showing individual blog entries, whereas for vertical ones it is the interval between showing blog entries for one of the search terms.

For both orientations, the mode dictates the order of the search terms, not the individual blog entries.

Cycling:

 

  

$('#cycleBlogbar').gsblogbar(
	{search: ['jquery', 'australia', 'cats', 'dance']});
	
var times = [$.gsblogbar.cycleVShort,
	$.gsblogbar.cycleShort, $.gsblogbar.cycleMedium,
	$.gsblogbar.cycleLong, $.gsblogbar.cycleManual];
var modes = [$.gsblogbar.cycleRandom, $.gsblogbar.cycleLinear];
		
$('#cycle select').change(function() {
	$('#cycleBlogbar').gsblogbar('option',
		{cycleTime: times[$('#cycleTime').val()],
		cycleMode: modes[$('#cycleMode').val()],
		horizontal: $('#orientation2').val() === 'true'});
});

In the Wild

This tab highlights examples of this plugin in use "in the wild".

To add another example, please contact me (kbwood.au{at}gmail.com) and provide the plugin name, the URL of your site, its title, and a short description of its purpose and where/how the plugin is used.

Quick Reference

A full list of all possible settings is shown below. Note that not all would apply in all cases. For more detail see the documentation reference page.

$(selector).gsblogbar({
	horizontal: true, // True for horizontal display, false for vertical
	verticalCompressed: false, // True for compressed layout when vertical,
		// false for expanded
	title: '', // Title for the bar
	search: 'jquery', // Single or list of search terms
	siteRestriction: '', // Specify a site to restrict searches to
	order: this.orderRelevance, // Control the order of the results
	manyResults: false, // True for many results, false for only a few
	cycleTime: this.cycleManual, // Time between cycles of the search terms
	cycleMode: this.cycleLinear, // Mode of cycling through the search terms
	linkTarget: this.targetSelf, // Control where the blog links open
	currentResult: '' // jQuery selector, jQuery object, or element for 
		// additional info for current entry when horizontal
});

$.gsblogbar.setDefaults(settings) // Change settings for all instances

$(selector).gsblogbar('option', settings) // Change the instance settings
$(selector).gsblogbar('option', name, value) // Change an instance setting
$(selector).gsblogbar('option', name) // Retrieve an instance setting

$(selector).gsblogbar('search', terms) // Perform a search

$(selector).gsblogbar('destroy') // Remove the GSBlogbar functionality