jWave | Easily embed Google Wave with jQuery

jWave is a small jQuery plug-in that facilitates the embedding of Google Wave into a blog or website. jWave only depends on jQuery, and loads the rest of its requirements dynamically, checking first to see if they exist. To use jWave, simply follow the instructions on this page. For power users, the API documentation below will allow full control over the appearence and behavior of the embedded wave.

Using jWave is Easy!

  1. Download either the development or production version of jWave.
  2. Include the script into your page or project (don't forget jQuery!):
  3. Pick a wave you wish to embed, isolate the wave’s id, and load it into a jQuery selection:
  4. For more options, including the ability to style the embedded wave and define an onload callback, refer to the API documentation below.

API documentation

Both jWave method variants are publicly accessible via the selector prototype (jQuery.fn), and can be accessed by calling jwave() on any jQuery selection.

jQuery.fn.jwave(waveId [, callback])

waveId String Required
The Google Wave ID corresponding to the wave to be embedded. For details on how to get a Wave ID, see The Official Reference.
callback Function(WavePanel) Optional
An optional function that will be called after the wave is loaded. The function is passed one argument, the corresponding WavePanel instance generated in the call to jWave.

jQuery.fn.jwave(waveId [, options [, callback]])

waveId String Required
The Google Wave ID corresponding to the wave to be embedded. For details on how to get a Wave ID, see The Official Reference.
options Object Optional
A dictionary of options that modify the appearance, behavior, and/or the endpoint of the loaded wave. Possible property/value definitions can be found below, and directly correspond with the EmbedOptions used in the WavePanel constructor.
bgcolor String Optional
The background color CSS property to be set on the embedded wave panel. Note: This property does not currently work as expected, and will be fixed in a future release.
footer Boolean Optional
A flag indicating whether or not the embed wave panel footer should be displayed.
header Boolean Optional
A flag indicating whether or not the embed wave panel header should be displayed.
height Number Optional
The display height of the embedded wave panel in pixels. Prefer specifying the width/height of the containing div in your html if possible.
rootUrl String Optional
The Google Wave server URL that will serve the embedded wave. Note that the URL must have a trailing '/' By default this value is presumed to be google wave preview: https://wave.google.com/wave/
target Element Optional
The div element inside which to insert the embedded wave panel. Note** Setting this value will override whatever element was selected in the jQuery selector.
toolbar Boolean Optional
A flag indicating whether or not the embed wave panel toolbar should be displayed. Note that this flag is only valid if the header is enabled.
width Number Optional
The display width of the embedded wave panel in pixels. Prefer specifying the width/height of the containing div in your html if possible.
callback Function(WavePanel) Optional
An optional function that will be called after the wave is loaded. The function is passed one argument, the corresponding WavePanel instance generated in the call to jWave.
comments