Please consider donating: a local project in memory of my daughter
12 Feb

jQuery API Browser

Ever since jQuery 1.1.3 the old API browser hasn't been updated due to incompatibilities in the documentation (though that's mostly assumptions). Although the new docs is comprehensive, I've always liked the quick access the old API browser gave.

As such, I've got about my own way re-building an API browser based on the new documentation.

Check out the new jQuery API browser

It's entirely driven by JavaScript (with a tiny smidge of .htaccess). The most important two features for me were to be able to quickly jump to any method either by searching or just to check the params.

This can either be done by the live search or via the URL, e.g: http://remysharp.com/jquery-api/bind

If John, or anyone else on the jQuery team are interested, I'd much rather see this sitting on the http://jquery.com/api URL, just get in touch - it's just easier to type :-)

18 Responses to “jQuery API Browser”

  1. Kyle Kinnaman February 12th, 2008 at 7:43 pm

    Perfectly awesome... but...

    It doesn't like capital letters. Try slideToggle - it breaks after the capital T. A lower case t works fine.

    This is definitely getting bookmarked.

  2. Blog Author Remy Sharp February 12th, 2008 at 7:56 pm

    @Kyle - cheers for that, it's fixed now.

  3. Rey Bango February 13th, 2008 at 4:06 am

    Remy, can you make this downloadable so it can be run locally?

  4. dc crowley February 13th, 2008 at 9:51 pm

    wow! thanks! excellent stuff

  5. Maxwell Terry February 14th, 2008 at 6:01 am

    Nice, this is really helpful. You should add autocomplete="off" to the input tag though, it's really annoying getting browser suggestions as I type.

  6. Jens Grochtdreis February 18th, 2008 at 10:23 am

    Nice work. Thx. But it seems to be not completed, though. You won't find the $() function, so there might be other functions which arent't there at all. Will the API browser be completed in the next future?

  7. Blog Author Remy Sharp February 18th, 2008 at 11:21 am

    @Jens - actually the API documentation doesn't mention the $() function anymore. It's found under jQuery().

    I have done some conversion to make it easier to find functions like jQuery.ajax() and made them searchable under 'ajax'.

    However, I think there is some argument for aliasing the '$' search term against the jQuery() functions.

    Just so that you're reassured - there's no missing functions in the API as it derives directly from the wiki API docs.

  8. Jens Grochtdreis February 19th, 2008 at 3:37 pm

    Thanks for making this clear. So it will be safe and a fun to use your new API.

  9. Yansky March 6th, 2008 at 9:38 pm

    Remy, I got confused with the length details the because it has () after the length title.

    http://remysharp.com/jquery-api/length

    http://groups.google.com.au/group/jquery-en/browse_frm/thread/31f2029bacf6272a?hl=en

  10. Blog Author Remy Sharp March 6th, 2008 at 11:12 pm

    @Yansky - thanks for pointing that out. I post this on the groups thread, but I'll add it here too:

    I've got a small update to go for the API browser that will include selectors as well as properties and functions, and I'll make sure that only functions include the parentheses.

  11. Mark March 7th, 2008 at 7:15 am

    Hi. This is an excellent work. Anyone planning to make a (firefox/seamonkey) sidebar-friendly version?. That would be the icing on the cake. :)

  12. Blog Author Remy Sharp March 8th, 2008 at 9:46 pm

    I've updated the API browser to include the following:

    * Indicator to show function, selector or property
    * Only show parenthesis if it's a function
    * Included the 'options' tab for more detail about the function

    @Mark - there's changes coming to the API browser which, in particular, splits the view from the backend - i.e. making it easy for someone to reuse the functionality for a sidebar plugin if they want.

  13. Pedro Melo June 3rd, 2008 at 5:18 pm

    Hi,

    any chance of a version for local usage?

    Thanks,

  14. Blog Author Remy Sharp June 3rd, 2008 at 5:33 pm

    @Pedro - it's in progress, just really, really behind! I'll post it up here, so keep an eye on the RSS feed.

  15. Pedro Melo June 3rd, 2008 at 5:45 pm

    Ok, if you need any help with that, feel free.

    Best regards,

  16. Muhammad Hussein Fattahizadeh September 15th, 2008 at 11:05 pm

    great work. is it any packages of this for download, i want that run on localhost. :D

  17. David Esperalta October 20th, 2008 at 1:20 pm

    Actualizada la web Visual jQuery...

    Que el sitio web Visual jQuery resulta curioso y útil está por demás decirlo, y, ahora lo es todavía un poco más, puesto que se ha actualizado para soportar las últimas características de...

  18. MiD-AwE November 10th, 2010 at 3:37 pm

    I see that you've not received any recent comments here, but I wanted to mention that your jQuery API Browser v1.3 (air) is a permanent addition to my work flow. I've seen and tried your updated version and do not prefer it over the older.

    The inclusion of jQuery UI is valuable to me. I often type into the filter field but some times I just probe around, although much of the time I'm simply looking for a quick reference and I use http://docs.jquery.com for deeper explanations.

    Your jQuery API Browser v1.3 (air) is the fastest & simplest tool for doing what it does. My only wish is that it was up to date since so much has been added to the jQuery & UI APIs in the past few versions, yet it remains an awesome tool.

    Is there any potential of an updated version or even can I help?

    Thank you

Leave a Reply
Not required

CODE: Please escape code and wrap in <pre><code>, doing so will automatically syntax highlight