jQuery Google Search Blogbar Reference

A jQuery plugin that sets a division to show a Google Search Blogbar. If you find this plugin useful please vote for it on the jQuery site.

This page provides a documentation reference for working with the plugin v1.0.1. See a demonstration of the Google Search Blogbar plugin and download the code from there.

Settings
Global

Instance Settings

A separate GSBlogbar instance is created for each targetted division and has its own settings: $('divs').gsblogbar({...});.

Name	Type	Default	Comments
horizontal	boolean	true	Controls the orientation of the blogbar, being horizontal (true) or vertical (false).
verticalCompressed	boolean	false	Controls the how much detail is shown for a vertical blogbar, being titles only (true) or all details (false). Note that this setting has no effect on horizontal blogbars.
title	string	''	The title of the blogbar. It only appears at the top of a vertical blogbar.
search	string or string[]	'jquery'	The single term to search for, or a list of terms to cycle through.
siteRestriction	string	''	The URL of a Web site to restrict the search to. If blank there is no restriction.
order	enumerated	this.orderDate	Control the order of the results within the list. Use either `$.gsblogbar.orderRelevance` or `$.gsblogbar.orderDate`.
manyResults	boolean	false	Control how many results are returned, being few (false) or many (true).
cycleTime	enumerated	this.cycleManual	Specify the interval between cycles when multiple search terms are provided. For horizontal blogbars this is the time between individual entries, whereas for vertical blogbars it is the time between results for multiple search terms. Use one of `$.gsblogbar.cycleVShort` (3 seconds), `$.gsblogbar.cycleShort` (3 seconds horizontal, 10 seconds vertical), `$.gsblogbar.cycleMedium` (5 seconds horizontal, 15 seconds vertical), `$.gsblogbar.cycleLong` (10 seconds horizontal, 30 seconds vertical), `$.gsblogbar.cycleManual` (5 seconds horizontal, indefinite vertical).
cycleMode	enumerated	this.cycleLinear	Specify the order in which search terms are used when multiple are provided. Use either `$.gsblogbar.cycleRandom` or `$.gsblogbar.cycleLinear`.
linkTarget	enumerated	this.targetSelf	Indicate in which window a blog entry should open. Use one of `$.gsblogbar.targetSelf` (the current window), `$.gsblogbar.targetBlank` (a new window), `$.gsblogbar.targetTop` (replacing all frames), or `$.gsblogbar.targetParent` (the frameset parent window).
currentResult	string, object, element	''	The jQuery selector, jQuery object, or individual element for the a container to show details about the current blogbar entry. If more than one element is selected, only the first is used. Note that this setting only applies to horizontal blogbars.

Functions

Signature	Returns	Comments
$.gsblogbar.setDefaults(settings)	GSBlogbar object	Update the default instance settings to use with all GSBlogbar instances.
$(div).gsblogbar('change', settings)	jQuery object	Update the settings for the GSBlogbar instance(s) attached to the given div(s).
$(div).gsblogbar('destroy')	jQuery object	Remove the GSBlogbar functionality from the given div(s).
$(div).gsblogbar('search', terms)	jQuery object	Execute a new search for the GSBlogbar. `terms` (string) the keywords to search for.