jQuery Google Search Bookbar Reference

A jQuery plugin that sets a division to show a Google Search Bookbar. 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 Bookbar plugin and download the code from there.

For more detail on the Google Search Bookbar functionality, see the Google API documentation.

Instance Settings

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

cycleMode | cycleTime | horizontal | manyResults | search | thumbnailSize

NameTypeDefaultComments
horizontalbooleantrue Controls the orientation of the bookbar, being horizontal (true) or vertical (false).
thumbnailSizeenumeratedthis.thumbnailsMedium Control the sizing of the book thumbnails. Use either $.gsbookbar.thumbnailsSmall or $.gsbookbar.thumbnailsMedium.
searchstring or string[]'jquery' The single term to search for, or a list of terms to cycle through.
manyResultsbooleanfalse Control how many results are returned, being few (false) or many (true).
cycleTimeenumeratedthis.cycleMedium Specify the interval between cycles when multiple search terms are provided. Use one of $.gsbookbar.cycleVShort (3 seconds), $.gsbookbar.cycleShort (10 seconds), $.gsbookbar.cycleMedium (15 seconds), or $.gsbookbar.cycleLong (30 seconds).
cycleModeenumeratedthis.cycleRandom Specify the order in which search terms are used when multiple are provided. Use either $.gsbookbar.cycleRandom or $.gsbookbar.cycleLinear.

Functions

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

Contact Keith Wood at kbwood{at}iinet.com.au with comments or suggestions.