jQuery Documentation

Update 24 Feb 2007: Link to Sean O's jQueryHelp

Update 23 Feb 2007: Added links for PDF's of API

Update 29 Jan 2007: Jörn Zaefferer's API browser is no longer a draft. Link below. 22:10 it also is printer friendly and can be downloaded for offline viewing. Visual jQuery 1.1.1 is also now available (and can also be downloaded).

Update 18 Jan 2007: A PDF Version of the documentation is available. To download, go to JQuery documentation in PDF. Only for the latest version of jQuery (1.1), although those with experience with Java will probably be able to check out an older version to generate the documentation.

If you are a user of jQuery, it is likely that you are aware of Visual jQuery, which is an alternative reference for the jQuery API. What you may not know, is that on the site is documentation for other versions as well (so if you still use an older 1.0.x version, you can still see it on the site). Here are the links (that I know of) to the documentation of the various versions. Also included is the blog post announcing the release of each version, with details of bugs fixed, feature changes etc.

There are also several other places that have their own version of the API documentation:

  • jQuery API (the original API page, hopefully it will still be kept up to date when new versions come out)
  • jQuery Documentation Wiki
  • Draft API jQuery API Browser by Jörn Zaefferer (one of the key developers of jQuery) There is also an application you can download (no install required) that allows you to look up a function in this API browser by simply highlighting it and pressing Ctrl-Shift-J - Sean O's jQueryHelp
  • gotapi.com also has it (version 1.0.3), but unfortunately the jQuery API page on the site can't be bookmarked, so it has to be clicked on in the centre frame

It also available in PDF format:

There are probably more that I have missed which I will hopefully be able to add to this post.

What I have not seen yet, is a PDF or a CHM (HTML Help) version of the documentation. Both It would be valuable for browsing offline (although I doubt many web developers now are offline very often) and searching can be easier and faster. Thankfully there is an XML version of the documentation (available on the jQuery API page and in the post announcing 1.1) that could be used to generate a PDF or CHM file. I am not sure if the XML files for the older versions (i.e. 1.0.x) are still available though.

Comments

Anonymous said…
Nice post, Sam. That's a good set of reference links.
2:46 pm, January 16, 2007
Anonymous said…
It may be worth noting that the API Browser is both printable and downloadable (for offline use).
12:48 pm, January 29, 2007
Define-Web.com said…
more cheat sheets, for current version of jquery v1.1x

http://www.n-bp.com/jquery_cheat_sheet/v11_catalog/

http://www.n-bp.com/jquery_cheat_sheet/v11_catalog_extra/

http://www.n-bp.com/jquery_cheat_sheet/v11_atoz/
6:48 am, February 25, 2007
Anonymous said…
Any CHM yet?
7:40 am, May 09, 2007
Sam said…
No, not seen any yet. Perhaps it could be a build option for those who build jQuery and its documentation directly from SVN.
5:43 pm, May 11, 2007
Post a Comment

Popular posts from this blog

Select box manipulation with jQuery

If you read the jQuery mailing list , you may be aware that I have updated my plugins for working with select boxes . Summary of changes: addOption replaces any options with the same value (so think of it as an add/replace options plugin selectOptions selected options in addition to what was already selected, but there is now an option for it not to do this There are two new methods: copyOptions which is for copying options between select boxes ajaxAddOption allows you to add options via AJAX (i.e. could be used for create options dynamically from a server script)
Read more

iTextSharp: Generating a Basic PDF file (ASP.NET/C#)

iTextSharp is free library for .NET that allows you to create PDF documents. It can be used to dynamically create PDF's which can be streamed to the user. As there is no HTML being sent to the user, a WebHandler (ashx file) is a more appropriate way to generate your PDF than an aspx page. Download itextsharp-3.0.10-dll.zip (latest version as of 08 Feb 2006) and save the dll in the archive to your websites bin directory. Here is a basic sample of creating a PDF (more complex samples may follow in future posts). BasicPDF.ashx <%@ WebHandler Language="C#" Class="MyNamespace.BasicPDF" %> using System; using System.IO; using System.Web; using iTextSharp.text; using iTextSharp.text.pdf; namespace MyNamespace { public class BasicPDF: IHttpHandler { public bool IsReusable { get { return true; } } /// <summary> /// Font used for any hyperlinks added to the PDF /// </summary> private Font LinkFont { get ...
Read more

Popup Window Countdown (JavaScript)

This code opens a new popup window that contains a timer that counts down, then closes the window when it reaches 0. Will not work if user has a popup blocker blocking the page. <html> <head> <title>Popup Timer</title> <script language="JavaScript" type="text/JavaScript"> // popup window var var popup; // At what number shall the countdown counter start? CounterStart = 10; // This function CustomAction() can be modified to do // whatever you want done every second. function CustomAction() { popup.document.timer.timeleft.value = CounterStart; } // end of function CustomAction() // end of JavaScript customization function Decrement() { CounterStart--; CustomAction(); if(CounterStart <= 0) { popup.close(); alert('Timer reached 0'); } else { setTimeout('Decrement()',1000); } } function StartTheCounter() { openPopup(120,100); setTimeout('Decrement()',1000); } f...
Read more